Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
3.0 KiB
displayed_sidebar
| displayed_sidebar |
|---|
| jsClientSidebar |
Class: AdminPostDraftOrdersDraftOrderReq
internal.internal.AdminPostDraftOrdersDraftOrderReq
Schema
AdminPostDraftOrdersDraftOrderReq 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: "#/components/schemas/AddressPayload" - type: string shipping_address: description: "The Address to be used for shipping purposes." anyOf: - $ref: "#/components/schemas/AddressPayload" - 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
Properties
billing_address
• Optional billing_address: string | AddressPayload
Defined in
packages/medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:116
country_code
• Optional country_code: string
Defined in
packages/medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:114
customer_id
• Optional customer_id: string
Defined in
packages/medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:119
discounts
• Optional discounts: Discount[]
Defined in
packages/medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:118
• Optional email: string
Defined in
packages/medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:115
no_notification_order
• Optional no_notification_order: boolean
Defined in
packages/medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:120
region_id
• Optional region_id: string
Defined in
packages/medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:113
shipping_address
• Optional shipping_address: string | AddressPayload
Defined in
packages/medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:117