Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
46 lines
1.3 KiB
YAML
46 lines
1.3 KiB
YAML
type: object
|
|
properties:
|
|
region_id:
|
|
type: string
|
|
description: The ID of the Region to create the Draft Order in.
|
|
country_code:
|
|
type: string
|
|
description: The 2 character ISO code for the Country.
|
|
externalDocs:
|
|
url: >-
|
|
https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements
|
|
description: See a list of codes.
|
|
email:
|
|
type: string
|
|
description: An email to be used in the Draft Order.
|
|
format: email
|
|
billing_address:
|
|
description: The Address to be used for billing purposes.
|
|
anyOf:
|
|
- $ref: ./AddressPayload.yaml
|
|
- type: string
|
|
shipping_address:
|
|
description: The Address to be used for shipping purposes.
|
|
anyOf:
|
|
- $ref: ./AddressPayload.yaml
|
|
- type: string
|
|
discounts:
|
|
description: An array of Discount codes to add to the Draft Order.
|
|
type: array
|
|
items:
|
|
type: object
|
|
required:
|
|
- code
|
|
properties:
|
|
code:
|
|
description: The code that a Discount is identifed by.
|
|
type: string
|
|
no_notification_order:
|
|
description: >-
|
|
An optional flag passed to the resulting order that indicates whether the
|
|
customer should receive notifications about order updates.
|
|
type: boolean
|
|
customer_id:
|
|
description: The ID of the customer this draft order is associated with.
|
|
type: string
|