Powered by Stoplight
get

/orders/{order-id}

Returns the details of an order.

Authorization

oauth2 - clientCredentials

Request Parameters

1 Path Parameter

Responses

1 Example
Schema
object
orderNumber
string

The automatically generated order number.

_links
object
taxModel
string

The tax model that applies for this order.

orderNote
string

A merchant comment or note on the order.

taxTotal
object
taxes
array[object]
productLineItems
array[object]
salesChannel
string

The sales channel for this order, such as an online shop, point of sale, or a retail store.

shippingStatus
string

The current shipping status of this order. Can be UNSHIPPED, PARTIALLY_SHIPPED, or SHIPPED.

createdAt
string

The date and time the order was technically created in the system. According to ISO 8601. Can deviate from entryDate, e.g. because the order was originally created earlier or in another system.

termsAndConditionsExplicitlyAccepted
boolean

Indicates if the customer explicitly accepted the shop’s terms and conditions before ordering. Can be true or false.

initialBalanceDue
object
initialGrandTotal
object
externalPaymentUri
string

The link to the payment in a payment provider’s administration if provided by the payment app.

externalPaymentId
string

The external payment reference if provided by the payment app.

totalRefunded
object
totalReceived
object
testOrder
boolean

Indicates if this order is a test order. Can be true or false.

currency
string

The currency in which the order was entered.

marketingChannel
string

The marketing channel for this order, such as a newsletter campaign, Google Shopping, or a Buy Button that’s implemented on a blog.

paymentStatus
string

The current status of the payment associated with this order. Can be PAID, PENDING, or REFUND_PENDING.

paymentLineItem
object
marketingSubchannel
string

The marketing subchannel for this order, such as a specific newsletter of a newsletter campaign, e.g. a Summer Sale that’s promoted on a blog, or a Winter Special that’s promoted on Facebook.

taxable
boolean

Indicates if a tax applies for this order. Can be true or false.

balanceDue
object
grandTotal
object
entryDate
string

The date and time of the actual creation of this order from a business perspective. Can deviate from createdAt.

cartId
string

The ID of the cart this order has been created from (if existing).

openAmount
object
canceled
boolean

The current cancelation status of this order. Can be true or false.

paymentNote
string

A prompt to pay the order which will be rendered in the invoice order document. Requires a payment reference and the merchant’s bank account details.

backgroundJobs
array

Pending processes initiated via the cockpit or the API that run in the background, e.g. rendering an invoice document.

initialNetTotal
object
shippingLineItem
object
subtotal
object
shippingAddress
object

The shipping address of the cart. Defaults to billing address if no shipping address is set. Refer to Set cart shipping address for item documentation.

billingAddress
object

The billing address of the cart. Refer to Set cart billing address for item documentation.

netTotal
object
_id
string

The unique identifier of the order.

initialSubtotal
object
initialTaxTotal
object

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
order-id
$$.env
2 variables not set
host
oauth_access_token