{
"orders": [
{
"split_order_payment": {
"id": "<string>",
"status": "<string>",
"authorized_amount": 123,
"captured_amount": 123,
"refunded_amount": 123,
"currency_code": "<string>"
},
"fulfillments": [
{
"id": "<string>",
"location_id": "<string>",
"provider_id": "<string>",
"shipping_option_id": "<string>",
"provider": {
"id": "<string>",
"is_enabled": true
},
"delivery_address": {
"id": "<string>",
"company": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"address_1": "<string>",
"address_2": "<string>",
"city": "<string>",
"country_code": "<string>",
"province": "<string>",
"postal_code": "<string>",
"phone": "<string>",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
},
"items": [
{
"id": "<string>",
"title": "<string>",
"quantity": 123,
"sku": "<string>",
"barcode": "<string>",
"line_item_id": "<string>",
"inventory_item_id": "<string>",
"fulfillment_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}
],
"labels": [
{
"id": "<string>",
"tracking_number": "<string>",
"tracking_url": "<string>",
"label_url": "<string>",
"fulfillment_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}
],
"packed_at": "<string>",
"shipped_at": "<string>",
"delivered_at": "<string>",
"canceled_at": "<string>",
"data": {},
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}
],
"shipping_address": {
"id": "<string>",
"customer_id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"phone": "<string>",
"company": "<string>",
"address_1": "<string>",
"address_2": "<string>",
"city": "<string>",
"country_code": "us",
"country": {
"id": "<string>",
"iso_2": "us",
"iso_3": "usa",
"num_code": 840,
"name": "<string>",
"display_name": "<string>"
},
"province": "<string>",
"postal_code": "<string>",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"billing_address": {
"id": "<string>",
"customer_id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"phone": "<string>",
"company": "<string>",
"address_1": "<string>",
"address_2": "<string>",
"city": "<string>",
"country_code": "us",
"country": {
"id": "<string>",
"iso_2": "us",
"iso_3": "usa",
"num_code": 840,
"name": "<string>",
"display_name": "<string>"
},
"province": "<string>",
"postal_code": "<string>",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"id": "<string>",
"version": 123,
"region_id": "<string>",
"customer_id": "<string>",
"sales_channel_id": "<string>",
"email": "[email protected]",
"currency_code": "<string>",
"display_id": 123,
"items": [
{
"id": "<string>",
"title": "<string>",
"subtitle": "<string>",
"thumbnail": "<string>",
"variant": {
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"title": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"sku": "<string>",
"barcode": "<string>",
"ean": "<string>",
"upc": "<string>",
"allow_backorder": true,
"manage_inventory": true,
"hs_code": "<string>",
"origin_country": "<string>",
"mid_code": "<string>",
"material": "<string>",
"weight": 123,
"length": 123,
"height": 123,
"width": 123,
"options": [
{
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"value": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"metadata": {
"car": "white"
}
}
],
"metadata": {
"car": "white"
}
},
"variant_id": "<string>",
"product": {
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"title": "<string>",
"handle": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"subtitle": "<string>",
"description": "<string>",
"is_giftcard": true,
"status": "draft",
"thumbnail": "<string>",
"width": 123,
"weight": 123,
"length": 123,
"height": 123,
"origin_country": "<string>",
"hs_code": "<string>",
"mid_code": "<string>",
"material": "<string>",
"collection": {
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"title": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"handle": "<string>",
"metadata": {
"car": "white"
}
},
"type": {
"id": "<string>",
"value": "<string>",
"metadata": {
"car": "white"
}
},
"tags": [
{
"id": "<string>",
"value": "<string>",
"metadata": {
"car": "white"
}
}
],
"categories": [
{
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"handle": "<string>",
"is_active": true,
"is_internal": true,
"rank": 123,
"parent_category": "<unknown>",
"category_children": "<array>",
"metadata": {
"car": "white"
}
}
],
"variants": [
{
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"title": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"sku": "<string>",
"barcode": "<string>",
"ean": "<string>",
"upc": "<string>",
"allow_backorder": true,
"manage_inventory": true,
"hs_code": "<string>",
"origin_country": "<string>",
"mid_code": "<string>",
"material": "<string>",
"weight": 123,
"length": 123,
"height": 123,
"width": 123,
"options": [
{
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"value": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"metadata": {
"car": "white"
}
}
],
"metadata": {
"car": "white"
}
}
],
"options": [
{
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"title": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"values": [
{
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"value": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"metadata": {
"car": "white"
}
}
],
"metadata": {
"car": "white"
}
}
],
"images": [
{
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"url": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"rank": 123,
"metadata": {
"car": "white"
}
}
],
"discountable": true,
"external_id": "<string>",
"metadata": {
"car": "white"
},
"rating": "<string>"
},
"product_id": "<string>",
"product_title": "<string>",
"product_description": "<string>",
"product_subtitle": "<string>",
"product_type": "<string>",
"product_collection": "<string>",
"product_handle": "<string>",
"variant_sku": "<string>",
"variant_barcode": "<string>",
"variant_title": "<string>",
"variant_option_values": {
"Color": "Blue"
},
"requires_shipping": true,
"is_discountable": true,
"is_tax_inclusive": true,
"compare_at_unit_price": 123,
"unit_price": 123,
"quantity": 123,
"detail": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"metadata": {},
"original_total": 123,
"original_subtotal": 123,
"original_tax_total": 123,
"item_total": 123,
"item_subtotal": 123,
"item_tax_total": 123,
"total": 123,
"subtotal": 123,
"tax_total": 123,
"discount_total": 123,
"discount_tax_total": 123,
"refundable_total": 123,
"refundable_total_per_unit": 123,
"product_type_id": "<string>"
}
],
"shipping_methods": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"amount": 123,
"is_tax_inclusive": true,
"shipping_option_id": "<string>",
"data": {},
"metadata": {},
"original_total": 123,
"original_subtotal": 123,
"original_tax_total": 123,
"total": 123,
"subtotal": 123,
"tax_total": 123,
"discount_total": 123,
"discount_tax_total": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"commission_value": {
"amount": 123,
"currency_code": "<string>"
},
"commission_lines": [
{
"id": "<string>",
"item_line_id": "<string>",
"amount": 123,
"currency_code": "<string>"
}
],
"payment_status": "canceled",
"fulfillment_status": "canceled",
"summary": {
"total": 123,
"subtotal": 123,
"total_tax": 123,
"ordered_total": 123,
"fulfilled_total": 123,
"returned_total": 123,
"return_request_total": 123,
"write_off_total": 123,
"paid_total": 123,
"refunded_total": 123
},
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"original_item_total": 123,
"original_item_subtotal": 123,
"original_item_tax_total": 123,
"item_total": 123,
"item_subtotal": 123,
"item_tax_total": 123,
"original_total": 123,
"original_subtotal": 123,
"original_tax_total": 123,
"total": 123,
"subtotal": 123,
"tax_total": 123,
"discount_total": 123,
"discount_tax_total": 123,
"gift_card_total": 123,
"gift_card_tax_total": 123,
"shipping_total": 123,
"shipping_subtotal": 123,
"shipping_tax_total": 123,
"original_shipping_total": 123,
"original_shipping_subtotal": 123,
"original_shipping_tax_total": 123
}
],
"count": 123,
"offset": 123,
"limit": 123
}List Orders
Retrieves a list of orders for the authenticated vendor.
{
"orders": [
{
"split_order_payment": {
"id": "<string>",
"status": "<string>",
"authorized_amount": 123,
"captured_amount": 123,
"refunded_amount": 123,
"currency_code": "<string>"
},
"fulfillments": [
{
"id": "<string>",
"location_id": "<string>",
"provider_id": "<string>",
"shipping_option_id": "<string>",
"provider": {
"id": "<string>",
"is_enabled": true
},
"delivery_address": {
"id": "<string>",
"company": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"address_1": "<string>",
"address_2": "<string>",
"city": "<string>",
"country_code": "<string>",
"province": "<string>",
"postal_code": "<string>",
"phone": "<string>",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
},
"items": [
{
"id": "<string>",
"title": "<string>",
"quantity": 123,
"sku": "<string>",
"barcode": "<string>",
"line_item_id": "<string>",
"inventory_item_id": "<string>",
"fulfillment_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}
],
"labels": [
{
"id": "<string>",
"tracking_number": "<string>",
"tracking_url": "<string>",
"label_url": "<string>",
"fulfillment_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}
],
"packed_at": "<string>",
"shipped_at": "<string>",
"delivered_at": "<string>",
"canceled_at": "<string>",
"data": {},
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}
],
"shipping_address": {
"id": "<string>",
"customer_id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"phone": "<string>",
"company": "<string>",
"address_1": "<string>",
"address_2": "<string>",
"city": "<string>",
"country_code": "us",
"country": {
"id": "<string>",
"iso_2": "us",
"iso_3": "usa",
"num_code": 840,
"name": "<string>",
"display_name": "<string>"
},
"province": "<string>",
"postal_code": "<string>",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"billing_address": {
"id": "<string>",
"customer_id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"phone": "<string>",
"company": "<string>",
"address_1": "<string>",
"address_2": "<string>",
"city": "<string>",
"country_code": "us",
"country": {
"id": "<string>",
"iso_2": "us",
"iso_3": "usa",
"num_code": 840,
"name": "<string>",
"display_name": "<string>"
},
"province": "<string>",
"postal_code": "<string>",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"id": "<string>",
"version": 123,
"region_id": "<string>",
"customer_id": "<string>",
"sales_channel_id": "<string>",
"email": "[email protected]",
"currency_code": "<string>",
"display_id": 123,
"items": [
{
"id": "<string>",
"title": "<string>",
"subtitle": "<string>",
"thumbnail": "<string>",
"variant": {
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"title": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"sku": "<string>",
"barcode": "<string>",
"ean": "<string>",
"upc": "<string>",
"allow_backorder": true,
"manage_inventory": true,
"hs_code": "<string>",
"origin_country": "<string>",
"mid_code": "<string>",
"material": "<string>",
"weight": 123,
"length": 123,
"height": 123,
"width": 123,
"options": [
{
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"value": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"metadata": {
"car": "white"
}
}
],
"metadata": {
"car": "white"
}
},
"variant_id": "<string>",
"product": {
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"title": "<string>",
"handle": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"subtitle": "<string>",
"description": "<string>",
"is_giftcard": true,
"status": "draft",
"thumbnail": "<string>",
"width": 123,
"weight": 123,
"length": 123,
"height": 123,
"origin_country": "<string>",
"hs_code": "<string>",
"mid_code": "<string>",
"material": "<string>",
"collection": {
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"title": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"handle": "<string>",
"metadata": {
"car": "white"
}
},
"type": {
"id": "<string>",
"value": "<string>",
"metadata": {
"car": "white"
}
},
"tags": [
{
"id": "<string>",
"value": "<string>",
"metadata": {
"car": "white"
}
}
],
"categories": [
{
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"handle": "<string>",
"is_active": true,
"is_internal": true,
"rank": 123,
"parent_category": "<unknown>",
"category_children": "<array>",
"metadata": {
"car": "white"
}
}
],
"variants": [
{
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"title": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"sku": "<string>",
"barcode": "<string>",
"ean": "<string>",
"upc": "<string>",
"allow_backorder": true,
"manage_inventory": true,
"hs_code": "<string>",
"origin_country": "<string>",
"mid_code": "<string>",
"material": "<string>",
"weight": 123,
"length": 123,
"height": 123,
"width": 123,
"options": [
{
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"value": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"metadata": {
"car": "white"
}
}
],
"metadata": {
"car": "white"
}
}
],
"options": [
{
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"title": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"values": [
{
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"value": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"metadata": {
"car": "white"
}
}
],
"metadata": {
"car": "white"
}
}
],
"images": [
{
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"url": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"rank": 123,
"metadata": {
"car": "white"
}
}
],
"discountable": true,
"external_id": "<string>",
"metadata": {
"car": "white"
},
"rating": "<string>"
},
"product_id": "<string>",
"product_title": "<string>",
"product_description": "<string>",
"product_subtitle": "<string>",
"product_type": "<string>",
"product_collection": "<string>",
"product_handle": "<string>",
"variant_sku": "<string>",
"variant_barcode": "<string>",
"variant_title": "<string>",
"variant_option_values": {
"Color": "Blue"
},
"requires_shipping": true,
"is_discountable": true,
"is_tax_inclusive": true,
"compare_at_unit_price": 123,
"unit_price": 123,
"quantity": 123,
"detail": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"metadata": {},
"original_total": 123,
"original_subtotal": 123,
"original_tax_total": 123,
"item_total": 123,
"item_subtotal": 123,
"item_tax_total": 123,
"total": 123,
"subtotal": 123,
"tax_total": 123,
"discount_total": 123,
"discount_tax_total": 123,
"refundable_total": 123,
"refundable_total_per_unit": 123,
"product_type_id": "<string>"
}
],
"shipping_methods": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"amount": 123,
"is_tax_inclusive": true,
"shipping_option_id": "<string>",
"data": {},
"metadata": {},
"original_total": 123,
"original_subtotal": 123,
"original_tax_total": 123,
"total": 123,
"subtotal": 123,
"tax_total": 123,
"discount_total": 123,
"discount_tax_total": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"commission_value": {
"amount": 123,
"currency_code": "<string>"
},
"commission_lines": [
{
"id": "<string>",
"item_line_id": "<string>",
"amount": 123,
"currency_code": "<string>"
}
],
"payment_status": "canceled",
"fulfillment_status": "canceled",
"summary": {
"total": 123,
"subtotal": 123,
"total_tax": 123,
"ordered_total": 123,
"fulfilled_total": 123,
"returned_total": 123,
"return_request_total": 123,
"write_off_total": 123,
"paid_total": 123,
"refunded_total": 123
},
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"original_item_total": 123,
"original_item_subtotal": 123,
"original_item_tax_total": 123,
"item_total": 123,
"item_subtotal": 123,
"item_tax_total": 123,
"original_total": 123,
"original_subtotal": 123,
"original_tax_total": 123,
"total": 123,
"subtotal": 123,
"tax_total": 123,
"discount_total": 123,
"discount_tax_total": 123,
"gift_card_total": 123,
"gift_card_tax_total": 123,
"shipping_total": 123,
"shipping_subtotal": 123,
"shipping_tax_total": 123,
"original_shipping_total": 123,
"original_shipping_subtotal": 123,
"original_shipping_tax_total": 123
}
],
"count": 123,
"offset": 123,
"limit": 123
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
The number of items to skip before starting to collect the result set.
The number of items to return.
Comma-separated fields to include in the response.
The order of the returned items.
Filter by created at date range
Filter by order status
Filter by fulfillment status
Filter by payment status
Search query for filtering orders
Response
OK
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Split order payment id
Payment status
Authorized amount
Captured amount
Refunded amount
The currency code.
The order's fulfillments.
Show child attributes
Show child attributes
The fulfillment's ID.
The ID of the location the fulfillment's items are shipped from.
The ID of the fulfillment provider handling this fulfillment.
The ID of the shipping option this fulfillment is created for.
An address's details.
Show child attributes
Show child attributes
The address's ID.
The address's company.
The address's first name.
The address's last name.
The address's first line.
The address's second line.
The address's city.
The address's country code.
The address's province.
The address's postal code.
The address's phone.
The address's metadata, can hold custom key-value pairs.
The date the address was created.
The date the address was updated.
The date the address was deleted.
The fulfillment's items.
Show child attributes
Show child attributes
The item's ID.
The item's title.
The item's quantity to be fulfilled.
The item's SKU.
The item's barcode.
The ID of the order's line item to be fulfilled.
The ID of the inventory item of the underlying product variant.
The ID of the fulfillment the item belongs to.
The date the item was created.
The date the item was updated.
The date the item was deleted.
The fulfillment's shipment labels.
Show child attributes
Show child attributes
The label's ID.
The label's tracking number.
The label's tracking URL.
The label's URL.
The ID of the fulfillment the label is associated with.
The date the label was created.
The date the label was updated.
The date the label was deleted.
The date the fulfillment was packed at.
The date the fulfillment was shipped at.
The date the fulfillment was delivered at.
The date the fulfillment was canceled at.
The fulfillment's data, useful for the third-party provider handling the fulfillment.
The fulfillment's metadata, can hold custom key-value pairs.
The date the fulfillment was created at.
The date the fulfillment was updated at.
The date the fulfillment was deleted at.
An order address.
Show child attributes
Show child attributes
The address's ID.
The ID of the customer this address belongs to.
The address's first name.
The address's last name.
The address's phone.
The address's company.
The address's first line.
The address's second line.
The address's city.
The address's country code.
"us"
The country's details.
Show child attributes
Show child attributes
The country's ID.
The country's iso 2.
"us"
The country's iso 3.
"usa"
The country's num code.
840
The country's name.
The country's display name.
The address's province.
The address's postal code.
The address's metadata, can hold custom key-value pairs.
The date the address was created.
The date the address was updated.
An order address.
Show child attributes
Show child attributes
The address's ID.
The ID of the customer this address belongs to.
The address's first name.
The address's last name.
The address's phone.
The address's company.
The address's first line.
The address's second line.
The address's city.
The address's country code.
"us"
The country's details.
Show child attributes
Show child attributes
The country's ID.
The country's iso 2.
"us"
The country's iso 3.
"usa"
The country's num code.
840
The country's name.
The country's display name.
The address's province.
The address's postal code.
The address's metadata, can hold custom key-value pairs.
The date the address was created.
The date the address was updated.
The order's ID.
The order's version.
The ID of the region associated with the order.
The ID of the customer that placed the order.
The ID of the sales channel the order is placed in.
The email of the customer that placed the order.
The order's currency code.
The order's display ID.
The order's items.
Show child attributes
Show child attributes
The item's ID.
The item's title.
The item's subtitle.
The URL of the item's thumbnail.
A product variant object with its properties
Show child attributes
Show child attributes
The unique identifier of the product variant.
The date with timezone at which the resource was created.
The date with timezone at which the resource was last updated.
The title of the product variant.
The date with timezone at which the resource was deleted.
The SKU of the product variant.
The barcode of the product variant.
The EAN of the product variant.
The UPC of the product variant.
Whether the product variant can be ordered when it's out of stock.
Whether the product variant's inventory should be managed by the core system.
The HS Code of the product variant.
The origin country of the product variant.
The MID Code of the product variant.
The material of the product variant.
The weight of the product variant.
The length of the product variant.
The height of the product variant.
The width of the product variant.
The associated product option values.
Show child attributes
Show child attributes
The unique identifier of the product option value.
The date with timezone at which the resource was created.
The date with timezone at which the resource was last updated.
The value of the product option value.
The date with timezone at which the resource was deleted.
An optional key-value map with additional details.
{ "car": "white" }An optional key-value map with additional details.
{ "car": "white" }The ID of the associated variant.
A product object with its properties
Show child attributes
Show child attributes
The unique identifier of the product.
The date with timezone at which the resource was created.
The date with timezone at which the resource was last updated.
The title of the product.
A unique handle for the product.
The date with timezone at which the resource was deleted.
The subtitle of the product.
A description of the product.
Whether the product is a gift card.
The status of the product.
draft, proposed, published, rejected URL to the product's thumbnail.
The width of the product.
The weight of the product.
The length of the product.
The height of the product.
The origin country of the product.
The HS Code of the product.
The MID Code of the product.
The material of the product.
The associated product collection.
Show child attributes
Show child attributes
The unique identifier of the product collection.
The date with timezone at which the resource was created.
The date with timezone at which the resource was last updated.
The title of the product collection.
The date with timezone at which the resource was deleted.
The handle of the product collection.
An optional key-value map with additional details.
{ "car": "white" }The associated product type.
The associated product tags.
The associated product categories.
Show child attributes
Show child attributes
The unique identifier of the product category.
The date with timezone at which the resource was created.
The date with timezone at which the resource was last updated.
The name of the product category.
The date with timezone at which the resource was deleted.
The handle of the product category.
Whether the product category is active.
Whether the product category is internal.
The rank of the category among sibling categories.
The parent category.
Show child attributes
Show child attributes
The child categories.
An optional key-value map with additional details.
{ "car": "white" }The associated product variants.
Show child attributes
Show child attributes
The unique identifier of the product variant.
The date with timezone at which the resource was created.
The date with timezone at which the resource was last updated.
The title of the product variant.
The date with timezone at which the resource was deleted.
The SKU of the product variant.
The barcode of the product variant.
The EAN of the product variant.
The UPC of the product variant.
Whether the product variant can be ordered when it's out of stock.
Whether the product variant's inventory should be managed by the core system.
The HS Code of the product variant.
The origin country of the product variant.
The MID Code of the product variant.
The material of the product variant.
The weight of the product variant.
The length of the product variant.
The height of the product variant.
The width of the product variant.
The associated product option values.
Show child attributes
Show child attributes
The unique identifier of the product option value.
The date with timezone at which the resource was created.
The date with timezone at which the resource was last updated.
The value of the product option value.
The date with timezone at which the resource was deleted.
An optional key-value map with additional details.
{ "car": "white" }An optional key-value map with additional details.
{ "car": "white" }The associated product options.
Show child attributes
Show child attributes
The unique identifier of the product option.
The date with timezone at which the resource was created.
The date with timezone at which the resource was last updated.
The title of the product option.
The date with timezone at which the resource was deleted.
The associated product option values.
Show child attributes
Show child attributes
The unique identifier of the product option value.
The date with timezone at which the resource was created.
The date with timezone at which the resource was last updated.
The value of the product option value.
The date with timezone at which the resource was deleted.
An optional key-value map with additional details.
{ "car": "white" }An optional key-value map with additional details.
{ "car": "white" }The associated product images.
Show child attributes
Show child attributes
The unique identifier of the product image.
The date with timezone at which the resource was created.
The date with timezone at which the resource was last updated.
The URL of the product image.
The date with timezone at which the resource was deleted.
The rank of the product image.
An optional key-value map with additional details.
{ "car": "white" }Whether the product can be discounted.
The ID of the product in an external system.
An optional key-value map with additional details.
{ "car": "white" }The average rating from customer reviews
The ID of the associated product.
The item's product title.
The item's product description.
The item's product subtitle.
The item's product type.
The ID of the collection the item's product belongs to.
The item's product handle.
The item's variant SKU.
The item's variant barcode.
The item's variant title.
The values of the item variant's options.
{ "Color": "Blue" }Whether the item requires shipping.
Whether the item is discountable.
Whether the item is tax inclusive.
The original price of the item before a promotion or sale.
The item's unit price.
The item's quantity.
The date the item was created.
The date the item was updated.
The item's metadata, can hold custom key-value pairs.
The item's total including taxes, excluding promotions.
The item's total excluding taxes, including promotions.
The total taxes of the item, excluding promotions.
The total taxes of the item, including promotions.
The item's total excluding taxes, including promotions.
The total taxes of the item, including promotions.
The item's total, including taxes and promotions.
The item's subtotal excluding taxes, including promotions.
The tax total of the item including promotions.
The total discount amount of the item.
The total taxes applied on the discounted amount.
The total refundable amount of the item's total.
The total refundable amount of the item's total for a single quantity.
The ID of the associated product's type.
The order's shipping methods.
Show child attributes
Show child attributes
The shipping method's ID.
The shipping method's name.
The shipping method's description.
The shipping method's amount.
Whether the shipping method's amount includes applied taxes.
The ID of the shipping option this method was created from.
The shipping method's data, useful for fulfillment provider handling its fulfillment.
The shipping method's metadata, can hold custom key-value pairs.
The shipping method's total including taxes, excluding promotions.
The shipping method's total excluding taxes, including promotions.
The shipping method's total taxes excluding promotions.
The shipping method's total including taxes and promotions.
The shipping method's total excluding taxes, including promotions.
The shipping method's tax total including promotions.
The total discounts applied on the shipping method.
The taxes applied on the discount amount.
The date the shipping method was created.
The date the shipping method was updated.
The commission breakdown.
The order's payment status.
canceled, pending, not_paid, awaiting, authorized, partially_authorized, captured, partially_refunded, refunded, requires_action The order's fulfillment status.
canceled, not_fulfilled, partially_fulfilled, fulfilled, partially_shipped, shipped, partially_delivered, delivered The order's summary details.
Show child attributes
Show child attributes
The order's total including taxes and promotions.
The order's total excluding taxes, including promotions.
The order's total taxes.
The order's total when it was placed.
The total of the fulfilled items of the order.
The total of the order's returned items.
The total of the items requested to be returned.
The total of the items removed from the order.
The total amount paid.
The total amount refunded.
The order's metadata, can hold custom key-value pairs.
The date the order was created.
The date the order was updated.
The total of the order's items including taxes, excluding promotions.
The total of the order's items excluding taxes, including promotions.
The tax total of the order's items excluding promotions.
The total of the order's items including taxes and promotions.
The total of the order's items excluding taxes, including promotions.
The tax total of the order's items including promotions.
The order's total excluding promotions, including taxes.
The order's total excluding taxes, including promotions.
The order's tax total, excluding promotions.
The order's total including taxes and promotions.
The order's total excluding taxes, including promotions.
The order's tax total including promotions.
The order's discount or promotions total.
The tax total of order's discount or promotion.
The order's gift card total.
The tax total of the order's gift card.
The order's shipping total including taxes and promotions.
The order's shipping total excluding taxes, including promotions.
The tax total of the order's shipping.
The order's shipping total including taxes, excluding promotions.
The order's shipping total excluding taxes, including promotions.
The tax total of the order's shipping excluding promotions.
The total number of items available
The number of items skipped before these items
The number of items per page