zippendo 1.2.3 → 1.2.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/docs/CreateOrderChannelRequest.md +26 -0
- data/docs/CreateOrderChannelRequestSettings.md +42 -0
- data/docs/CreateOrderChannelRequestSettingsShippingMethodMappingsInner.md +22 -0
- data/docs/CreateOrderChannelWebhookSecret201Response.md +22 -0
- data/docs/CreateOrderRequest.md +4 -0
- data/docs/GetOrderChannelWebhookStatus200Response.md +22 -0
- data/docs/GetOrderChannelWebhookStatus200ResponseWebhooksInner.md +28 -0
- data/docs/ListAvailableCarriers200ResponseInner.md +5 -1
- data/docs/ListCarriers200ResponseDataInner.md +5 -1
- data/docs/ListOrderChannels200Response.md +26 -0
- data/docs/ListOrderChannels200ResponseDataInner.md +44 -0
- data/docs/ListOrderChannels200ResponseDataInnerSettings.md +50 -0
- data/docs/ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner.md +22 -0
- data/docs/OrderChannelsApi.md +599 -0
- data/docs/RevokeOrderChannelWebhookSecret200Response.md +18 -0
- data/docs/UpdateOrderChannelRequest.md +28 -0
- data/docs/UpdateOrderChannelRequestSettings.md +42 -0
- data/lib/zippendo/api/order_channels_api.rb +629 -0
- data/lib/zippendo/models/batch_send_shipments200_response_results_inner.rb +2 -2
- data/lib/zippendo/models/create_order_channel_request.rb +266 -0
- data/lib/zippendo/models/create_order_channel_request_settings.rb +359 -0
- data/lib/zippendo/models/create_order_channel_request_settings_shipping_method_mappings_inner.rb +254 -0
- data/lib/zippendo/models/create_order_channel_webhook_secret201_response.rb +230 -0
- data/lib/zippendo/models/create_order_request.rb +23 -1
- data/lib/zippendo/models/get_order_channel_webhook_status200_response.rb +221 -0
- data/lib/zippendo/models/get_order_channel_webhook_status200_response_webhooks_inner.rb +266 -0
- data/lib/zippendo/models/list_api_tokens401_response.rb +2 -2
- data/lib/zippendo/models/list_available_carriers200_response_inner.rb +24 -4
- data/lib/zippendo/models/list_carriers200_response_data_inner.rb +24 -4
- data/lib/zippendo/models/list_order_channels200_response.rb +275 -0
- data/lib/zippendo/models/list_order_channels200_response_data_inner.rb +478 -0
- data/lib/zippendo/models/list_order_channels200_response_data_inner_settings.rb +509 -0
- data/lib/zippendo/models/list_order_channels200_response_data_inner_settings_shipping_method_mappings_inner.rb +254 -0
- data/lib/zippendo/models/list_orders200_response_data_inner_order_channel.rb +2 -2
- data/lib/zippendo/models/revoke_order_channel_webhook_secret200_response.rb +165 -0
- data/lib/zippendo/models/send_shipment422_response.rb +2 -2
- data/lib/zippendo/models/update_order_channel_request.rb +231 -0
- data/lib/zippendo/models/update_order_channel_request_settings.rb +360 -0
- data/lib/zippendo/version.rb +1 -1
- data/lib/zippendo.rb +14 -0
- metadata +29 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: '086cfaec84034180809f14ba90d5611b3f9cd1aca1340de07d60ee542811a92e'
|
|
4
|
+
data.tar.gz: 501ed6f7d9e42ce82fd6f64986f26621eb39c11edfdc49e2b4247733f690668b
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: e2eb72d58a9095eccaca1d87b6e21582c712895b31887f26b74d8fc3a997549401f5832d70e963800a3a9fecc557c961cef3424bbe1af03fad482c120c3b5f43
|
|
7
|
+
data.tar.gz: 4e688a4f93db0cd34acea5a01c95479a295a044f821de9a45bf88f4d0fc71b122b3dc6d506b20f9bbd312c7b551e92cb1229f8d53224e206a59774479c290c45
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Zippendo::CreateOrderChannelRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | Display name for the channel. | |
|
|
8
|
+
| **type** | **String** | Type of the order channel. Platform channels (Shopify, WooCommerce) are created via their connect flows. | |
|
|
9
|
+
| **brand_id** | **String** | Brand this channel belongs to; null for organization-wide | [optional] |
|
|
10
|
+
| **enabled** | **Boolean** | Whether the channel is active. | [optional][default to true] |
|
|
11
|
+
| **settings** | [**CreateOrderChannelRequestSettings**](CreateOrderChannelRequestSettings.md) | | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'zippendo'
|
|
17
|
+
|
|
18
|
+
instance = Zippendo::CreateOrderChannelRequest.new(
|
|
19
|
+
name: Anna's webshop,
|
|
20
|
+
type: custom,
|
|
21
|
+
brand_id: brnd_8f3kd92ld0,
|
|
22
|
+
enabled: true,
|
|
23
|
+
settings: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# Zippendo::CreateOrderChannelRequestSettings
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **use_webhooks** | **Boolean** | Use webhooks for real-time order sync. | [optional][default to true] |
|
|
8
|
+
| **site_url** | **String** | WooCommerce store URL. | [optional] |
|
|
9
|
+
| **auto_fulfill** | **Boolean** | Push tracking back to the platform when a shipment is dispatched. Enabled by default (opt-out) — set to false to disable write-back; an unset value still syncs. | [optional] |
|
|
10
|
+
| **auto_sync** | **Boolean** | Periodically poll the channel for new orders. | [optional][default to false] |
|
|
11
|
+
| **sync_interval_minutes** | **Integer** | Polling interval in minutes (5-1440). | [optional][default to 15] |
|
|
12
|
+
| **auto_ship_on_create** | **Boolean** | Create a shipment automatically when an order arrives. | [optional][default to false] |
|
|
13
|
+
| **default_carrier_id** | **String** | Default carrier ID for auto-shipping. | [optional] |
|
|
14
|
+
| **default_product_id** | **String** | Default carrier product ID for auto-shipping. | [optional] |
|
|
15
|
+
| **default_address_id** | **String** | Default sender address ID for auto-shipping. | [optional] |
|
|
16
|
+
| **shipping_method_mappings** | [**Array<CreateOrderChannelRequestSettingsShippingMethodMappingsInner>**](CreateOrderChannelRequestSettingsShippingMethodMappingsInner.md) | Map imported shipping-method titles to shipping rules, for channels without checkout rate integration. | [optional] |
|
|
17
|
+
| **sync_only_unfulfilled** | **Boolean** | Only import orders that are not yet fulfilled. | [optional][default to true] |
|
|
18
|
+
| **sync_orders_since** | **Time** | Only sync orders placed at or after this timestamp. | [optional] |
|
|
19
|
+
| **service_point_count** | **Integer** | Number of service points to show at checkout (1-20). | [optional][default to 6] |
|
|
20
|
+
|
|
21
|
+
## Example
|
|
22
|
+
|
|
23
|
+
```ruby
|
|
24
|
+
require 'zippendo'
|
|
25
|
+
|
|
26
|
+
instance = Zippendo::CreateOrderChannelRequestSettings.new(
|
|
27
|
+
use_webhooks: true,
|
|
28
|
+
site_url: https://butik.dk,
|
|
29
|
+
auto_fulfill: true,
|
|
30
|
+
auto_sync: false,
|
|
31
|
+
sync_interval_minutes: 15,
|
|
32
|
+
auto_ship_on_create: false,
|
|
33
|
+
default_carrier_id: clz9k2f0a0006abcd1357yzab,
|
|
34
|
+
default_product_id: postnord-home-delivery,
|
|
35
|
+
default_address_id: clz9k2f0a0005abcd7890uvwx,
|
|
36
|
+
shipping_method_mappings: [{"match":"GLS Hjemmelevering","shippingRuleId":"clz9k2f0a0007abcd2468qrst"}],
|
|
37
|
+
sync_only_unfulfilled: true,
|
|
38
|
+
sync_orders_since: 2026-05-22T00:00Z,
|
|
39
|
+
service_point_count: 6
|
|
40
|
+
)
|
|
41
|
+
```
|
|
42
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Zippendo::CreateOrderChannelRequestSettingsShippingMethodMappingsInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **match** | **String** | Shipping-method title to match against imported orders (trimmed, case-insensitive, exact). | |
|
|
8
|
+
| **shipping_rule_id** | **String** | Shipping rule applied to orders whose shipping-method title matches. | |
|
|
9
|
+
| **service_point_selection** | **String** | For rules whose product delivers to a service point: 'nearest' auto-selects the closest point to the recipient address; 'manual' keeps the shipment in draft for manual selection. | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'zippendo'
|
|
15
|
+
|
|
16
|
+
instance = Zippendo::CreateOrderChannelRequestSettingsShippingMethodMappingsInner.new(
|
|
17
|
+
match: GLS Hjemmelevering,
|
|
18
|
+
shipping_rule_id: clz9k2f0a0007abcd2468qrst,
|
|
19
|
+
service_point_selection: nearest
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Zippendo::CreateOrderChannelWebhookSecret201Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **secret** | **String** | The webhook signing secret. Returned only once — store it in your system; every push to the ingest URL must carry an HMAC-SHA256 hex signature of the raw body computed with it. | |
|
|
8
|
+
| **webhook_url** | **String** | The ingest URL your system pushes signed order events to. | |
|
|
9
|
+
| **created_at** | **Time** | When this secret was issued (ISO 8601). | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'zippendo'
|
|
15
|
+
|
|
16
|
+
instance = Zippendo::CreateOrderChannelWebhookSecret201Response.new(
|
|
17
|
+
secret: zwhs_XeVJ1n8vJZbJ0N3mYQ2fV0dK9cA5tR7uW4pL6sH8gB0,
|
|
18
|
+
webhook_url: https://api.zippendo.com/webhooks/order-channels/clz9k2f0a0001abcd1234efgh,
|
|
19
|
+
created_at: 2026-09-02T14:30Z
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
data/docs/CreateOrderRequest.md
CHANGED
|
@@ -15,6 +15,8 @@
|
|
|
15
15
|
| **total_amount** | **Float** | Order grand total. | [optional] |
|
|
16
16
|
| **currency** | **String** | ISO 4217 currency code. | [optional] |
|
|
17
17
|
| **notes** | **String** | Free-form internal notes. | [optional] |
|
|
18
|
+
| **shipping_rule_id** | **String** | Shipping rule to ship this order with. When set, a shipment is created immediately (and dispatched if the channel has autoShipOnCreate enabled). | [optional] |
|
|
19
|
+
| **shipping_method_title** | **String** | Shipping-method title from the source checkout; matched against the order channel's shipping-method mappings to pick a shipping rule. | [optional] |
|
|
18
20
|
| **external_data** | **Hash<String, Object>** | Raw platform-specific payload for reference. | [optional] |
|
|
19
21
|
|
|
20
22
|
## Example
|
|
@@ -34,6 +36,8 @@ instance = Zippendo::CreateOrderRequest.new(
|
|
|
34
36
|
total_amount: 1047,
|
|
35
37
|
currency: DKK,
|
|
36
38
|
notes: Leave at front desk,
|
|
39
|
+
shipping_rule_id: clz9k2f0a0007abcd2468qrst,
|
|
40
|
+
shipping_method_title: GLS Hjemmelevering,
|
|
37
41
|
external_data: null
|
|
38
42
|
)
|
|
39
43
|
```
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Zippendo::GetOrderChannelWebhookStatus200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **enabled** | **Boolean** | Whether webhooks are enabled for the channel. | |
|
|
8
|
+
| **webhook_url** | **String** | Expected callback URL for this channel. | |
|
|
9
|
+
| **webhooks** | [**Array<GetOrderChannelWebhookStatus200ResponseWebhooksInner>**](GetOrderChannelWebhookStatus200ResponseWebhooksInner.md) | Webhooks registered for this channel's callback URL. | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'zippendo'
|
|
15
|
+
|
|
16
|
+
instance = Zippendo::GetOrderChannelWebhookStatus200Response.new(
|
|
17
|
+
enabled: true,
|
|
18
|
+
webhook_url: https://api.zippendo.dk/webhooks/order-channels/clz9k2f0a0001abcd1234efgh,
|
|
19
|
+
webhooks: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# Zippendo::GetOrderChannelWebhookStatus200ResponseWebhooksInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **Float** | Platform webhook ID. | |
|
|
8
|
+
| **topic** | **String** | Webhook event topic. | |
|
|
9
|
+
| **address** | **String** | Registered callback address. | |
|
|
10
|
+
| **created_at** | **String** | Webhook creation timestamp. | |
|
|
11
|
+
| **delivery_url** | **String** | WooCommerce delivery URL (same as `address`; present for WooCommerce channels). | [optional] |
|
|
12
|
+
| **status** | **String** | WooCommerce webhook status. A value other than `active` means WooCommerce disabled the webhook (e.g. after repeated delivery failures). | [optional] |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'zippendo'
|
|
18
|
+
|
|
19
|
+
instance = Zippendo::GetOrderChannelWebhookStatus200ResponseWebhooksInner.new(
|
|
20
|
+
id: 1234567890,
|
|
21
|
+
topic: ORDERS_CREATE,
|
|
22
|
+
address: https://api.zippendo.dk/webhooks/order-channels/clz9k2f0a0001abcd1234efgh,
|
|
23
|
+
created_at: 2026-06-22T14:30:00.000Z,
|
|
24
|
+
delivery_url: https://api.zippendo.dk/webhooks/order-channels/clz9k2f0a0001abcd1234efgh,
|
|
25
|
+
status: active
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
|
@@ -15,6 +15,8 @@
|
|
|
15
15
|
| **optional_fields** | [**Array<ListAvailableCarriers200ResponseInnerRequiredFieldsInner>**](ListAvailableCarriers200ResponseInnerRequiredFieldsInner.md) | Optional configuration fields for the carrier | [optional] |
|
|
16
16
|
| **deprecated** | **Boolean** | Whether this integration is deprecated (still works, but discouraged) | [optional] |
|
|
17
17
|
| **deprecation_message** | **String** | Guidance shown alongside the deprecated tag (e.g. what to migrate to) | [optional] |
|
|
18
|
+
| **generates_customs_documents** | **Boolean** | Whether the carrier produces the customs declaration (CN22/CN23) itself and returns it with the label. | [optional] |
|
|
19
|
+
| **generates_commercial_invoice** | **Boolean** | Whether the carrier produces the commercial invoice itself and returns it with the label, e.g. via electronic trade documents. | [optional] |
|
|
18
20
|
|
|
19
21
|
## Example
|
|
20
22
|
|
|
@@ -32,7 +34,9 @@ instance = Zippendo::ListAvailableCarriers200ResponseInner.new(
|
|
|
32
34
|
required_fields: null,
|
|
33
35
|
optional_fields: null,
|
|
34
36
|
deprecated: true,
|
|
35
|
-
deprecation_message: The standalone Instabox API is deprecated. Migrate to the Instabee-powered Instabox integration
|
|
37
|
+
deprecation_message: The standalone Instabox API is deprecated. Migrate to the Instabee-powered Instabox integration.,
|
|
38
|
+
generates_customs_documents: true,
|
|
39
|
+
generates_commercial_invoice: true
|
|
36
40
|
)
|
|
37
41
|
```
|
|
38
42
|
|
|
@@ -16,6 +16,8 @@
|
|
|
16
16
|
| **brand_color** | **String** | Carrier brand color (hex) | [optional] |
|
|
17
17
|
| **deprecated** | **Boolean** | Whether this carrier integration is deprecated (still works, but discouraged) | [optional] |
|
|
18
18
|
| **deprecation_message** | **String** | Guidance shown alongside the deprecated tag (e.g. what to migrate to) | [optional] |
|
|
19
|
+
| **generates_customs_documents** | **Boolean** | Whether the carrier produces the customs declaration (CN22/CN23) itself and returns it with the label. | [optional] |
|
|
20
|
+
| **generates_commercial_invoice** | **Boolean** | Whether the carrier produces the commercial invoice itself and returns it with the label, e.g. via electronic trade documents. | [optional] |
|
|
19
21
|
|
|
20
22
|
## Example
|
|
21
23
|
|
|
@@ -34,7 +36,9 @@ instance = Zippendo::ListCarriers200ResponseDataInner.new(
|
|
|
34
36
|
logo: https://cdn.zippendo.com/logos/postnord.svg,
|
|
35
37
|
brand_color: #005BAA,
|
|
36
38
|
deprecated: true,
|
|
37
|
-
deprecation_message: The standalone Instabox API is deprecated. Migrate to the Instabee-powered Instabox integration
|
|
39
|
+
deprecation_message: The standalone Instabox API is deprecated. Migrate to the Instabee-powered Instabox integration.,
|
|
40
|
+
generates_customs_documents: true,
|
|
41
|
+
generates_commercial_invoice: true
|
|
38
42
|
)
|
|
39
43
|
```
|
|
40
44
|
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Zippendo::ListOrderChannels200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**Array<ListOrderChannels200ResponseDataInner>**](ListOrderChannels200ResponseDataInner.md) | Page of results | |
|
|
8
|
+
| **total** | **Float** | Total matching items across all pages | |
|
|
9
|
+
| **page** | **Float** | Current page number (1-based) | |
|
|
10
|
+
| **limit** | **Float** | Items per page | |
|
|
11
|
+
| **total_pages** | **Float** | Total number of pages | |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'zippendo'
|
|
17
|
+
|
|
18
|
+
instance = Zippendo::ListOrderChannels200Response.new(
|
|
19
|
+
data: null,
|
|
20
|
+
total: 137,
|
|
21
|
+
page: 1,
|
|
22
|
+
limit: 20,
|
|
23
|
+
total_pages: 7
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# Zippendo::ListOrderChannels200ResponseDataInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Unique order channel ID. | |
|
|
8
|
+
| **name** | **String** | Display name of the channel. | |
|
|
9
|
+
| **type** | **String** | Type of the order channel (sales platform). | |
|
|
10
|
+
| **enabled** | **Boolean** | Whether the channel is active. | |
|
|
11
|
+
| **brand_id** | **String** | Brand this channel belongs to, or null for organization-wide. Orders synced from this channel inherit it, and so do the shipments and documents made from them. | |
|
|
12
|
+
| **has_credentials** | **Boolean** | Whether credentials are configured (values are never exposed). | |
|
|
13
|
+
| **settings** | [**ListOrderChannels200ResponseDataInnerSettings**](ListOrderChannels200ResponseDataInnerSettings.md) | | |
|
|
14
|
+
| **webhooks_enabled** | **Boolean** | Whether real-time webhooks are enabled. | [optional] |
|
|
15
|
+
| **last_sync_at** | **Time** | Timestamp of the last successful sync. | [optional] |
|
|
16
|
+
| **last_sync_error** | **String** | Error message from the last failed sync. | [optional] |
|
|
17
|
+
| **shipping_rule_ids** | **Array<String>** | IDs of shipping rules linked to this channel. | [optional] |
|
|
18
|
+
| **org_id** | **String** | Owning organization ID. | |
|
|
19
|
+
| **created_at** | **String** | Creation timestamp (ISO 8601). | |
|
|
20
|
+
| **updated_at** | **String** | Last update timestamp (ISO 8601). | |
|
|
21
|
+
|
|
22
|
+
## Example
|
|
23
|
+
|
|
24
|
+
```ruby
|
|
25
|
+
require 'zippendo'
|
|
26
|
+
|
|
27
|
+
instance = Zippendo::ListOrderChannels200ResponseDataInner.new(
|
|
28
|
+
id: clz9k2f0a0001abcd1234efgh,
|
|
29
|
+
name: Anna's Shopify Store,
|
|
30
|
+
type: shopify,
|
|
31
|
+
enabled: true,
|
|
32
|
+
brand_id: brnd_8f3kd92ld0,
|
|
33
|
+
has_credentials: true,
|
|
34
|
+
settings: null,
|
|
35
|
+
webhooks_enabled: true,
|
|
36
|
+
last_sync_at: 2026-06-22T14:30Z,
|
|
37
|
+
last_sync_error: Invalid API credentials,
|
|
38
|
+
shipping_rule_ids: ["clz9k2f0a0002abcd5678ijkl"],
|
|
39
|
+
org_id: clz9k2f0a0000abcd0000zzzz,
|
|
40
|
+
created_at: 2026-06-22T14:30:00.000Z,
|
|
41
|
+
updated_at: 2026-06-22T14:30:00.000Z
|
|
42
|
+
)
|
|
43
|
+
```
|
|
44
|
+
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# Zippendo::ListOrderChannels200ResponseDataInnerSettings
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **use_webhooks** | **Boolean** | Use webhooks for real-time order sync. | [default to true] |
|
|
8
|
+
| **webhook_id** | **String** | External webhook identifier for management. | [optional] |
|
|
9
|
+
| **webhook_ids** | **Array<Integer>** | Registered WooCommerce webhook ids. | [optional] |
|
|
10
|
+
| **webhook_secret_created_at** | **Time** | When the custom channel's webhook signing secret was issued. A non-secret signal so clients can show that a secret exists; the secret itself is never returned after creation. | [optional] |
|
|
11
|
+
| **site_url** | **String** | WooCommerce store URL. | [optional] |
|
|
12
|
+
| **auto_fulfill** | **Boolean** | Push tracking back to the platform when a shipment is dispatched. Enabled by default (opt-out) — set to false to disable write-back; an unset value still syncs. | [optional] |
|
|
13
|
+
| **checkout_token_created_at** | **Time** | When the checkout token was issued (internal; never exposed in API responses). | [optional] |
|
|
14
|
+
| **auto_sync** | **Boolean** | Periodically poll the channel for new orders. | [default to false] |
|
|
15
|
+
| **sync_interval_minutes** | **Integer** | Polling interval in minutes (5-1440). | [default to 15] |
|
|
16
|
+
| **auto_ship_on_create** | **Boolean** | Create a shipment automatically when an order arrives. | [default to false] |
|
|
17
|
+
| **default_carrier_id** | **String** | Default carrier ID for auto-shipping. | [optional] |
|
|
18
|
+
| **default_product_id** | **String** | Default carrier product ID for auto-shipping. | [optional] |
|
|
19
|
+
| **default_address_id** | **String** | Default sender address ID for auto-shipping. | [optional] |
|
|
20
|
+
| **shipping_method_mappings** | [**Array<ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner>**](ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner.md) | Map imported shipping-method titles to shipping rules, for channels without checkout rate integration. | [optional] |
|
|
21
|
+
| **sync_only_unfulfilled** | **Boolean** | Only import orders that are not yet fulfilled. | [default to true] |
|
|
22
|
+
| **sync_orders_since** | **Time** | Only sync orders placed at or after this timestamp. | [optional] |
|
|
23
|
+
| **service_point_count** | **Integer** | Number of service points to show at checkout (1-20). | [default to 6] |
|
|
24
|
+
|
|
25
|
+
## Example
|
|
26
|
+
|
|
27
|
+
```ruby
|
|
28
|
+
require 'zippendo'
|
|
29
|
+
|
|
30
|
+
instance = Zippendo::ListOrderChannels200ResponseDataInnerSettings.new(
|
|
31
|
+
use_webhooks: true,
|
|
32
|
+
webhook_id: gid://shopify/WebhookSubscription/12345,
|
|
33
|
+
webhook_ids: [12,13,14],
|
|
34
|
+
webhook_secret_created_at: 2026-06-22T14:30Z,
|
|
35
|
+
site_url: https://butik.dk,
|
|
36
|
+
auto_fulfill: true,
|
|
37
|
+
checkout_token_created_at: 2026-06-22T14:30Z,
|
|
38
|
+
auto_sync: false,
|
|
39
|
+
sync_interval_minutes: 15,
|
|
40
|
+
auto_ship_on_create: false,
|
|
41
|
+
default_carrier_id: clz9k2f0a0006abcd1357yzab,
|
|
42
|
+
default_product_id: postnord-home-delivery,
|
|
43
|
+
default_address_id: clz9k2f0a0005abcd7890uvwx,
|
|
44
|
+
shipping_method_mappings: [{"match":"GLS Hjemmelevering","shippingRuleId":"clz9k2f0a0007abcd2468qrst"}],
|
|
45
|
+
sync_only_unfulfilled: true,
|
|
46
|
+
sync_orders_since: 2026-05-22T00:00Z,
|
|
47
|
+
service_point_count: 6
|
|
48
|
+
)
|
|
49
|
+
```
|
|
50
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Zippendo::ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **match** | **String** | Shipping-method title to match against imported orders (trimmed, case-insensitive, exact). | |
|
|
8
|
+
| **shipping_rule_id** | **String** | Shipping rule applied to orders whose shipping-method title matches. | |
|
|
9
|
+
| **service_point_selection** | **String** | For rules whose product delivers to a service point: 'nearest' auto-selects the closest point to the recipient address; 'manual' keeps the shipment in draft for manual selection. | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'zippendo'
|
|
15
|
+
|
|
16
|
+
instance = Zippendo::ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner.new(
|
|
17
|
+
match: GLS Hjemmelevering,
|
|
18
|
+
shipping_rule_id: clz9k2f0a0007abcd2468qrst,
|
|
19
|
+
service_point_selection: nearest
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|