Skip to main content
File PrefixSPECIAL-ORDERS
Current VersionV2
Special Order data represent the top level information associated with a special order. It captures its basic information, who, what and represents the definitive order status.
AttributeFormatLengthRequiredDescriptionExample
order_refAlphanumeric3-255YesUnique special order reference descriptor103495
shopper_idAlphanumeric1-255YesShopper who placed the orderSHOPPER-1
store_idAlphanumeric1-255YesStore where order was placedSTORE-1
sales_associate_idAlphanumeric1-255YesSales associate responsible for the orderSALES_ASSOCIATE-1
descriptionAlphanumeric65535NoDetailed description for order
total_amountNumeric1-255NoTotal order amount456.39
currency_codeAlphanumeric3Yes (when total amount present)CurrencyUSD
created_atDatetime ISO 860110YesDate and time the order occurred2022-01-17T19:23:22Z
typeEnum [back_order | custom | repair]YesDetermine what type of special order this isrepair
statusEnum [open | closed | partial | cancelled]YesStatus of the orderopen

Special Order Type

Type allows filtering of special orders in the UI.

Special Order Status

Determine what state the order is in.