@@ -164,7 +164,7 @@ paths:
164
164
type : object
165
165
properties : {}
166
166
description : |-
167
- Get shipping settings.
167
+ Returns the global-level shipping settings.
168
168
tags :
169
169
- Shipping Settings
170
170
summary : Get Shipping Settings
@@ -185,16 +185,161 @@ paths:
185
185
meta :
186
186
type : object
187
187
properties : {}
188
+ ' 400 ' :
189
+ description : Bad Request. Input is invalid.
190
+ content :
191
+ application/json :
192
+ schema :
193
+ description : ' '
194
+ type : object
195
+ properties :
196
+ status :
197
+ type : number
198
+ title :
199
+ type : string
200
+ minLength : 1
201
+ type :
202
+ type : string
203
+ minLength : 1
204
+ detail :
205
+ type : string
206
+ minLength : 1
207
+ example :
208
+ status : 400
209
+ title : Input is invalid
210
+ type : ' https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes'
211
+ detail : Syntax error
212
+ ' 422 ' :
213
+ description : The request body does not meet the specification.
214
+ content :
215
+ application/json :
216
+ schema :
217
+ description : ' '
218
+ type : object
219
+ properties :
220
+ status :
221
+ type : number
222
+ title :
223
+ type : string
224
+ minLength : 1
225
+ type :
226
+ type : string
227
+ minLength : 1
228
+ example :
229
+ status : 422
230
+ title : Input is invalid
231
+ type : ' https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes'
188
232
summary : Update Shipping Settings
189
233
description : |-
190
- Updates shipping settings.
234
+ Updates the global-level shipping settings.
191
235
tags :
192
236
- Shipping Settings
193
237
requestBody :
194
238
content :
195
239
application/json :
196
240
schema :
197
241
$ref : ' #/components/schemas/shippingSettings'
242
+ ' /shipping/settings/channels/{channel_id} ' :
243
+ parameters :
244
+ - $ref : ' #/components/parameters/Accept'
245
+ - name : channel_id
246
+ in : path
247
+ schema :
248
+ type : string
249
+ description : Channel ID
250
+ required : true
251
+
252
+ get :
253
+ operationId : getChannelShippingSettings
254
+ responses :
255
+ ' 200 ' :
256
+ description : ' '
257
+ content :
258
+ application/json :
259
+ schema :
260
+ type : object
261
+ properties :
262
+ data :
263
+ $ref : ' #/components/schemas/channelShippingSettings'
264
+ meta :
265
+ type : object
266
+ properties : {}
267
+ description : |-
268
+ Returns shipping settings for a specific channel.
269
+ tags :
270
+ - Shipping Settings
271
+ summary : Get Shipping Settings per Channel
272
+ put :
273
+ operationId : updateChannelShippingSettings
274
+ parameters :
275
+ - $ref : ' #/components/parameters/ContentType'
276
+ responses :
277
+ ' 200 ' :
278
+ description : ' '
279
+ content :
280
+ application/json :
281
+ schema :
282
+ type : object
283
+ properties :
284
+ data :
285
+ $ref : ' #/components/schemas/channelShippingSettings'
286
+ meta :
287
+ type : object
288
+ properties : {}
289
+ ' 400 ' :
290
+ description : Bad Request. Input is invalid.
291
+ content :
292
+ application/json :
293
+ schema :
294
+ description : ' '
295
+ type : object
296
+ properties :
297
+ status :
298
+ type : number
299
+ title :
300
+ type : string
301
+ minLength : 1
302
+ type :
303
+ type : string
304
+ minLength : 1
305
+ detail :
306
+ type : string
307
+ minLength : 1
308
+ example :
309
+ status : 400
310
+ title : Input is invalid
311
+ type : ' https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes'
312
+ detail : Syntax error
313
+ ' 422 ' :
314
+ description : The request body does not meet the specification.
315
+ content :
316
+ application/json :
317
+ schema :
318
+ description : ' '
319
+ type : object
320
+ properties :
321
+ status :
322
+ type : number
323
+ title :
324
+ type : string
325
+ minLength : 1
326
+ type :
327
+ type : string
328
+ minLength : 1
329
+ example :
330
+ status : 422
331
+ title : Input is invalid
332
+ type : ' https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes'
333
+ summary : Update Shipping Settings per Channel
334
+ description : |-
335
+ Updates shipping settings for a specific channel.
336
+ tags :
337
+ - Shipping Settings
338
+ requestBody :
339
+ content :
340
+ application/json :
341
+ schema :
342
+ $ref : ' #/components/schemas/channelShippingSettings'
198
343
components :
199
344
parameters :
200
345
store_hash :
@@ -420,7 +565,17 @@ components:
420
565
- DISPLAY_ALL_COUNTRIES
421
566
- DISPLAY_ONLY_SHIPPABLE_COUNTRIES
422
567
example : DISPLAY_ALL_COUNTRIES
423
- out_of_zone_delivery_message :
568
+ out_of_delivery_zone_message :
569
+ description : Message shown to the shopper during checkout when their order does not meet the merchant's shipping criteria.
570
+ type : string
571
+ example : Unfortunately, one or more items in your cart can't be shipped to your location. Please choose a different delivery address.
572
+ channelShippingSettings :
573
+ type : object
574
+ properties :
575
+ checkout :
576
+ type : object
577
+ properties :
578
+ out_of_delivery_zone_message :
424
579
description : Message shown to the shopper during checkout when their order does not meet the merchant's shipping criteria.
425
580
type : string
426
581
example : Unfortunately, one or more items in your cart can't be shipped to your location. Please choose a different delivery address.
0 commit comments