Skip to content

Commit

Permalink
DEVDOCS-5706: [update] Orders V2, update order_source definition (#26)
Browse files Browse the repository at this point in the history
# [DEVDOCS-5706]

## What changed?
* update the `order_source` definition

## Release notes draft
* We've updated the definition of the order_source property in the Orders V2 API.

## Anything else?
* See Slack conversation: https://bigcommerce.slack.com/archives/C96P5T3J4/p1704292037915419

ping {names}


[DEVDOCS-5706]:
https://bigcommercecloud.atlassian.net/browse/DEVDOCS-5706?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
  • Loading branch information
bc-traciporter authored Jan 15, 2024
1 parent 5a7ed86 commit 9f06713
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions reference/orders.v2.oas2.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4080,8 +4080,14 @@ components:
example: false
type: boolean
order_source:
description: Orders submitted from the storeʼs website will include a `www` value. Orders submitted with the Checkout API will be set to `checkout_api`.
example: www, iPhone, Android, mobile, manual
description: |-
The `order_source` is set upon order creation and reflects the origin of the order. It will indicate whether the order was created by one of the following:
* storefront
* control panel
* manual order
* /v2/orders API
* Checkout API
* or by an integration with an external platform such as Facebook by Meta or Amazon.
type: string
consignments:
$ref: '#/components/schemas/orderConsignments_Resource'
Expand Down

0 comments on commit 9f06713

Please sign in to comment.