Order Fields
The unified order model normalizes data from all source platforms into a consistent structure.
Core Fields
| Field | Type | Req | Description |
|---|---|---|---|
| id | string (UUID) | Orderly internal ID | |
| organizationId | string (UUID) | Owning organization | |
| bridgeId | string (UUID) | Source bridge that created this order | |
| externalId | string | ID from the source platform | |
| orderNumber | string | Human-readable order number | |
| status | OrderStatus | Current lifecycle status | |
| financialStatus | string | Payment status (paid, pending, refunded) | |
| fulfillmentStatus | string | Fulfillment state (unfulfilled, partial, fulfilled) |
Customer
| Field | Type | Req | Description |
|---|---|---|---|
| customer.name | string | Full name | |
| customer.email | string | Email address | |
| customer.phone | string | Phone number | |
| customer.externalId | string | Customer ID from source platform |
Addresses
| Field | Type | Req | Description |
|---|---|---|---|
| shippingAddress.name | string | Recipient name | |
| shippingAddress.address1 | string | Street address line 1 | |
| shippingAddress.address2 | string | Street address line 2 | |
| shippingAddress.city | string | City | |
| shippingAddress.state | string | State/province | |
| shippingAddress.zip | string | Postal code | |
| shippingAddress.country | string | Country code (ISO 3166-1 alpha-2) | |
| shippingAddress.phone | string | Recipient phone |
Line Items
Each order has an array of lineItems:
| Field | Type | Req | Description |
|---|---|---|---|
| lineItems[].id | string | Line item ID | |
| lineItems[].sku | string | Product SKU | |
| lineItems[].title | string | Product title | |
| lineItems[].quantity | number | Quantity ordered | |
| lineItems[].price | number | Unit price | |
| lineItems[].weight | number | Item weight | |
| lineItems[].variantTitle | string | Variant name (size, color, etc.) | |
| lineItems[].fulfillableQuantity | number | Quantity still needing fulfillment |
Financial
| Field | Type | Req | Description |
|---|---|---|---|
| subtotalPrice | number | Subtotal before tax and shipping | |
| totalTax | number | Total tax amount | |
| totalShipping | number | Shipping cost | |
| totalDiscounts | number | Total discount amount | |
| totalPrice | number | Final total charged to customer | |
| currency | string | Currency code (ISO 4217), e.g., "USD" |
Metadata
| Field | Type | Req | Description |
|---|---|---|---|
| tags | string[] | Tags for categorization and filtering | |
| notes | string | Internal notes | |
| metadata | Record<string, unknown> | Arbitrary key-value data | |
| source | string | Source platform identifier | |
| sourceUrl | string | Link to order in source platform |
Timestamps
| Field | Type | Req | Description |
|---|---|---|---|
| createdAt | Date | When the order was created in Orderly | |
| updatedAt | Date | Last update time | |
| orderDate | Date | When the order was placed on the source platform | |
| shippedAt | Date | When the order was shipped | |
| deliveredAt | Date | When the order was delivered |