Get order
Get the order identified by the specified slug.
Authorizations
API key used to authenticate and authorise every request.
Include it in the x-api-key header.
Headers
Defines the response type.
application/vnd.Creative Force.v2.3+json, application/vnd.Creative Force.v2.3+xml Defines the languages included in the response. If non are provided, the account default language is returned.
Value all overrides any other values present.
You can request multiple languages using a comma-separated string of languages.
The selected language must be supported by your account or a 400 error is returned.
all, ar_AR, bg_BG, bn_IN, ca_ES, cs_CZ, cy_GB, da_DK, de_DE, en_GB, en_US, el_GR, es_NN, es_LA, et_EE, fa_NN, fi_FI, fr_FR, fr_CA, he_IL, hi_IN, hr_HR, hu_HU, hy_AM, it_IT, ja_JP, ko_KR, lt_LT, ms_MY, nl_NL, nb_NO, pl_PL, pt_BR, ro_RO, ru_RU, sk_SK, sl_SI, sq_AL, sr_RS, sv_SE, sw_NN, th_TH, tr_TR, uk_UA, vi_VN, zh_CN, zh_HK Path Parameters
Slug of the order.
^[A-Za-z]{8}$Response
Order retrieved.
Order recording a purchase made on the account.
Billing street address supplied for the order.
Billing city supplied for the order.
Free-text comments recorded against the order.
Billing company name supplied for the order.
Billing country supplied for the order.
Date and time when the order was created, in ISO 8601 format.
Currency the order amounts are denominated in, as an ISO 4217 code.
Total discount applied to the order, in the order currency.
Discount code applied to the order, empty when none applied.
Electronic invoicing status of the order.
Invoice number assigned to the order.
IP address the order was placed from.
HTML-formatted summary of the line items for the order.
Structured list of the line items for the order.
Membership number recorded against the order.
Method used to pay for the order.
Payment status of the order.
Billing postcode supplied for the order.
Processing fee charged on the order, in the order currency.
Rate used to calculate the processing fee, as a percentage, or null if none applies.
Billing region supplied for the order.
Season the order was placed in.
Short URL-safe identifier for the order.
Billing state supplied for the order.
Order subtotal before tax and fees, in the order currency.
Total tax charged on the order, in the order currency.
Rate used to calculate tax, as a percentage, or null if none applies.
Details of the tax rate applied to the order.
Display term used for tax on the order, such as VAT or GST.
Order total including tax and fees, in the order currency.
Date and time when the payment transaction occurred, in ISO 8601 format, or null if none recorded.
Payment provider that processed the transaction.
Reference assigned to the transaction by the payment provider.
Status of the payment transaction.
User who placed the order.
VAT number supplied for the order.