Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(shipping): SHIPPING-3338 Publish documentation for v3 channel based out of zone delivery message #834

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+158 −3
Open

chore(shipping): SHIPPING-3338 Publish documentation for v3 channel based out of zone delivery message #834

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
161 changes: 158 additions & 3 deletions reference/shipping.v3.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ paths:
type: object
properties: {}
description: |-
Get shipping settings.
Returns the global-level shipping settings.
tags:
- Shipping Settings
summary: Get Shipping Settings
Expand All @@ -185,16 +185,161 @@ paths:
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 Shipping Settings
description: |-
Updates shipping settings.
Updates the global-level shipping settings.
tags:
- 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: |-
Returns shipping settings for a specific channel.
tags:
- Shipping Settings
summary: Get Shipping Settings per Channel
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 Shipping Settings per Channel
description: |-
Updates shipping settings for a specific channel.
tags:
- Shipping Settings
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/channelShippingSettings'
components:
parameters:
store_hash:
Expand Down Expand Up @@ -420,7 +565,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.
Expand Down