diff --git a/reference/shipping.v3.yml b/reference/shipping.v3.yml index 615176e50..4f7be92a3 100644 --- a/reference/shipping.v3.yml +++ b/reference/shipping.v3.yml @@ -10,7 +10,8 @@ info: email: support@bigcommerce.com tags: - name: Customs Information - - name: Shipping Settings + - name: Global Shipping Settings + - name: Channel Specific Shipping Settings security: - X-Auth-Token: [] servers: @@ -164,10 +165,10 @@ paths: type: object properties: {} description: |- - Get shipping settings. + Get global shipping settings. tags: - - Shipping Settings - summary: Get Shipping Settings + - Global Shipping Settings + summary: Get Global Shipping Settings put: operationId: updateShippingSettings parameters: @@ -185,16 +186,161 @@ paths: meta: type: object properties: {} - summary: Update Shipping Settings + '400': + description: Bad Request. Input is invalid. + content: + application/json: + schema: + description: '' + type: object + properties: + status: + type: number + title: + type: string + minLength: 1 + type: + type: string + minLength: 1 + detail: + type: string + minLength: 1 + example: + status: 400 + title: Input is invalid + type: 'https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes' + detail: Syntax error + '422': + description: The request body does not meet the specification. + content: + application/json: + schema: + description: '' + type: object + properties: + status: + type: number + title: + type: string + minLength: 1 + type: + type: string + minLength: 1 + example: + status: 422 + title: Input is invalid + type: 'https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes' + summary: Update Global Shipping Settings description: |- - Updates shipping settings. + Updates global shipping settings. tags: - - Shipping Settings + - Global Shipping Settings requestBody: content: application/json: schema: $ref: '#/components/schemas/shippingSettings' + '/shipping/settings/channels/{channel_id}': + parameters: + - $ref: '#/components/parameters/Accept' + - name: channel_id + in: path + schema: + type: string + description: Channel ID + required: true + + get: + operationId: getChannelShippingSettings + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + data: + $ref: '#/components/schemas/channelShippingSettings' + meta: + type: object + properties: {} + description: |- + Get shipping settings for a specific channel. + tags: + - Channel Specific Shipping Settings + summary: Get Channel Specific Shipping Settings + put: + operationId: updateChannelShippingSettings + parameters: + - $ref: '#/components/parameters/ContentType' + responses: + '200': + description: '' + content: + application/json: + schema: + type: object + properties: + data: + $ref: '#/components/schemas/channelShippingSettings' + meta: + type: object + properties: {} + '400': + description: Bad Request. Input is invalid. + content: + application/json: + schema: + description: '' + type: object + properties: + status: + type: number + title: + type: string + minLength: 1 + type: + type: string + minLength: 1 + detail: + type: string + minLength: 1 + example: + status: 400 + title: Input is invalid + type: 'https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes' + detail: Syntax error + '422': + description: The request body does not meet the specification. + content: + application/json: + schema: + description: '' + type: object + properties: + status: + type: number + title: + type: string + minLength: 1 + type: + type: string + minLength: 1 + example: + status: 422 + title: Input is invalid + type: 'https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes' + summary: Update Channel Specific Shipping Settings + description: |- + Update shipping settings for a specific channel. + tags: + - Channel Specific Shipping Settings + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/channelShippingSettings' components: parameters: store_hash: @@ -420,7 +566,17 @@ components: - DISPLAY_ALL_COUNTRIES - DISPLAY_ONLY_SHIPPABLE_COUNTRIES example: DISPLAY_ALL_COUNTRIES - out_of_zone_delivery_message: + out_of_delivery_zone_message: + description: Message shown to the shopper during checkout when their order does not meet the merchant's shipping criteria. + type: string + example: Unfortunately, one or more items in your cart can't be shipped to your location. Please choose a different delivery address. + channelShippingSettings: + type: object + properties: + checkout: + type: object + properties: + out_of_delivery_zone_message: description: Message shown to the shopper during checkout when their order does not meet the merchant's shipping criteria. type: string example: Unfortunately, one or more items in your cart can't be shipped to your location. Please choose a different delivery address.