Order

A full reference to a order type for the Liquid Commerce Orders APIs.

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

Property	Type	Description
referenceId	string | null	Optional order reference ID
legacyOrderNumber	string | null	Optional legacy order number for backward compatibility
partnerId	string	Partner ID associated with the order
partnerName	string	Partner name associated to the order
promoCode	string | null	The promotional code value for the order
isHybrid	boolean	Indicates if this is a hybrid order
createdAt	string	Order creation date in ISO format
updatedAt	string	Order last update date in ISO format
customer	OrderCustomer	Customer information
addresses	OrderAddresses	Order addresses (shipping and billing)
options	OrderOptions	Order options including gift details and preferences
paymentMethods	Array<PaymentMethods>	Order payment methods information
amounts	OrderAmounts	Order amount details including subtotal, taxes, fees, etc.
retailers	Array<OrderRetailer>	Order retailers information
items	Array<OrderItem>	Order items details

Customer Information

Represents customer details associated with the order.

Property	Type	Description
id	string	Customer ID
firstName	string | null	Customer first name
lastName	string | null	Customer last name
email	string	Customer email
phone	string | null	Customer phone
birthdate	string | null	Customer birthdate in YYYY-MM-DD format

Address Information

Basic Address

Property	Type	Description
one	string	Address line 1
two	string | null	Address line 2
city	string	City
state	string	State
zip	string	Zip code
country	string	Country

Full Address

Extends the basic address with additional fields.

Additional Property	Type	Description
firstName	string | null	Billing first name
lastName	string | null	Billing last name
email	string	Billing email
phone	string | null	Billing phone
company	string | null	Billing company

Addresses Container

Property	Type	Description
shipping	FullAddress	Shipping address
billing	FullAddress	Billing address

Order Options

Represents various order preferences and settings.

Property	Type	Description
isGift	boolean	Is this order a gift
giftMessage	string | null	Gift message
giftRecipient	GiftRecipient	Gift recipient information
hasVerifiedAge	boolean	Has the customer verified their age
allowsSubstitution	boolean	Does the customer allow product substitution
billingSameAsShipping	boolean	Is billing address same as shipping address
deliveryInstructions	string | null	Delivery instructions
marketingPreferences	MarketingPreferences	Marketing preferences

Gift Recipient

Property	Type	Description
name	string | null	Gift recipient name
email	string | null	Gift recipient email
phone	string | null	Gift recipient phone

Marketing Preferences

Property	Type	Description
email	boolean	Email marketing preference
sms	boolean	SMS marketing preference

Order Amounts

Detailed financial information for the order.

Property	Type	Description
subtotal	number	Order subtotal
shipping	number	Shipping cost
platform	number	Platform fee
tax	number	Tax amount
engraving	number	Engraving cost
service	number	Service fee
delivery	number	Delivery fee
discounts	number	Total discounts
giftCards	number	Gift cards amount applied
tip	number	Tip amount
total	number	Order total
taxDetails	TaxDetails	Tax details
discountDetails	DiscountDetails	Discount details

Tax Details

Property	Type	Description
products	number	Product tax
shipping	number	Shipping tax
delivery	number	Delivery tax
bag	number	Bag tax
bottleDeposits	number	Bottle deposits tax
retailDelivery	number	Retail delivery tax

Discount Details

Property	Type	Description
products	number	Product discounts
shipping	number	Shipping discounts
delivery	number	Delivery discounts
engraving	number	Engraving discounts
service	number	Service discounts

Payment Methods

Property	Type	Description
type	string | null	Payment type, ex: CREDIT_CARD, GIFT_CARD, etc
card	string | null	Card type
last4	string | null	Card last 4 digits
holder	string | null	Card holder
code	string | null	Gift card code

Retailer Information

Represents retailers associated with the order.

Property	Type	Description
id	string	Retailer ID
legacyId	string | null	Retailer legacy ID
name	string	Retailer name
system	ENUM_ORDER_SYSTEM	Order system type
timezone	string	Retailer IANA timezone
address	RetailerAddress	Retailer address
amounts	Amounts	Retailer amounts
fulfillments	Array<Fulfillment>	Retailer fulfillments

