Documentation Index
Fetch the complete documentation index at: https://developers.bspk.com/llms.txt
Use this file to discover all available pages before exploring further.
| File Prefix | SPECIAL-ORDERS |
| Current Version | V2 |
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.
| Attribute | Format | Length | Required | Description | Example |
| order_ref | Alphanumeric | 3-255 | Yes | Unique special order reference descriptor | 103495 |
| shopper_id | Alphanumeric | 1-255 | Yes | Shopper who placed the order | SHOPPER-1 |
| store_id | Alphanumeric | 1-255 | Yes | Store where order was placed | STORE-1 |
| sales_associate_id | Alphanumeric | 1-255 | Yes | Sales associate responsible for the order | SALES_ASSOCIATE-1 |
| description | Alphanumeric | 65535 | No | Detailed description for order | |
| total_amount | Numeric | 1-255 | No | Total order amount | 456.39 |
| currency_code | Alphanumeric | 3 | Yes (when total amount present) | Currency | USD |
| created_at | Datetime ISO 8601 | 10 | Yes | Date and time the order occurred | 2022-01-17T19:23:22Z |
| type | Enum [back_order | custom | repair] | | Yes | Determine what type of special order this is | repair |
| status | Enum [open | closed | partial | cancelled] | | Yes | Status of the order | open |
Special Order Type
Type allows filtering of special orders in the UI.
| Type | Description |
|---|
| custom | Represent a custom made product order |
| repair | The order is tracking a repair on a previously purchased item |
| back_order | Order for a product that is temporarily out of stock |
Special Order Status
Determine what state the order is in.
| Status | Description |
|---|
| open | All line items are waiting to be fulfilled |
| partial | Some line items have been fulfilled |
| closed | Order is completed |
| cancelled | Order has been cancelled |
