> For the complete documentation index, see [llms.txt](https://docs.liquidcommerce.cloud/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.liquidcommerce.cloud/types/order.md).

# Order

The Order object represents the complete structure of an order in the LiquidCommerce system. It contains comprehensive information about the order including customer details, addresses, items, retailers, fulfillment details, and financial information.

### Core Order Properties

<table><thead><tr><th width="183.40945434570312">Property</th><th width="207.79327392578125">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>referenceId</code></td><td><mark style="color:blue;"><strong>string | null</strong></mark></td><td>Optional order reference ID</td></tr><tr><td><code>legacyOrderNumber</code></td><td><mark style="color:blue;"><strong>string | null</strong></mark></td><td>Optional legacy order number for backward compatibility</td></tr><tr><td><code>partnerId</code></td><td><mark style="color:blue;"><strong>string</strong></mark></td><td>Partner ID associated with the order</td></tr><tr><td><code>legacyStorefrontId</code></td><td><mark style="color:blue;"><strong>number | null</strong></mark></td><td>Legacy Partner ID</td></tr><tr><td><code>partnerName</code></td><td><mark style="color:blue;"><strong>string</strong></mark></td><td>Partner name associated to the order</td></tr><tr><td><code>promoCode</code></td><td><mark style="color:blue;"><strong>string | null</strong></mark></td><td>The promotional code value for the order</td></tr><tr><td><code>isHybrid</code></td><td><mark style="color:blue;"><strong>boolean</strong></mark></td><td>Indicates if this is a hybrid order</td></tr><tr><td><code>createdAt</code></td><td><mark style="color:blue;"><strong>string</strong></mark></td><td>Order creation date in ISO format</td></tr><tr><td><code>updatedAt</code></td><td><mark style="color:blue;"><strong>string</strong></mark></td><td>Order last update date in ISO format</td></tr><tr><td><code>customer</code></td><td><a href="#customer-information"><mark style="color:blue;"><strong>OrderCustomer</strong></mark></a></td><td>Customer information</td></tr><tr><td><code>addresses</code></td><td><a href="#address-information"><mark style="color:blue;"><strong>OrderAddresses</strong></mark></a></td><td>Order addresses (shipping and billing)</td></tr><tr><td><code>options</code></td><td><a href="#order-options"><mark style="color:blue;"><strong>OrderOptions</strong></mark></a></td><td>Order options including gift details and preferences</td></tr><tr><td><code>paymentMethods</code></td><td><mark style="color:purple;"><strong>Array&#x3C;</strong></mark><a href="#payment-methods"><mark style="color:blue;"><strong>PaymentMethods</strong></mark></a><mark style="color:purple;"><strong>></strong></mark></td><td>Order payment methods information</td></tr><tr><td><code>amounts</code></td><td><a href="#order-amounts"><mark style="color:blue;"><strong>OrderAmounts</strong></mark></a></td><td>Order amount details including subtotal, taxes, fees, etc.</td></tr><tr><td><code>retailers</code></td><td><mark style="color:purple;"><strong>Array&#x3C;</strong></mark><a href="#retailer-information"><mark style="color:blue;"><strong>OrderRetailer</strong></mark></a><mark style="color:purple;"><strong>></strong></mark></td><td>Order retailers information</td></tr><tr><td><code>items</code></td><td><mark style="color:purple;"><strong>Array&#x3C;</strong></mark><a href="#order-item"><mark style="color:blue;"><strong>OrderItem</strong></mark></a><mark style="color:purple;"><strong>></strong></mark></td><td>Order items details</td></tr></tbody></table>

### Customer Information

Represents customer details associated with the order.

| Property    | Type                                                | Description                             |
| ----------- | --------------------------------------------------- | --------------------------------------- |
| `id`        | <mark style="color:blue;">**string**</mark>         | Customer ID                             |
| `firstName` | <mark style="color:blue;">**string \| null**</mark> | Customer first name                     |
| `lastName`  | <mark style="color:blue;">**string \| null**</mark> | Customer last name                      |
| `email`     | <mark style="color:blue;">**string**</mark>         | Customer email                          |
| `phone`     | <mark style="color:blue;">**string \| null**</mark> | Customer phone                          |
| `birthdate` | <mark style="color:blue;">**string \| null**</mark> | Customer birthdate in YYYY-MM-DD format |

### Address Information

#### Basic Address

| Property  | Type                                                | Description    |
| --------- | --------------------------------------------------- | -------------- |
| `one`     | <mark style="color:blue;">**string**</mark>         | Address line 1 |
| `two`     | <mark style="color:blue;">**string \| null**</mark> | Address line 2 |
| `city`    | <mark style="color:blue;">**string**</mark>         | City           |
| `state`   | <mark style="color:blue;">**string**</mark>         | State          |
| `zip`     | <mark style="color:blue;">**string**</mark>         | Zip code       |
| `country` | <mark style="color:blue;">**string**</mark>         | Country        |

#### Full Address

Extends the basic address with additional fields.

| Additional Property | Type                                                | Description        |
| ------------------- | --------------------------------------------------- | ------------------ |
| `firstName`         | <mark style="color:blue;">**string \| null**</mark> | Billing first name |
| `lastName`          | <mark style="color:blue;">**string \| null**</mark> | Billing last name  |
| `email`             | <mark style="color:blue;">**string**</mark>         | Billing email      |
| `phone`             | <mark style="color:blue;">**string \| null**</mark> | Billing phone      |
| `company`           | <mark style="color:blue;">**string \| null**</mark> | Billing company    |

#### Addresses Container

| Property   | Type                                                              | Description      |
| ---------- | ----------------------------------------------------------------- | ---------------- |
| `shipping` | [<mark style="color:blue;">**FullAddress**</mark>](#full-address) | Shipping address |
| `billing`  | [<mark style="color:blue;">**FullAddress**</mark>](#full-address) | Billing address  |

### Order Options

Represents various order preferences and settings.

<table><thead><tr><th width="216.58782958984375">Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>isGift</code></td><td><mark style="color:blue;"><strong>boolean</strong></mark></td><td>Is this order a gift</td></tr><tr><td><code>giftMessage</code></td><td><mark style="color:blue;"><strong>string | null</strong></mark></td><td>Gift message</td></tr><tr><td><code>giftRecipient</code></td><td><a href="#gift-recipient"><mark style="color:blue;"><strong>GiftRecipient</strong></mark></a></td><td>Gift recipient information</td></tr><tr><td><code>hasVerifiedAge</code></td><td><mark style="color:blue;"><strong>boolean</strong></mark></td><td>Has the customer verified their age</td></tr><tr><td><code>allowsSubstitution</code></td><td><mark style="color:blue;"><strong>boolean</strong></mark></td><td>Does the customer allow product substitution</td></tr><tr><td><code>billingSameAsShipping</code></td><td><mark style="color:blue;"><strong>boolean</strong></mark></td><td>Is billing address same as shipping address</td></tr><tr><td><code>deliveryInstructions</code></td><td><mark style="color:blue;"><strong>string | null</strong></mark></td><td>Delivery instructions</td></tr><tr><td><code>marketingPreferences</code></td><td><a href="#marketing-preferences"><mark style="color:blue;"><strong>MarketingPreferences</strong></mark></a></td><td>Marketing preferences</td></tr></tbody></table>

#### Gift Recipient

| Property | Type                                                | Description          |
| -------- | --------------------------------------------------- | -------------------- |
| `name`   | <mark style="color:blue;">**string \| null**</mark> | Gift recipient name  |
| `email`  | <mark style="color:blue;">**string \| null**</mark> | Gift recipient email |
| `phone`  | <mark style="color:blue;">**string \| null**</mark> | Gift recipient phone |

#### Marketing Preferences

| Property | Type                                         | Description                |
| -------- | -------------------------------------------- | -------------------------- |
| `email`  | <mark style="color:blue;">**boolean**</mark> | Email marketing preference |
| `sms`    | <mark style="color:blue;">**boolean**</mark> | SMS marketing preference   |

### Order Amounts

Detailed financial information for the order.

<table><thead><tr><th width="172.58071899414062">Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>subtotal</code></td><td><mark style="color:blue;"><strong>number</strong></mark></td><td>Order subtotal</td></tr><tr><td><code>shipping</code></td><td><mark style="color:blue;"><strong>number</strong></mark></td><td>Shipping cost</td></tr><tr><td><code>platform</code></td><td><mark style="color:blue;"><strong>number</strong></mark></td><td>Platform fee</td></tr><tr><td><code>tax</code></td><td><mark style="color:blue;"><strong>number</strong></mark></td><td>Tax amount</td></tr><tr><td><code>engraving</code></td><td><mark style="color:blue;"><strong>number</strong></mark></td><td>Engraving cost</td></tr><tr><td><code>service</code></td><td><mark style="color:blue;"><strong>number</strong></mark></td><td>Service fee</td></tr><tr><td><code>delivery</code></td><td><mark style="color:blue;"><strong>number</strong></mark></td><td>Delivery fee</td></tr><tr><td><code>discounts</code></td><td><mark style="color:blue;"><strong>number</strong></mark></td><td>Total discounts</td></tr><tr><td><code>giftCards</code></td><td><mark style="color:blue;"><strong>number</strong></mark></td><td>Gift cards amount applied</td></tr><tr><td><code>tip</code></td><td><mark style="color:blue;"><strong>number</strong></mark></td><td>Tip amount</td></tr><tr><td><code>total</code></td><td><mark style="color:blue;"><strong>number</strong></mark></td><td>Order total</td></tr><tr><td><code>taxDetails</code></td><td><a href="#tax-details"><mark style="color:blue;"><strong>TaxDetails</strong></mark></a></td><td>Tax details</td></tr><tr><td><code>discountDetails</code></td><td><a href="#discount-details"><mark style="color:blue;"><strong>DiscountDetails</strong></mark></a></td><td>Discount details</td></tr></tbody></table>

#### Tax Details

| Property         | Type                                        | Description         |
| ---------------- | ------------------------------------------- | ------------------- |
| `products`       | <mark style="color:blue;">**number**</mark> | Product tax         |
| `shipping`       | <mark style="color:blue;">**number**</mark> | Shipping tax        |
| `delivery`       | <mark style="color:blue;">**number**</mark> | Delivery tax        |
| `bag`            | <mark style="color:blue;">**number**</mark> | Bag tax             |
| `bottleDeposits` | <mark style="color:blue;">**number**</mark> | Bottle deposits tax |
| `retailDelivery` | <mark style="color:blue;">**number**</mark> | Retail delivery tax |

#### Discount Details

| Property    | Type                                        | Description         |
| ----------- | ------------------------------------------- | ------------------- |
| `products`  | <mark style="color:blue;">**number**</mark> | Product discounts   |
| `shipping`  | <mark style="color:blue;">**number**</mark> | Shipping discounts  |
| `delivery`  | <mark style="color:blue;">**number**</mark> | Delivery discounts  |
| `engraving` | <mark style="color:blue;">**number**</mark> | Engraving discounts |
| `service`   | <mark style="color:blue;">**number**</mark> | Service discounts   |

### Payment Methods

| Property | Type                                                | Description                                     |
| -------- | --------------------------------------------------- | ----------------------------------------------- |
| `type`   | <mark style="color:blue;">**string \| null**</mark> | Payment type, ex: CREDIT\_CARD, GIFT\_CARD, etc |
| `card`   | <mark style="color:blue;">**string \| null**</mark> | Card type                                       |
| `last4`  | <mark style="color:blue;">**string \| null**</mark> | Card last 4 digits                              |
| `holder` | <mark style="color:blue;">**string \| null**</mark> | Card holder                                     |
| `code`   | <mark style="color:blue;">**string \| null**</mark> | Gift card code                                  |

### Retailer Information

Represents retailers associated with the order.

<table><thead><tr><th width="206.6484375">Property</th><th width="360.2298583984375">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>id</code></td><td><mark style="color:blue;"><strong>string</strong></mark></td><td>Retailer ID</td></tr><tr><td><code>legacyId</code></td><td><mark style="color:blue;"><strong>string | null</strong></mark></td><td>Retailer legacy ID</td></tr><tr><td><code>tdLinx</code></td><td><mark style="color:blue;"><strong>string | null</strong></mark></td><td>Used for tracking store-level performance.</td></tr><tr><td><code>name</code></td><td><mark style="color:blue;"><strong>string</strong></mark></td><td>Retailer name</td></tr><tr><td><code>system</code></td><td><a href="#order-system"><mark style="color:blue;"><strong>ENUM_ORDER_SYSTEM</strong></mark></a></td><td>Order system type</td></tr><tr><td><code>timezone</code></td><td><mark style="color:blue;"><strong>string</strong></mark></td><td>Retailer IANA timezone</td></tr><tr><td><code>address</code></td><td><a href="#retailer-address"><mark style="color:blue;"><strong>RetailerAddress</strong></mark></a></td><td>Retailer address</td></tr><tr><td><code>amounts</code></td><td><a href="#order-amounts"><mark style="color:blue;"><strong>Amounts</strong></mark></a></td><td>Retailer amounts</td></tr><tr><td><code>fulfillments</code></td><td><mark style="color:purple;"><strong>Array&#x3C;</strong></mark><a href="#fulfillment-information"><mark style="color:blue;"><strong>Fulfillment</strong></mark></a><mark style="color:purple;"><strong>></strong></mark></td><td>Retailer fulfillments</td></tr></tbody></table>

#### Retailer Address

Extends the basic address with two properties for coordinates.

| Property    | Type                                                | Description          |
| ----------- | --------------------------------------------------- | -------------------- |
| `latitude`  | <mark style="color:blue;">**number \| null**</mark> | Latitude coordinate  |
| `longitude` | <mark style="color:blue;">**number \| null**</mark> | Longitude coordinate |

### Fulfillment Information

Represents order fulfillment details.

<table><thead><tr><th width="217.0941162109375">Property</th><th width="233.6739501953125">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>id</code></td><td><mark style="color:blue;"><strong>string</strong></mark></td><td>Fulfillment ID</td></tr><tr><td><code>type</code></td><td><a href="#enums"><mark style="color:blue;"><strong>ENUM_ORDER_FULFILLMENT_TYPE</strong></mark></a></td><td>Fulfillment type</td></tr><tr><td><code>status</code></td><td><a href="#enums"><mark style="color:blue;"><strong>ENUM_ORDER_STATUS</strong></mark></a></td><td>Fulfillment status</td></tr><tr><td><code>scheduledFor</code></td><td><mark style="color:blue;"><strong>string | null</strong></mark></td><td>Scheduled date in ISO format</td></tr><tr><td><code>updatedAt</code></td><td><mark style="color:blue;"><strong>string</strong></mark></td><td>Last updated date in ISO format</td></tr><tr><td><code>itemIds</code></td><td><mark style="color:purple;"><strong>Array&#x3C;</strong><strong>string</strong><strong>></strong></mark></td><td>IDs of items in this fulfillment</td></tr><tr><td><code>cancellation</code></td><td><a href="#fulfillment-cancellation"><mark style="color:blue;"><strong>FulfillmentCancellation</strong></mark></a></td><td>Cancellation information</td></tr><tr><td><code>expectationFormatted</code></td><td><a href="#fulfillment-expectation-formatted"><mark style="color:blue;"><strong>FulfillmentExpectationFormatted</strong></mark></a></td><td>Delivery expectation formatted</td></tr><tr><td><code>packages</code></td><td><mark style="color:purple;"><strong>Array&#x3C;</strong></mark><a href="#fulfillment-package"><mark style="color:blue;"><strong>FulfillmentPackage</strong></mark></a><mark style="color:purple;"><strong>></strong></mark></td><td>Packages for this fulfillment</td></tr><tr><td><code>timeline</code></td><td><mark style="color:purple;"><strong>Array&#x3C;</strong></mark><a href="#fulfillment-timeline"><mark style="color:blue;"><strong>FulfillmentTimeline</strong></mark></a><mark style="color:purple;"><strong>></strong></mark></td><td>Fulfillment timeline</td></tr></tbody></table>

#### Fulfillment Cancellation <a href="#fulfillment-cancellation" id="fulfillment-cancellation"></a>

<table><thead><tr><th width="161.64862060546875">Property</th><th width="153.25390625">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>category</code></td><td><mark style="color:blue;"><strong>string</strong></mark></td><td>Category of cancellation</td></tr><tr><td><code>subcategory</code></td><td><mark style="color:blue;"><strong>string | null</strong></mark></td><td>Subcategory of cancellation</td></tr><tr><td><code>notes</code></td><td><mark style="color:blue;"><strong>string | null</strong></mark></td><td>Specific note left for this cancellation</td></tr></tbody></table>

#### Fulfillment Expectation Formatted <a href="#fulfillment-expectation-formatted" id="fulfillment-expectation-formatted"></a>

<table><thead><tr><th width="161.64862060546875">Property</th><th width="153.25390625">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>detail</code></td><td><mark style="color:blue;"><strong>string</strong></mark></td><td>Estimated delivery of a shipping or on-demand fulfillment</td></tr><tr><td><code>engraving</code></td><td><mark style="color:blue;"><strong>string | null</strong></mark></td><td>Estimated delivery for an engraving fulfillment</td></tr></tbody></table>

#### Fulfillment Package

<table><thead><tr><th width="161.64862060546875">Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>id</code></td><td><mark style="color:blue;"><strong>string</strong></mark></td><td>Package ID</td></tr><tr><td><code>carrier</code></td><td><mark style="color:blue;"><strong>string | null</strong></mark></td><td>Shipping carrier</td></tr><tr><td><code>trackingNumber</code></td><td><mark style="color:blue;"><strong>string | null</strong></mark></td><td>Tracking number</td></tr><tr><td><code>trackingUrl</code></td><td><mark style="color:blue;"><strong>string | null</strong></mark></td><td>Tracking URL</td></tr><tr><td><code>status</code></td><td><a href="#enums"><mark style="color:blue;"><strong>ENUM_ORDER_PACKAGE_STATUS</strong></mark></a></td><td>Package status</td></tr><tr><td><code>dateShipped</code></td><td><mark style="color:blue;"><strong>string | null</strong></mark></td><td>Date shipped in ISO format</td></tr></tbody></table>

#### Fulfillment Timeline

<table><thead><tr><th width="160.268310546875">Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>status</code></td><td><a href="#enums"><mark style="color:blue;"><strong>ENUM_ORDER_STATUS</strong></mark></a></td><td>Fulfillment status</td></tr><tr><td><code>timestamp</code></td><td><mark style="color:blue;"><strong>string</strong></mark></td><td>Status timestamp in ISO format</td></tr></tbody></table>

### Order Item <a href="#order-item" id="order-item"></a>

Represents individual products in the order.

<table><thead><tr><th width="183.80270385742188">Property</th><th width="239.92333984375">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>id</code></td><td><mark style="color:blue;"><strong>string</strong></mark></td><td>Item ID</td></tr><tr><td><code>fulfillmentId</code></td><td><mark style="color:blue;"><strong>string | null</strong></mark></td><td>Fulfillment ID</td></tr><tr><td><code>retailerId</code></td><td><mark style="color:blue;"><strong>string</strong></mark></td><td>Retailer ID</td></tr><tr><td><code>variantId</code></td><td><mark style="color:blue;"><strong>string</strong></mark></td><td>Variant ID</td></tr><tr><td><code>liquidId</code></td><td><mark style="color:blue;"><strong>string | null</strong></mark></td><td>Liquid ID</td></tr><tr><td><code>legacyGrouping</code></td><td><mark style="color:blue;"><strong>string | null</strong></mark></td><td>Legacy grouping</td></tr><tr><td><code>legacyPid</code></td><td><mark style="color:blue;"><strong>string | null</strong></mark></td><td>Legacy product ID</td></tr><tr><td><code>customerPlacement</code></td><td><a href="#enums"><mark style="color:blue;"><strong>ENUM_CUSTOMER_PLACEMENT</strong></mark></a></td><td>Customer placement type</td></tr><tr><td><code>isPresale</code></td><td><mark style="color:blue;"><strong>boolean</strong></mark></td><td>Is this a presale item</td></tr><tr><td><code>expectation</code></td><td><mark style="color:blue;"><strong>string | null</strong></mark></td><td>Formatted delivery expectation specific to the item</td></tr><tr><td><code>estimatedShipBy</code></td><td><mark style="color:blue;"><strong>string | null</strong></mark></td><td>Estimated ship by date for presale items</td></tr><tr><td><code>product</code></td><td><a href="#order-product"><mark style="color:blue;"><strong>OrderProduct</strong></mark></a></td><td>Product details</td></tr><tr><td><code>image</code></td><td><mark style="color:blue;"><strong>string | null</strong></mark></td><td>Product image URL</td></tr><tr><td><code>pricing</code></td><td><a href="/pages/J7PljIWvrD0y8gy89xWf#order-item-pricing"><mark style="color:blue;"><strong>OrderItemPricing</strong></mark></a></td><td>Item pricing details</td></tr><tr><td><code>attributes</code></td><td><a href="/pages/J7PljIWvrD0y8gy89xWf#order-item-attributes"><mark style="color:blue;"><strong>OrderItemAttributes</strong></mark></a></td><td>Item attributes</td></tr></tbody></table>

#### Order Product <a href="#order-product" id="order-product"></a>

| Property     | Type                                                                                                                             | Description        |
| ------------ | -------------------------------------------------------------------------------------------------------------------------------- | ------------------ |
| `name`       | <mark style="color:blue;">**string**</mark>                                                                                      | Product name       |
| `brand`      | <mark style="color:blue;">**string**</mark>                                                                                      | Product brand      |
| `upc`        | <mark style="color:blue;">**string**</mark>                                                                                      | Product UPC        |
| `sku`        | <mark style="color:blue;">**string**</mark>                                                                                      | Product SKU        |
| `mskus`      | <mark style="color:purple;">**Array<**</mark><mark style="color:blue;">**string**</mark><mark style="color:purple;">**>**</mark> | Product SKUs       |
| `category`   | <mark style="color:blue;">**string \| null**</mark>                                                                              | Product category   |
| `size`       | <mark style="color:blue;">**string \| null**</mark>                                                                              | Product size       |
| `volume`     | <mark style="color:blue;">**string \| null**</mark>                                                                              | Product volume     |
| `uom`        | <mark style="color:blue;">**string \| null**</mark>                                                                              | Unit of measure    |
| `proof`      | <mark style="color:blue;">**string \| null**</mark>                                                                              | Product proof      |
| `attributes` | [<mark style="color:blue;">**OrderProductAttributes**</mark>](#order-product-attributes)                                         | Product attributes |

#### Order Product Attributes

| Property          | Type                                                | Description       |
| ----------------- | --------------------------------------------------- | ----------------- |
| `pack`            | <mark style="color:blue;">**boolean**</mark>        | Is this a pack    |
| `packDescription` | <mark style="color:blue;">**string \| null**</mark> | Pack description  |
| `abv`             | <mark style="color:blue;">**string \| null**</mark> | Alcohol by volume |
| `container`       | <mark style="color:blue;">**string \| null**</mark> | Container         |
| `containerType`   | <mark style="color:blue;">**string \| null**</mark> | Container type    |

#### Order Item Pricing

| Property         | Type                                        | Description            |
| ---------------- | ------------------------------------------- | ---------------------- |
| `price`          | <mark style="color:blue;">**number**</mark> | Item price             |
| `unitPrice`      | <mark style="color:blue;">**number**</mark> | Unit price             |
| `quantity`       | <mark style="color:blue;">**number**</mark> | Item quantity          |
| `tax`            | <mark style="color:blue;">**number**</mark> | Item tax               |
| `bottleDeposits` | <mark style="color:blue;">**number**</mark> | Bottle deposits amount |

#### Order Item Attributes <a href="#order-item-attributes" id="order-item-attributes"></a>

| Property    | Type                                                                                     | Description            |
| ----------- | ---------------------------------------------------------------------------------------- | ---------------------- |
| `engraving` | [<mark style="color:blue;">**OrderItemEngraving**</mark>](#partner-order-item-engraving) | Item engraving details |
| `giftCard`  | [<mark style="color:blue;">**OrderItemGiftCard**</mark>](#partner-order-item-gift-card)  | Item gift card details |

#### Order Item Engraving

| Property       | Type                                                                                                                             | Description          |
| -------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------- |
| `hasEngraving` | <mark style="color:blue;">**boolean**</mark>                                                                                     | Has engraving        |
| `fee`          | <mark style="color:blue;">**number**</mark>                                                                                      | Engraving fee        |
| `location`     | <mark style="color:blue;">**string \| null**</mark>                                                                              | Engraving location   |
| `lines`        | <mark style="color:purple;">**Array<**</mark><mark style="color:blue;">**string**</mark><mark style="color:purple;">**>**</mark> | Engraving text lines |

#### Order Item Gift Card

| Property     | Type                                                                                                                             | Description          |
| ------------ | -------------------------------------------------------------------------------------------------------------------------------- | -------------------- |
| `sender`     | <mark style="color:blue;">**string \| null**</mark>                                                                              | Gift card sender     |
| `message`    | <mark style="color:blue;">**string \| null**</mark>                                                                              | Gift card message    |
| `recipients` | <mark style="color:purple;">**Array<**</mark><mark style="color:blue;">**string**</mark><mark style="color:purple;">**>**</mark> | Gift card recipients |
| `sendDate`   | <mark style="color:blue;">**string \| null**</mark>                                                                              | Gift card send date  |

### Enums

#### Order Status

```typescript
enum ENUM_ORDER_STATUS {
  CREATED = 'created',
  PROCESSING = 'processing',
  IN_TRANSIT = 'inTransit',
  CANCELED = 'canceled',
  EXCEPTION = 'exception',
  DELIVERED = 'delivered',
}
```

#### Order System

```typescript
enum ENUM_ORDER_SYSTEM {
  LIQUIDCOMMERCE = 'LiquidCommerce OMS',
  RESERVEBAR = 'ReserveBar OMS',
}
```

#### Fulfillment Type

```typescript
enum ENUM_ORDER_FULFILLMENT_TYPE {
  SHIPPING = 'shipping',
  ON_DEMAND = 'onDemand',
  DIGITAL = 'digital',
  BOPIS = 'bopis'
}
```

#### Package Status

```typescript
enum ENUM_ORDER_PACKAGE_STATUS {
  PENDING = 'pending',
  SHIPPED = 'shipped',
  DELIVERED = 'delivered',
  RETURNED = 'returned',
  CANCELED = 'canceled'
}
```

#### Customer Placement

```typescript
enum ENUM_CUSTOMER_PLACEMENT {
  STANDARD = 'standard',
  BACK_ORDER = 'back_order',
  PRE_SALE = 'pre_sale'
}
```

### Order Status Flow

Orders in the LiquidCommerce system typically progress through these statuses:

1. `created` - Initial state when an order is first created in the system
2. `processing` - Order is actively being prepared/fulfilled
3. `inTransit` - Order has been sent out for delivery to the destination
4. `delivered` - Order has been successfully delivered to the destination
5. `canceled` - Order has been canceled (can occur at any stage except delivered)

Special cases:

* Orders can be `canceled` from created or processing statuses


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.liquidcommerce.cloud/types/order.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.