914d773d3a
* initialized next.js project * finished markdown sections * added operation schema component * change page metadata * eslint fixes * fixes related to deployment * added response schema * resolve max stack issue * support for different property types * added support for property types * added loading for components * added more loading * type fixes * added oneOf type * removed console * fix replace with push * refactored everything * use static content for description * fixes and improvements * added code examples section * fix path name * optimizations * fixed tag navigation * add support for admin and store references * general enhancements * optimizations and fixes * fixes and enhancements * added search bar * loading enhancements * added loading * added code blocks * added margin top * add empty response text * fixed oneOf parameters * added path and query parameters * general fixes * added base path env variable * small fix for arrays * enhancements * design enhancements * general enhancements * fix isRequired * added enum values * enhancements * general fixes * general fixes * changed oas generation script * additions to the introduction section * added copy button for code + other enhancements * fix response code block * fix metadata * formatted store introduction * move sidebar logic to Tags component * added test env variables * fix code block bug * added loading animation * added expand param + loading * enhance operation loading * made responsive + improvements * added loading provider * fixed loading * adjustments for small devices * added sidebar label for endpoints * added feedback component * fixed analytics * general fixes * listen to scroll for other headings * added sample env file * update api ref files + support new fields * fix for external docs link * added new sections * fix last item in sidebar not showing * move docs content to www/docs * change redirect url * revert change * resolve build errors * configure rewrites * changed to environment variable url * revert changing environment variable name * add environment variable for API path * fix links * fix tailwind settings * remove vercel file * reconfigured api route * move api page under api * fix page metadata * fix external link in navigation bar * update api spec * updated api specs * fixed google lint error * add max-height on request samples * add padding before loading * fix for one of name * fix undefined types * general fixes * remove response schema example * redesigned navigation bar * redesigned sidebar * fixed up paddings * added feedback component + report issue * fixed up typography, padding, and general styling * redesigned code blocks * optimization * added error timeout * fixes * added indexing with algolia + fixes * fix errors with algolia script * redesign operation sections * fix heading scroll * design fixes * fix padding * fix padding + scroll issues * fix scroll issues * improve scroll performance * fixes for safari * optimization and fixes * fixes to docs + details animation * padding fixes for code block * added tab animation * fixed incorrect link * added selection styling * fix lint errors * redesigned details component * added detailed feedback form * api reference fixes * fix tabs * upgrade + fixes * updated documentation links * optimizations to sidebar items * fix spacing in sidebar item * optimizations and fixes * fix endpoint path styling * remove margin * final fixes * change margin on small devices * generated OAS * fixes for mobile * added feedback modal * optimize dark mode button * fixed color mode useeffect * minimize dom size * use new style system * radius and spacing design system * design fixes * fix eslint errors * added meta files * change cron schedule * fix docusaurus configurations * added operating system to feedback data * change content directory name * fixes to contribution guidelines * revert renaming content * added api-reference to documentation workflow * fixes for search * added dark mode + fixes * oas fixes * handle bugs * added code examples for clients * changed tooltip text * change authentication to card * change page title based on selected section * redesigned mobile navbar * fix icon colors * fix key colors * fix medusa-js installation command * change external regex in algolia * change changeset * fix padding on mobile * fix hydration error * update depedencies
332 lines
8.7 KiB
YAML
332 lines
8.7 KiB
YAML
title: Order
|
|
description: >-
|
|
An order is a purchase made by a customer. It holds details about payment and
|
|
fulfillment of the order. An order may also be created from a draft order,
|
|
which is created by an admin user.
|
|
type: object
|
|
required:
|
|
- billing_address_id
|
|
- canceled_at
|
|
- cart_id
|
|
- created_at
|
|
- currency_code
|
|
- customer_id
|
|
- draft_order_id
|
|
- display_id
|
|
- email
|
|
- external_id
|
|
- fulfillment_status
|
|
- id
|
|
- idempotency_key
|
|
- metadata
|
|
- no_notification
|
|
- object
|
|
- payment_status
|
|
- region_id
|
|
- shipping_address_id
|
|
- status
|
|
- tax_rate
|
|
- updated_at
|
|
properties:
|
|
id:
|
|
description: The order's ID
|
|
type: string
|
|
example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
|
|
status:
|
|
description: The order's status
|
|
type: string
|
|
enum:
|
|
- pending
|
|
- completed
|
|
- archived
|
|
- canceled
|
|
- requires_action
|
|
default: pending
|
|
fulfillment_status:
|
|
description: The order's fulfillment status
|
|
type: string
|
|
enum:
|
|
- not_fulfilled
|
|
- partially_fulfilled
|
|
- fulfilled
|
|
- partially_shipped
|
|
- shipped
|
|
- partially_returned
|
|
- returned
|
|
- canceled
|
|
- requires_action
|
|
default: not_fulfilled
|
|
payment_status:
|
|
description: The order's payment status
|
|
type: string
|
|
enum:
|
|
- not_paid
|
|
- awaiting
|
|
- captured
|
|
- partially_refunded
|
|
- refunded
|
|
- canceled
|
|
- requires_action
|
|
default: not_paid
|
|
display_id:
|
|
description: The order's display ID
|
|
type: integer
|
|
example: 2
|
|
cart_id:
|
|
description: The ID of the cart associated with the order
|
|
nullable: true
|
|
type: string
|
|
example: cart_01G8ZH853Y6TFXWPG5EYE81X63
|
|
cart:
|
|
description: The details of the cart associated with the order.
|
|
x-expandable: cart
|
|
nullable: true
|
|
type: object
|
|
customer_id:
|
|
description: The ID of the customer associated with the order
|
|
type: string
|
|
example: cus_01G2SG30J8C85S4A5CHM2S1NS2
|
|
customer:
|
|
description: The details of the customer associated with the order.
|
|
x-expandable: customer
|
|
nullable: true
|
|
type: object
|
|
email:
|
|
description: The email associated with the order
|
|
type: string
|
|
format: email
|
|
billing_address_id:
|
|
description: The ID of the billing address associated with the order
|
|
nullable: true
|
|
type: string
|
|
example: addr_01G8ZH853YPY9B94857DY91YGW
|
|
billing_address:
|
|
description: The details of the billing address associated with the order.
|
|
x-expandable: billing_address
|
|
nullable: true
|
|
$ref: ./Address.yaml
|
|
shipping_address_id:
|
|
description: The ID of the shipping address associated with the order
|
|
nullable: true
|
|
type: string
|
|
example: addr_01G8ZH853YPY9B94857DY91YGW
|
|
shipping_address:
|
|
description: The details of the shipping address associated with the order.
|
|
x-expandable: shipping_address
|
|
nullable: true
|
|
$ref: ./Address.yaml
|
|
region_id:
|
|
description: The ID of the region this order was created in.
|
|
type: string
|
|
example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
|
|
region:
|
|
description: The details of the region this order was created in.
|
|
x-expandable: region
|
|
nullable: true
|
|
$ref: ./Region.yaml
|
|
currency_code:
|
|
description: The 3 character currency code that is used in the order
|
|
type: string
|
|
example: usd
|
|
externalDocs:
|
|
url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
|
|
description: See a list of codes.
|
|
currency:
|
|
description: The details of the currency used in the order.
|
|
x-expandable: currency
|
|
nullable: true
|
|
$ref: ./Currency.yaml
|
|
tax_rate:
|
|
description: The order's tax rate
|
|
nullable: true
|
|
type: number
|
|
example: 0
|
|
discounts:
|
|
description: The details of the discounts applied on the order.
|
|
type: array
|
|
x-expandable: discounts
|
|
items:
|
|
$ref: ./Discount.yaml
|
|
gift_cards:
|
|
description: The details of the gift card used in the order.
|
|
type: array
|
|
x-expandable: gift_cards
|
|
items:
|
|
$ref: ./GiftCard.yaml
|
|
shipping_methods:
|
|
description: The details of the shipping methods used in the order.
|
|
type: array
|
|
x-expandable: shipping_methods
|
|
items:
|
|
$ref: ./ShippingMethod.yaml
|
|
payments:
|
|
description: The details of the payments used in the order.
|
|
type: array
|
|
x-expandable: payments
|
|
items:
|
|
type: object
|
|
fulfillments:
|
|
description: The details of the fulfillments created for the order.
|
|
type: array
|
|
x-expandable: fulfillments
|
|
items:
|
|
type: object
|
|
returns:
|
|
description: The details of the returns created for the order.
|
|
type: array
|
|
x-expandable: returns
|
|
items:
|
|
type: object
|
|
claims:
|
|
description: The details of the claims created for the order.
|
|
type: array
|
|
x-expandable: claims
|
|
items:
|
|
type: object
|
|
refunds:
|
|
description: The details of the refunds created for the order.
|
|
type: array
|
|
x-expandable: refunds
|
|
items:
|
|
type: object
|
|
swaps:
|
|
description: The details of the swaps created for the order.
|
|
type: array
|
|
x-expandable: swaps
|
|
items:
|
|
type: object
|
|
draft_order_id:
|
|
description: The ID of the draft order this order was created from.
|
|
nullable: true
|
|
type: string
|
|
example: null
|
|
draft_order:
|
|
description: The details of the draft order this order was created from.
|
|
x-expandable: draft_order
|
|
nullable: true
|
|
type: object
|
|
items:
|
|
description: The details of the line items that belong to the order.
|
|
x-expandable: items
|
|
type: array
|
|
items:
|
|
$ref: ./LineItem.yaml
|
|
edits:
|
|
description: The details of the order edits done on the order.
|
|
type: array
|
|
x-expandable: edits
|
|
items:
|
|
type: object
|
|
gift_card_transactions:
|
|
description: The gift card transactions made in the order.
|
|
type: array
|
|
x-expandable: gift_card_transactions
|
|
items:
|
|
$ref: ./GiftCardTransaction.yaml
|
|
canceled_at:
|
|
description: The date the order was canceled on.
|
|
nullable: true
|
|
type: string
|
|
format: date-time
|
|
no_notification:
|
|
description: >-
|
|
Flag for describing whether or not notifications related to this should be
|
|
send.
|
|
nullable: true
|
|
type: boolean
|
|
example: false
|
|
idempotency_key:
|
|
description: >-
|
|
Randomly generated key used to continue the processing of the order in
|
|
case of failure.
|
|
nullable: true
|
|
type: string
|
|
externalDocs:
|
|
url: https://docs.medusajs.com/development/idempotency-key/overview.md
|
|
description: Learn more how to use the idempotency key.
|
|
external_id:
|
|
description: The ID of an external order.
|
|
nullable: true
|
|
type: string
|
|
example: null
|
|
sales_channel_id:
|
|
description: The ID of the sales channel this order belongs to.
|
|
nullable: true
|
|
type: string
|
|
example: null
|
|
sales_channel:
|
|
description: The details of the sales channel this order belongs to.
|
|
x-expandable: sales_channel
|
|
nullable: true
|
|
$ref: ./SalesChannel.yaml
|
|
shipping_total:
|
|
type: integer
|
|
description: The total of shipping
|
|
example: 1000
|
|
raw_discount_total:
|
|
description: The total of discount
|
|
type: integer
|
|
example: 800
|
|
discount_total:
|
|
description: The total of discount rounded
|
|
type: integer
|
|
example: 800
|
|
tax_total:
|
|
description: The total of tax
|
|
type: integer
|
|
example: 0
|
|
refunded_total:
|
|
description: The total amount refunded if the order is returned.
|
|
type: integer
|
|
example: 0
|
|
total:
|
|
description: The total amount of the order
|
|
type: integer
|
|
example: 8200
|
|
subtotal:
|
|
description: The subtotal of the order
|
|
type: integer
|
|
example: 8000
|
|
paid_total:
|
|
description: The total amount paid
|
|
type: integer
|
|
example: 8000
|
|
refundable_amount:
|
|
description: The amount that can be refunded
|
|
type: integer
|
|
example: 8200
|
|
gift_card_total:
|
|
description: The total of gift cards
|
|
type: integer
|
|
example: 0
|
|
gift_card_tax_total:
|
|
description: The total of gift cards with taxes
|
|
type: integer
|
|
example: 0
|
|
returnable_items:
|
|
description: >-
|
|
The details of the line items that are returnable as part of the order,
|
|
swaps, or claims
|
|
type: array
|
|
x-expandable: returnable_items
|
|
items:
|
|
$ref: ./LineItem.yaml
|
|
created_at:
|
|
description: The date with timezone at which the resource was created.
|
|
type: string
|
|
format: date-time
|
|
updated_at:
|
|
description: The date with timezone at which the resource was updated.
|
|
type: string
|
|
format: date-time
|
|
metadata:
|
|
description: An optional key-value map with additional details
|
|
nullable: true
|
|
type: object
|
|
example:
|
|
car: white
|
|
externalDocs:
|
|
description: Learn about the metadata attribute, and how to delete and update it.
|
|
url: >-
|
|
https://docs.medusajs.com/development/entities/overview#metadata-attribute
|