Retailer Address

Extends the basic address with two properties for coordinates.

Property	Type	Description
latitude	number | null	Latitude coordinate
longitude	number | null	Longitude coordinate

Fulfillment Information

Represents order fulfillment details.

Property	Type	Description
id	string	Fulfillment ID
type	ENUM_ORDER_FULFILLMENT_TYPE	Fulfillment type
status	ENUM_ORDER_STATUS	Fulfillment status
scheduledFor	string | null	Scheduled date in ISO format
updatedAt	string	Last updated date in ISO format
itemIds	Array<string>	IDs of items in this fulfillment
cancellation	FulfillmentCancellation	Cancellation information
expectationFormatted	FulfillmentExpectationFormatted	Delivery expectation formatted
packages	Array<FulfillmentPackage>	Packages for this fulfillment
timeline	Array<FulfillmentTimeline>	Fulfillment timeline

Fulfillment Cancellation

Property	Type	Description
category	string	Category of cancellation
subcategory	string | null	Subcategory of cancellation
notes	string | null	Specific note left for this cancellation

Fulfillment Expectation Formatted

Property	Type	Description
detail	string	Estimated delivery of a shipping or on-demand fulfillment
engraving	string | null	Estimated delivery for an engraving fulfillment

Fulfillment Package

Property	Type	Description
id	string	Package ID
carrier	string | null	Shipping carrier
trackingNumber	string | null	Tracking number
trackingUrl	string | null	Tracking URL
status	ENUM_ORDER_PACKAGE_STATUS	Package status
dateShipped	string | null	Date shipped in ISO format

Fulfillment Timeline

Property	Type	Description
status	ENUM_ORDER_STATUS	Fulfillment status
timestamp	string	Status timestamp in ISO format

Order Item

Represents individual products in the order.

Property	Type	Description
id	string	Item ID
fulfillmentId	string | null	Fulfillment ID
retailerId	string	Retailer ID
variantId	string	Variant ID
liquidId	string | null	Liquid ID
legacyGrouping	string | null	Legacy grouping
legacyPid	string | null	Legacy product ID
customerPlacement	ENUM_CUSTOMER_PLACEMENT	Customer placement type
isPresale	boolean	Is this a presale item
expectation	string | null	Formatted delivery expectation specific to the item
estimatedShipBy	string | null	Estimated ship by date for presale items
product	OrderProduct	Product details
image	string | null	Product image URL
pricing	OrderItemPricing	Item pricing details
attributes	OrderItemAttributes	Item attributes

Order Product

Property	Type	Description
name	string	Product name
brand	string	Product brand
upc	string	Product UPC
sku	string	Product SKU
mskus	Array<string>	Product SKUs
category	string | null	Product category
size	string | null	Product size
volume	string | null	Product volume
uom	string | null	Unit of measure
proof	string | null	Product proof
attributes	OrderProductAttributes	Product attributes

Order Product Attributes

Property	Type	Description
pack	boolean	Is this a pack
packDescription	string | null	Pack description
abv	string | null	Alcohol by volume
container	string | null	Container
containerType	string | null	Container type

Order Item Pricing

Property	Type	Description
price	number	Item price
unitPrice	number	Unit price
quantity	number	Item quantity
tax	number	Item tax
bottleDeposits	number	Bottle deposits amount

Order Item Attributes

Property	Type	Description
engraving	OrderItemEngraving	Item engraving details
giftCard	OrderItemGiftCard	Item gift card details

Order Item Engraving

Property	Type	Description
hasEngraving	boolean	Has engraving
fee	number	Engraving fee
location	string | null	Engraving location
lines	Array<string>	Engraving text lines

Order Item Gift Card

Property	Type	Description
sender	string | null	Gift card sender
message	string | null	Gift card message
recipients	Array<string>	Gift card recipients
sendDate	string | null	Gift card send date

Enums

Order Status

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

Order System

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

Fulfillment Type

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

Package Status

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

Customer Placement

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