zippendo 1.2.4 → 1.2.6
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/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/docs/UpdateOrgRequest.md +0 -2
- 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_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/models/update_org_request.rb +1 -11
- data/lib/zippendo/version.rb +1 -1
- data/lib/zippendo.rb +14 -0
- metadata +29 -1
|
@@ -0,0 +1,599 @@
|
|
|
1
|
+
# Zippendo::OrderChannelsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.zippendo.com*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**create_order_channel**](OrderChannelsApi.md#create_order_channel) | **POST** /orgs/{orgId}/order-channels | Create order channel |
|
|
8
|
+
| [**create_order_channel_webhook_secret**](OrderChannelsApi.md#create_order_channel_webhook_secret) | **POST** /orgs/{orgId}/order-channels/{channelId}/webhook-secret | Create or rotate webhook signing secret |
|
|
9
|
+
| [**delete_order_channel**](OrderChannelsApi.md#delete_order_channel) | **DELETE** /orgs/{orgId}/order-channels/{channelId} | Delete order channel |
|
|
10
|
+
| [**get_order_channel**](OrderChannelsApi.md#get_order_channel) | **GET** /orgs/{orgId}/order-channels/{channelId} | Get order channel |
|
|
11
|
+
| [**get_order_channel_webhook_status**](OrderChannelsApi.md#get_order_channel_webhook_status) | **GET** /orgs/{orgId}/order-channels/{channelId}/webhooks | Get channel webhook status |
|
|
12
|
+
| [**list_order_channels**](OrderChannelsApi.md#list_order_channels) | **GET** /orgs/{orgId}/order-channels | List order channels |
|
|
13
|
+
| [**revoke_order_channel_webhook_secret**](OrderChannelsApi.md#revoke_order_channel_webhook_secret) | **DELETE** /orgs/{orgId}/order-channels/{channelId}/webhook-secret | Revoke webhook signing secret |
|
|
14
|
+
| [**update_order_channel**](OrderChannelsApi.md#update_order_channel) | **PATCH** /orgs/{orgId}/order-channels/{channelId} | Update order channel |
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
## create_order_channel
|
|
18
|
+
|
|
19
|
+
> <ListOrderChannels200ResponseDataInner> create_order_channel(org_id, create_order_channel_request)
|
|
20
|
+
|
|
21
|
+
Create order channel
|
|
22
|
+
|
|
23
|
+
Creates a new order channel for an organization.
|
|
24
|
+
|
|
25
|
+
### Examples
|
|
26
|
+
|
|
27
|
+
```ruby
|
|
28
|
+
require 'time'
|
|
29
|
+
require 'zippendo'
|
|
30
|
+
# setup authorization
|
|
31
|
+
Zippendo.configure do |config|
|
|
32
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
33
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
34
|
+
end
|
|
35
|
+
|
|
36
|
+
api_instance = Zippendo::OrderChannelsApi.new
|
|
37
|
+
org_id = 'org_8f3kd92ld0' # String | Organization ID
|
|
38
|
+
create_order_channel_request = Zippendo::CreateOrderChannelRequest.new({name: 'Anna's webshop', type: 'manual'}) # CreateOrderChannelRequest |
|
|
39
|
+
|
|
40
|
+
begin
|
|
41
|
+
# Create order channel
|
|
42
|
+
result = api_instance.create_order_channel(org_id, create_order_channel_request)
|
|
43
|
+
p result
|
|
44
|
+
rescue Zippendo::ApiError => e
|
|
45
|
+
puts "Error when calling OrderChannelsApi->create_order_channel: #{e}"
|
|
46
|
+
end
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
#### Using the create_order_channel_with_http_info variant
|
|
50
|
+
|
|
51
|
+
This returns an Array which contains the response data, status code and headers.
|
|
52
|
+
|
|
53
|
+
> <Array(<ListOrderChannels200ResponseDataInner>, Integer, Hash)> create_order_channel_with_http_info(org_id, create_order_channel_request)
|
|
54
|
+
|
|
55
|
+
```ruby
|
|
56
|
+
begin
|
|
57
|
+
# Create order channel
|
|
58
|
+
data, status_code, headers = api_instance.create_order_channel_with_http_info(org_id, create_order_channel_request)
|
|
59
|
+
p status_code # => 2xx
|
|
60
|
+
p headers # => { ... }
|
|
61
|
+
p data # => <ListOrderChannels200ResponseDataInner>
|
|
62
|
+
rescue Zippendo::ApiError => e
|
|
63
|
+
puts "Error when calling OrderChannelsApi->create_order_channel_with_http_info: #{e}"
|
|
64
|
+
end
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
### Parameters
|
|
68
|
+
|
|
69
|
+
| Name | Type | Description | Notes |
|
|
70
|
+
| ---- | ---- | ----------- | ----- |
|
|
71
|
+
| **org_id** | **String** | Organization ID | |
|
|
72
|
+
| **create_order_channel_request** | [**CreateOrderChannelRequest**](CreateOrderChannelRequest.md) | | |
|
|
73
|
+
|
|
74
|
+
### Return type
|
|
75
|
+
|
|
76
|
+
[**ListOrderChannels200ResponseDataInner**](ListOrderChannels200ResponseDataInner.md)
|
|
77
|
+
|
|
78
|
+
### Authorization
|
|
79
|
+
|
|
80
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
81
|
+
|
|
82
|
+
### HTTP request headers
|
|
83
|
+
|
|
84
|
+
- **Content-Type**: application/json
|
|
85
|
+
- **Accept**: application/json
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
## create_order_channel_webhook_secret
|
|
89
|
+
|
|
90
|
+
> <CreateOrderChannelWebhookSecret201Response> create_order_channel_webhook_secret(org_id, channel_id)
|
|
91
|
+
|
|
92
|
+
Create or rotate webhook signing secret
|
|
93
|
+
|
|
94
|
+
Generates (or rotates) the custom channel's webhook signing secret used to authenticate order pushes to the ingest URL. The secret is returned only once. Rotating invalidates the previous secret immediately.
|
|
95
|
+
|
|
96
|
+
### Examples
|
|
97
|
+
|
|
98
|
+
```ruby
|
|
99
|
+
require 'time'
|
|
100
|
+
require 'zippendo'
|
|
101
|
+
# setup authorization
|
|
102
|
+
Zippendo.configure do |config|
|
|
103
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
104
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
105
|
+
end
|
|
106
|
+
|
|
107
|
+
api_instance = Zippendo::OrderChannelsApi.new
|
|
108
|
+
org_id = 'clz9k2f0a0000abcd0000zzzz' # String | Organization ID.
|
|
109
|
+
channel_id = 'clz9k2f0a0001abcd1234efgh' # String | Order channel ID.
|
|
110
|
+
|
|
111
|
+
begin
|
|
112
|
+
# Create or rotate webhook signing secret
|
|
113
|
+
result = api_instance.create_order_channel_webhook_secret(org_id, channel_id)
|
|
114
|
+
p result
|
|
115
|
+
rescue Zippendo::ApiError => e
|
|
116
|
+
puts "Error when calling OrderChannelsApi->create_order_channel_webhook_secret: #{e}"
|
|
117
|
+
end
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
#### Using the create_order_channel_webhook_secret_with_http_info variant
|
|
121
|
+
|
|
122
|
+
This returns an Array which contains the response data, status code and headers.
|
|
123
|
+
|
|
124
|
+
> <Array(<CreateOrderChannelWebhookSecret201Response>, Integer, Hash)> create_order_channel_webhook_secret_with_http_info(org_id, channel_id)
|
|
125
|
+
|
|
126
|
+
```ruby
|
|
127
|
+
begin
|
|
128
|
+
# Create or rotate webhook signing secret
|
|
129
|
+
data, status_code, headers = api_instance.create_order_channel_webhook_secret_with_http_info(org_id, channel_id)
|
|
130
|
+
p status_code # => 2xx
|
|
131
|
+
p headers # => { ... }
|
|
132
|
+
p data # => <CreateOrderChannelWebhookSecret201Response>
|
|
133
|
+
rescue Zippendo::ApiError => e
|
|
134
|
+
puts "Error when calling OrderChannelsApi->create_order_channel_webhook_secret_with_http_info: #{e}"
|
|
135
|
+
end
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
### Parameters
|
|
139
|
+
|
|
140
|
+
| Name | Type | Description | Notes |
|
|
141
|
+
| ---- | ---- | ----------- | ----- |
|
|
142
|
+
| **org_id** | **String** | Organization ID. | |
|
|
143
|
+
| **channel_id** | **String** | Order channel ID. | |
|
|
144
|
+
|
|
145
|
+
### Return type
|
|
146
|
+
|
|
147
|
+
[**CreateOrderChannelWebhookSecret201Response**](CreateOrderChannelWebhookSecret201Response.md)
|
|
148
|
+
|
|
149
|
+
### Authorization
|
|
150
|
+
|
|
151
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
152
|
+
|
|
153
|
+
### HTTP request headers
|
|
154
|
+
|
|
155
|
+
- **Content-Type**: Not defined
|
|
156
|
+
- **Accept**: application/json
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
## delete_order_channel
|
|
160
|
+
|
|
161
|
+
> <RevokeApiToken200Response> delete_order_channel(org_id, channel_id)
|
|
162
|
+
|
|
163
|
+
Delete order channel
|
|
164
|
+
|
|
165
|
+
Deletes an order channel and cascades deletion of its orders.
|
|
166
|
+
|
|
167
|
+
### Examples
|
|
168
|
+
|
|
169
|
+
```ruby
|
|
170
|
+
require 'time'
|
|
171
|
+
require 'zippendo'
|
|
172
|
+
# setup authorization
|
|
173
|
+
Zippendo.configure do |config|
|
|
174
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
175
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
176
|
+
end
|
|
177
|
+
|
|
178
|
+
api_instance = Zippendo::OrderChannelsApi.new
|
|
179
|
+
org_id = 'clz9k2f0a0000abcd0000zzzz' # String | Organization ID.
|
|
180
|
+
channel_id = 'clz9k2f0a0001abcd1234efgh' # String | Order channel ID.
|
|
181
|
+
|
|
182
|
+
begin
|
|
183
|
+
# Delete order channel
|
|
184
|
+
result = api_instance.delete_order_channel(org_id, channel_id)
|
|
185
|
+
p result
|
|
186
|
+
rescue Zippendo::ApiError => e
|
|
187
|
+
puts "Error when calling OrderChannelsApi->delete_order_channel: #{e}"
|
|
188
|
+
end
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
#### Using the delete_order_channel_with_http_info variant
|
|
192
|
+
|
|
193
|
+
This returns an Array which contains the response data, status code and headers.
|
|
194
|
+
|
|
195
|
+
> <Array(<RevokeApiToken200Response>, Integer, Hash)> delete_order_channel_with_http_info(org_id, channel_id)
|
|
196
|
+
|
|
197
|
+
```ruby
|
|
198
|
+
begin
|
|
199
|
+
# Delete order channel
|
|
200
|
+
data, status_code, headers = api_instance.delete_order_channel_with_http_info(org_id, channel_id)
|
|
201
|
+
p status_code # => 2xx
|
|
202
|
+
p headers # => { ... }
|
|
203
|
+
p data # => <RevokeApiToken200Response>
|
|
204
|
+
rescue Zippendo::ApiError => e
|
|
205
|
+
puts "Error when calling OrderChannelsApi->delete_order_channel_with_http_info: #{e}"
|
|
206
|
+
end
|
|
207
|
+
```
|
|
208
|
+
|
|
209
|
+
### Parameters
|
|
210
|
+
|
|
211
|
+
| Name | Type | Description | Notes |
|
|
212
|
+
| ---- | ---- | ----------- | ----- |
|
|
213
|
+
| **org_id** | **String** | Organization ID. | |
|
|
214
|
+
| **channel_id** | **String** | Order channel ID. | |
|
|
215
|
+
|
|
216
|
+
### Return type
|
|
217
|
+
|
|
218
|
+
[**RevokeApiToken200Response**](RevokeApiToken200Response.md)
|
|
219
|
+
|
|
220
|
+
### Authorization
|
|
221
|
+
|
|
222
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
223
|
+
|
|
224
|
+
### HTTP request headers
|
|
225
|
+
|
|
226
|
+
- **Content-Type**: Not defined
|
|
227
|
+
- **Accept**: application/json
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
## get_order_channel
|
|
231
|
+
|
|
232
|
+
> <ListOrderChannels200ResponseDataInner> get_order_channel(org_id, channel_id)
|
|
233
|
+
|
|
234
|
+
Get order channel
|
|
235
|
+
|
|
236
|
+
Returns a single order channel by ID, including its linked shipping rules.
|
|
237
|
+
|
|
238
|
+
### Examples
|
|
239
|
+
|
|
240
|
+
```ruby
|
|
241
|
+
require 'time'
|
|
242
|
+
require 'zippendo'
|
|
243
|
+
# setup authorization
|
|
244
|
+
Zippendo.configure do |config|
|
|
245
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
246
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
247
|
+
end
|
|
248
|
+
|
|
249
|
+
api_instance = Zippendo::OrderChannelsApi.new
|
|
250
|
+
org_id = 'clz9k2f0a0000abcd0000zzzz' # String | Organization ID.
|
|
251
|
+
channel_id = 'clz9k2f0a0001abcd1234efgh' # String | Order channel ID.
|
|
252
|
+
|
|
253
|
+
begin
|
|
254
|
+
# Get order channel
|
|
255
|
+
result = api_instance.get_order_channel(org_id, channel_id)
|
|
256
|
+
p result
|
|
257
|
+
rescue Zippendo::ApiError => e
|
|
258
|
+
puts "Error when calling OrderChannelsApi->get_order_channel: #{e}"
|
|
259
|
+
end
|
|
260
|
+
```
|
|
261
|
+
|
|
262
|
+
#### Using the get_order_channel_with_http_info variant
|
|
263
|
+
|
|
264
|
+
This returns an Array which contains the response data, status code and headers.
|
|
265
|
+
|
|
266
|
+
> <Array(<ListOrderChannels200ResponseDataInner>, Integer, Hash)> get_order_channel_with_http_info(org_id, channel_id)
|
|
267
|
+
|
|
268
|
+
```ruby
|
|
269
|
+
begin
|
|
270
|
+
# Get order channel
|
|
271
|
+
data, status_code, headers = api_instance.get_order_channel_with_http_info(org_id, channel_id)
|
|
272
|
+
p status_code # => 2xx
|
|
273
|
+
p headers # => { ... }
|
|
274
|
+
p data # => <ListOrderChannels200ResponseDataInner>
|
|
275
|
+
rescue Zippendo::ApiError => e
|
|
276
|
+
puts "Error when calling OrderChannelsApi->get_order_channel_with_http_info: #{e}"
|
|
277
|
+
end
|
|
278
|
+
```
|
|
279
|
+
|
|
280
|
+
### Parameters
|
|
281
|
+
|
|
282
|
+
| Name | Type | Description | Notes |
|
|
283
|
+
| ---- | ---- | ----------- | ----- |
|
|
284
|
+
| **org_id** | **String** | Organization ID. | |
|
|
285
|
+
| **channel_id** | **String** | Order channel ID. | |
|
|
286
|
+
|
|
287
|
+
### Return type
|
|
288
|
+
|
|
289
|
+
[**ListOrderChannels200ResponseDataInner**](ListOrderChannels200ResponseDataInner.md)
|
|
290
|
+
|
|
291
|
+
### Authorization
|
|
292
|
+
|
|
293
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
294
|
+
|
|
295
|
+
### HTTP request headers
|
|
296
|
+
|
|
297
|
+
- **Content-Type**: Not defined
|
|
298
|
+
- **Accept**: application/json
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
## get_order_channel_webhook_status
|
|
302
|
+
|
|
303
|
+
> <GetOrderChannelWebhookStatus200Response> get_order_channel_webhook_status(org_id, channel_id)
|
|
304
|
+
|
|
305
|
+
Get channel webhook status
|
|
306
|
+
|
|
307
|
+
Returns whether webhooks are enabled and lists the webhooks registered with the platform.
|
|
308
|
+
|
|
309
|
+
### Examples
|
|
310
|
+
|
|
311
|
+
```ruby
|
|
312
|
+
require 'time'
|
|
313
|
+
require 'zippendo'
|
|
314
|
+
# setup authorization
|
|
315
|
+
Zippendo.configure do |config|
|
|
316
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
317
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
318
|
+
end
|
|
319
|
+
|
|
320
|
+
api_instance = Zippendo::OrderChannelsApi.new
|
|
321
|
+
org_id = 'clz9k2f0a0000abcd0000zzzz' # String | Organization ID.
|
|
322
|
+
channel_id = 'clz9k2f0a0001abcd1234efgh' # String | Order channel ID.
|
|
323
|
+
|
|
324
|
+
begin
|
|
325
|
+
# Get channel webhook status
|
|
326
|
+
result = api_instance.get_order_channel_webhook_status(org_id, channel_id)
|
|
327
|
+
p result
|
|
328
|
+
rescue Zippendo::ApiError => e
|
|
329
|
+
puts "Error when calling OrderChannelsApi->get_order_channel_webhook_status: #{e}"
|
|
330
|
+
end
|
|
331
|
+
```
|
|
332
|
+
|
|
333
|
+
#### Using the get_order_channel_webhook_status_with_http_info variant
|
|
334
|
+
|
|
335
|
+
This returns an Array which contains the response data, status code and headers.
|
|
336
|
+
|
|
337
|
+
> <Array(<GetOrderChannelWebhookStatus200Response>, Integer, Hash)> get_order_channel_webhook_status_with_http_info(org_id, channel_id)
|
|
338
|
+
|
|
339
|
+
```ruby
|
|
340
|
+
begin
|
|
341
|
+
# Get channel webhook status
|
|
342
|
+
data, status_code, headers = api_instance.get_order_channel_webhook_status_with_http_info(org_id, channel_id)
|
|
343
|
+
p status_code # => 2xx
|
|
344
|
+
p headers # => { ... }
|
|
345
|
+
p data # => <GetOrderChannelWebhookStatus200Response>
|
|
346
|
+
rescue Zippendo::ApiError => e
|
|
347
|
+
puts "Error when calling OrderChannelsApi->get_order_channel_webhook_status_with_http_info: #{e}"
|
|
348
|
+
end
|
|
349
|
+
```
|
|
350
|
+
|
|
351
|
+
### Parameters
|
|
352
|
+
|
|
353
|
+
| Name | Type | Description | Notes |
|
|
354
|
+
| ---- | ---- | ----------- | ----- |
|
|
355
|
+
| **org_id** | **String** | Organization ID. | |
|
|
356
|
+
| **channel_id** | **String** | Order channel ID. | |
|
|
357
|
+
|
|
358
|
+
### Return type
|
|
359
|
+
|
|
360
|
+
[**GetOrderChannelWebhookStatus200Response**](GetOrderChannelWebhookStatus200Response.md)
|
|
361
|
+
|
|
362
|
+
### Authorization
|
|
363
|
+
|
|
364
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
365
|
+
|
|
366
|
+
### HTTP request headers
|
|
367
|
+
|
|
368
|
+
- **Content-Type**: Not defined
|
|
369
|
+
- **Accept**: application/json
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
## list_order_channels
|
|
373
|
+
|
|
374
|
+
> <ListOrderChannels200Response> list_order_channels(org_id, opts)
|
|
375
|
+
|
|
376
|
+
List order channels
|
|
377
|
+
|
|
378
|
+
Returns a paginated list of order channels for an organization.
|
|
379
|
+
|
|
380
|
+
### Examples
|
|
381
|
+
|
|
382
|
+
```ruby
|
|
383
|
+
require 'time'
|
|
384
|
+
require 'zippendo'
|
|
385
|
+
# setup authorization
|
|
386
|
+
Zippendo.configure do |config|
|
|
387
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
388
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
389
|
+
end
|
|
390
|
+
|
|
391
|
+
api_instance = Zippendo::OrderChannelsApi.new
|
|
392
|
+
org_id = 'org_8f3kd92ld0' # String | Organization ID
|
|
393
|
+
opts = {
|
|
394
|
+
page: 1, # Integer | Page number (1-based)
|
|
395
|
+
limit: 20, # Integer | Items per page (max 100)
|
|
396
|
+
brand_id: 'brnd_8f3kd92ld0', # String | Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand.
|
|
397
|
+
brand_scope: 'own', # String | How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context.
|
|
398
|
+
type: 'shopify', # String | Filter by channel type.
|
|
399
|
+
enabled: 'true', # String | Filter by enabled state.
|
|
400
|
+
search: 'Anna's Shopify Store' # String | Search by channel name.
|
|
401
|
+
}
|
|
402
|
+
|
|
403
|
+
begin
|
|
404
|
+
# List order channels
|
|
405
|
+
result = api_instance.list_order_channels(org_id, opts)
|
|
406
|
+
p result
|
|
407
|
+
rescue Zippendo::ApiError => e
|
|
408
|
+
puts "Error when calling OrderChannelsApi->list_order_channels: #{e}"
|
|
409
|
+
end
|
|
410
|
+
```
|
|
411
|
+
|
|
412
|
+
#### Using the list_order_channels_with_http_info variant
|
|
413
|
+
|
|
414
|
+
This returns an Array which contains the response data, status code and headers.
|
|
415
|
+
|
|
416
|
+
> <Array(<ListOrderChannels200Response>, Integer, Hash)> list_order_channels_with_http_info(org_id, opts)
|
|
417
|
+
|
|
418
|
+
```ruby
|
|
419
|
+
begin
|
|
420
|
+
# List order channels
|
|
421
|
+
data, status_code, headers = api_instance.list_order_channels_with_http_info(org_id, opts)
|
|
422
|
+
p status_code # => 2xx
|
|
423
|
+
p headers # => { ... }
|
|
424
|
+
p data # => <ListOrderChannels200Response>
|
|
425
|
+
rescue Zippendo::ApiError => e
|
|
426
|
+
puts "Error when calling OrderChannelsApi->list_order_channels_with_http_info: #{e}"
|
|
427
|
+
end
|
|
428
|
+
```
|
|
429
|
+
|
|
430
|
+
### Parameters
|
|
431
|
+
|
|
432
|
+
| Name | Type | Description | Notes |
|
|
433
|
+
| ---- | ---- | ----------- | ----- |
|
|
434
|
+
| **org_id** | **String** | Organization ID | |
|
|
435
|
+
| **page** | **Integer** | Page number (1-based) | [optional][default to 1] |
|
|
436
|
+
| **limit** | **Integer** | Items per page (max 100) | [optional][default to 20] |
|
|
437
|
+
| **brand_id** | **String** | Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand. | [optional] |
|
|
438
|
+
| **brand_scope** | **String** | How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context. | [optional] |
|
|
439
|
+
| **type** | **String** | Filter by channel type. | [optional] |
|
|
440
|
+
| **enabled** | **String** | Filter by enabled state. | [optional] |
|
|
441
|
+
| **search** | **String** | Search by channel name. | [optional] |
|
|
442
|
+
|
|
443
|
+
### Return type
|
|
444
|
+
|
|
445
|
+
[**ListOrderChannels200Response**](ListOrderChannels200Response.md)
|
|
446
|
+
|
|
447
|
+
### Authorization
|
|
448
|
+
|
|
449
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
450
|
+
|
|
451
|
+
### HTTP request headers
|
|
452
|
+
|
|
453
|
+
- **Content-Type**: Not defined
|
|
454
|
+
- **Accept**: application/json
|
|
455
|
+
|
|
456
|
+
|
|
457
|
+
## revoke_order_channel_webhook_secret
|
|
458
|
+
|
|
459
|
+
> <RevokeOrderChannelWebhookSecret200Response> revoke_order_channel_webhook_secret(org_id, channel_id)
|
|
460
|
+
|
|
461
|
+
Revoke webhook signing secret
|
|
462
|
+
|
|
463
|
+
Revokes the custom channel's webhook signing secret. All subsequent pushes to the ingest URL are rejected until a new secret is generated.
|
|
464
|
+
|
|
465
|
+
### Examples
|
|
466
|
+
|
|
467
|
+
```ruby
|
|
468
|
+
require 'time'
|
|
469
|
+
require 'zippendo'
|
|
470
|
+
# setup authorization
|
|
471
|
+
Zippendo.configure do |config|
|
|
472
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
473
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
474
|
+
end
|
|
475
|
+
|
|
476
|
+
api_instance = Zippendo::OrderChannelsApi.new
|
|
477
|
+
org_id = 'clz9k2f0a0000abcd0000zzzz' # String | Organization ID.
|
|
478
|
+
channel_id = 'clz9k2f0a0001abcd1234efgh' # String | Order channel ID.
|
|
479
|
+
|
|
480
|
+
begin
|
|
481
|
+
# Revoke webhook signing secret
|
|
482
|
+
result = api_instance.revoke_order_channel_webhook_secret(org_id, channel_id)
|
|
483
|
+
p result
|
|
484
|
+
rescue Zippendo::ApiError => e
|
|
485
|
+
puts "Error when calling OrderChannelsApi->revoke_order_channel_webhook_secret: #{e}"
|
|
486
|
+
end
|
|
487
|
+
```
|
|
488
|
+
|
|
489
|
+
#### Using the revoke_order_channel_webhook_secret_with_http_info variant
|
|
490
|
+
|
|
491
|
+
This returns an Array which contains the response data, status code and headers.
|
|
492
|
+
|
|
493
|
+
> <Array(<RevokeOrderChannelWebhookSecret200Response>, Integer, Hash)> revoke_order_channel_webhook_secret_with_http_info(org_id, channel_id)
|
|
494
|
+
|
|
495
|
+
```ruby
|
|
496
|
+
begin
|
|
497
|
+
# Revoke webhook signing secret
|
|
498
|
+
data, status_code, headers = api_instance.revoke_order_channel_webhook_secret_with_http_info(org_id, channel_id)
|
|
499
|
+
p status_code # => 2xx
|
|
500
|
+
p headers # => { ... }
|
|
501
|
+
p data # => <RevokeOrderChannelWebhookSecret200Response>
|
|
502
|
+
rescue Zippendo::ApiError => e
|
|
503
|
+
puts "Error when calling OrderChannelsApi->revoke_order_channel_webhook_secret_with_http_info: #{e}"
|
|
504
|
+
end
|
|
505
|
+
```
|
|
506
|
+
|
|
507
|
+
### Parameters
|
|
508
|
+
|
|
509
|
+
| Name | Type | Description | Notes |
|
|
510
|
+
| ---- | ---- | ----------- | ----- |
|
|
511
|
+
| **org_id** | **String** | Organization ID. | |
|
|
512
|
+
| **channel_id** | **String** | Order channel ID. | |
|
|
513
|
+
|
|
514
|
+
### Return type
|
|
515
|
+
|
|
516
|
+
[**RevokeOrderChannelWebhookSecret200Response**](RevokeOrderChannelWebhookSecret200Response.md)
|
|
517
|
+
|
|
518
|
+
### Authorization
|
|
519
|
+
|
|
520
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
521
|
+
|
|
522
|
+
### HTTP request headers
|
|
523
|
+
|
|
524
|
+
- **Content-Type**: Not defined
|
|
525
|
+
- **Accept**: application/json
|
|
526
|
+
|
|
527
|
+
|
|
528
|
+
## update_order_channel
|
|
529
|
+
|
|
530
|
+
> <ListOrderChannels200ResponseDataInner> update_order_channel(org_id, channel_id, update_order_channel_request)
|
|
531
|
+
|
|
532
|
+
Update order channel
|
|
533
|
+
|
|
534
|
+
Updates an order channel and its linked shipping rules.
|
|
535
|
+
|
|
536
|
+
### Examples
|
|
537
|
+
|
|
538
|
+
```ruby
|
|
539
|
+
require 'time'
|
|
540
|
+
require 'zippendo'
|
|
541
|
+
# setup authorization
|
|
542
|
+
Zippendo.configure do |config|
|
|
543
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
544
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
545
|
+
end
|
|
546
|
+
|
|
547
|
+
api_instance = Zippendo::OrderChannelsApi.new
|
|
548
|
+
org_id = 'clz9k2f0a0000abcd0000zzzz' # String | Organization ID.
|
|
549
|
+
channel_id = 'clz9k2f0a0001abcd1234efgh' # String | Order channel ID.
|
|
550
|
+
update_order_channel_request = Zippendo::UpdateOrderChannelRequest.new # UpdateOrderChannelRequest |
|
|
551
|
+
|
|
552
|
+
begin
|
|
553
|
+
# Update order channel
|
|
554
|
+
result = api_instance.update_order_channel(org_id, channel_id, update_order_channel_request)
|
|
555
|
+
p result
|
|
556
|
+
rescue Zippendo::ApiError => e
|
|
557
|
+
puts "Error when calling OrderChannelsApi->update_order_channel: #{e}"
|
|
558
|
+
end
|
|
559
|
+
```
|
|
560
|
+
|
|
561
|
+
#### Using the update_order_channel_with_http_info variant
|
|
562
|
+
|
|
563
|
+
This returns an Array which contains the response data, status code and headers.
|
|
564
|
+
|
|
565
|
+
> <Array(<ListOrderChannels200ResponseDataInner>, Integer, Hash)> update_order_channel_with_http_info(org_id, channel_id, update_order_channel_request)
|
|
566
|
+
|
|
567
|
+
```ruby
|
|
568
|
+
begin
|
|
569
|
+
# Update order channel
|
|
570
|
+
data, status_code, headers = api_instance.update_order_channel_with_http_info(org_id, channel_id, update_order_channel_request)
|
|
571
|
+
p status_code # => 2xx
|
|
572
|
+
p headers # => { ... }
|
|
573
|
+
p data # => <ListOrderChannels200ResponseDataInner>
|
|
574
|
+
rescue Zippendo::ApiError => e
|
|
575
|
+
puts "Error when calling OrderChannelsApi->update_order_channel_with_http_info: #{e}"
|
|
576
|
+
end
|
|
577
|
+
```
|
|
578
|
+
|
|
579
|
+
### Parameters
|
|
580
|
+
|
|
581
|
+
| Name | Type | Description | Notes |
|
|
582
|
+
| ---- | ---- | ----------- | ----- |
|
|
583
|
+
| **org_id** | **String** | Organization ID. | |
|
|
584
|
+
| **channel_id** | **String** | Order channel ID. | |
|
|
585
|
+
| **update_order_channel_request** | [**UpdateOrderChannelRequest**](UpdateOrderChannelRequest.md) | | |
|
|
586
|
+
|
|
587
|
+
### Return type
|
|
588
|
+
|
|
589
|
+
[**ListOrderChannels200ResponseDataInner**](ListOrderChannels200ResponseDataInner.md)
|
|
590
|
+
|
|
591
|
+
### Authorization
|
|
592
|
+
|
|
593
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
594
|
+
|
|
595
|
+
### HTTP request headers
|
|
596
|
+
|
|
597
|
+
- **Content-Type**: application/json
|
|
598
|
+
- **Accept**: application/json
|
|
599
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Zippendo::RevokeOrderChannelWebhookSecret200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **revoked** | **Boolean** | Whether the signing secret was revoked. | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'zippendo'
|
|
13
|
+
|
|
14
|
+
instance = Zippendo::RevokeOrderChannelWebhookSecret200Response.new(
|
|
15
|
+
revoked: true
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# Zippendo::UpdateOrderChannelRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **brand_id** | **String** | Brand this channel belongs to; null for organization-wide | [optional] |
|
|
8
|
+
| **name** | **String** | Display name for the channel. | [optional] |
|
|
9
|
+
| **enabled** | **Boolean** | Whether the channel is active. | [optional] |
|
|
10
|
+
| **credentials** | **Hash<String, Object>** | Type-specific platform credentials. | [optional] |
|
|
11
|
+
| **settings** | [**UpdateOrderChannelRequestSettings**](UpdateOrderChannelRequestSettings.md) | | [optional] |
|
|
12
|
+
| **shipping_rule_ids** | **Array<String>** | IDs of shipping rules linked to this channel. | [optional] |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'zippendo'
|
|
18
|
+
|
|
19
|
+
instance = Zippendo::UpdateOrderChannelRequest.new(
|
|
20
|
+
brand_id: brnd_8f3kd92ld0,
|
|
21
|
+
name: Anna's Shopify Store,
|
|
22
|
+
enabled: true,
|
|
23
|
+
credentials: null,
|
|
24
|
+
settings: null,
|
|
25
|
+
shipping_rule_ids: ["clz9k2f0a0002abcd5678ijkl"]
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# Zippendo::UpdateOrderChannelRequestSettings
|
|
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::UpdateOrderChannelRequestSettings.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
|
+
|
data/docs/UpdateOrgRequest.md
CHANGED
|
@@ -9,7 +9,6 @@
|
|
|
9
9
|
| **description** | **String** | Organization description | [optional] |
|
|
10
10
|
| **currency** | **String** | Billing currency (ISO 4217 code) | [optional] |
|
|
11
11
|
| **vat_number** | **String** | Company VAT/tax ID for invoices | [optional] |
|
|
12
|
-
| **overage_enabled** | **Boolean** | Allow shipments beyond plan limit (overage charges apply) | [optional] |
|
|
13
12
|
| **phone** | **String** | Billing/contact phone number | [optional] |
|
|
14
13
|
| **billing_email** | **String** | Billing email for invoices | [optional] |
|
|
15
14
|
| **company_name** | **String** | Legal company name | [optional] |
|
|
@@ -31,7 +30,6 @@ instance = Zippendo::UpdateOrgRequest.new(
|
|
|
31
30
|
description: Parcel and freight logistics across the Nordics,
|
|
32
31
|
currency: DKK,
|
|
33
32
|
vat_number: DK12345678,
|
|
34
|
-
overage_enabled: false,
|
|
35
33
|
phone: +45 50 47 02 20,
|
|
36
34
|
billing_email: billing@nordic-logistics.dk,
|
|
37
35
|
company_name: Nordic Logistics ApS,
|