| Field Name | Data Type | Description | Nested Fields |
|---|---|---|---|
| _id | objectId | Unique identifier for the document | 0 |
| order_id | string | Unique identifier for the order. | 0 |
| order_number | string | Human-readable order number | 0 |
| customer_id | string | Unique identifier for the customer. | 0 |
| business_entity_id | string | Unique identifier for the business entity. | 0 |
| sales_channel | object | Object containing sales channel details | 4 |
| sales_channel.channel_id | string | Unique identifier of channel | 0 |
| sales_channel.name | string | Contains channel name | 0 |
| sales_channel.type | string | Describes the method used to sell a product/service to customers | 0 |
| sales_channel.status | string | Status of channel channel | 0 |
| status | string | Current status of the order. | 0 |
| currency | string | Field for currency | 0 |
| totals | object | Sum of data | 5 |
| totals.subtotal | float | Sum of line items prices in an order | 0 |
| totals. shipping | float | Sum of shipping an order | 0 |
| totals.tax | float | Sum of taxes applied to a transaction | 0 |
| totals.discounts | float | Amount reduced from the subtotal | 0 |
| totals.grand_total | float | Final price of an order | 0 |
| order_items | array_of_objects | Field for order items. | 10 |
| order_items.variant_id | string | Unique identifier for variant | 0 |
| order_items.product_id | string | Unique identifier for product | 0 |
| order_items.sku | string | Field for sku | 0 |
| order_items.name_at_sale | string | Name of specific order item. | 0 |
| order_items.quantity | integer | Quantity of order items. | 0 |
| order_items.price_per_unit | integer | Price information for price per unit | 0 |
| order_items.line_item_total | integer | Field for line item total | 0 |
| order_items.variations | object | Object containing variations details | 1 |
| order_items.variations.color | string | Field for color | 0 |
| order_items.physical_attributes | object | Object containing physical attributes details | 6 |
| order_items.physical_attributes.weight | integer | Field for weight | 0 |
| order_items.physical_attributes.weight_unit | string | Field for weight unit | 0 |
| order_items.physical_attributes.length | integer | Field for length | 0 |
| order_items.physical_attributes.width | integer | Unique identifier for width | 0 |
| order_items.physical_attributes.height | integer | Field for height | 0 |
| order_items.physical_attributes.dimension_unit | string | Field for dimension unit | 0 |
| order_items.fulfillment_type | string | Field for fulfillment type | 0 |
| payments | array_of_objects | Field for payments | 6 |
| payments.payment_id | string | Unique identifier for payment | 0 |
| payments.payment_method_id | string | Unique identifier for payment method | 0 |
| payments.amount | integer | Field for amount | 0 |
| payments.status | string | Field for Status of Payment | 0 |
| payments.transaction_id | string | Unique identifier for transaction | 0 |
| payments.payment_date | date | Timestamp for when payment date was created/updated | 0 |
| shipments | array_of_objects | Field for shipments. | 11 |
| shipments.shipment_id | string | Unique identifier for shipment | 0 |
| shipments.status | string | Current status of shipments | 0 |
| shipments.carrier | string | Field for carrier | 0 |
| shipments.tracking_number | string | Field for tracking number | 0 |
| shipments.shipped_date | datetime | Timestamp for when shipped date was created/updated | 0 |
| shipments.estimated_delivery_date | datetime | Timestamp for when shipped when shipped date was created/updated | 0 |
| shipments.items | array_of_object | Field for items | 3 |
| shipments.items.variant_id | string | Unique identifier for variant | 0 |
| shipments.items.quantity | integer | Quantity of Shipments | 0 |
| shipments.items.item_name | string | Name of item | 0 |
| shipments.shipping_address | object | Address information for shipping | 6 |
| shipments.shipping_address.receiver_name | string | Name of receiver | 0 |
| shipments.shipping_address.street | string | Field for street | 0 |
| shipments.shipping_address.city | string | Field for city | 0 |
| shipments.shipping_address.state | string | Field for state | 0 |
| shipments.shipping_address.zip_code | string | Field for Zip code | 0 |
| shipments.shipping_address.country | string | Field for country | 0 |
| shipments.carrier_id | string | Unique identifier for carrier | 0 |
| shipments.fulfillment_location | object | Object containing fulfillment location details | 2 |
| shipments.fulfillment_location.id | string | Unique identifier for id | 0 |
| shipments.fulfillment_location.name | string | Name of name | 0 |
| shipments.shipping_cost | integer | Field for shipping cost | 0 |
| applied_promotions | array_of_objects | Field for applied promotions. | 3 |
| applied_promotions.promotion_id | string | Unique identifier for promotion | 0 |
| applied_promotions.code | string | Field for code | 0 |
| applied_promotions.discount_amount | object | Object containing discount amount details | 2 |
| applied_promotions.discount_amount.amount | integer | Field for amount | 0 |
| applied_promotions.discount_amount.currency | string | Field for currency | 0 |
| external_references | array_of_objects | Field for external references. | 2 |
| external_references.source_system | string | Field for source system | 0 |
| external_references.identifier | string | Unique identifier for external referencesidentifier | 0 |
| notes | string | Field for notes. | 0 |
| created_at | datetime | Timestamp when the record was created. | 0 |
| updated_at | datetime | Timestamp when the record was updated | 0 |
| order_created_date | datetime | Timestamp when the order was created. | 0 |
| last_updated | datetime | Timestamp when the record was updated | 0 |
| lifecycle_events | array_of_objects | Field for lifecycle events. | 4 |
| lifecycle_events.event_id | string | Unique identifier for event | 0 |
| lifecycle_events.status | string | Status of lifecycle event | 0 |
| lifecycle_events.timestamp | datetime | Field for timestamp | 0 |
| lifecycle_events.notes | string | Field for notes | 0 |
| order_cancelled_date | datetime | Timestamp for when the order was cancelled | 0 |
| order_shipped_date | datetime | Timestamp for when the order was shipped. | 0 |
Example
Example