order
1
Order Request API Basic Information
Request Method
Security Control
Request Parameters
Parameter Name
Description
Example/Default Value
{
"since_id": 0,
"limit": "100",
"created_at_min": "2025-09-01 00:00:00",
"created_at_max": "2025-09-05 23:59:59",
"updated_at_min": "2025-09-01 00:00:00",
"updated_at_max": "2025-09-05 23:59:59"
}Response Result
{
"orders": [
"order"
]
}2
Order Basic Structure (order)
{
"id": "Required, unique order identifier, numeric type,<=> webpixel checkout_completed event order.id",
"browser_ip": "Required, customer's IP address at checkout",
"client_details": {
"browser_ip": "Required, customer's browser IP address",
"user_agent": "Required, customer's browser User-Agent information"
},
"contact_email": "Required, customer's contact email",
"created_at": "Required, order creation time, ISO 8601 format",
"currency": "Required, order currency code",
"current_subtotal_price": "Required, current order subtotal amount, string type",
"current_subtotal_price_set": {
"shop_money": {
"amount": "Required, shop currency amount, string type",
"currency_code": "Required, shop currency code"
},
"presentment_money": {
"amount": "Required, presentment currency amount, string type",
"currency_code": "Required, presentment currency code"
}
},
"current_total_discounts": "Required, current order total discount amount, string type",
"current_total_discounts_set": {
"shop_money": {
"amount": "Required, shop currency discount amount, string type",
"currency_code": "Required, shop currency code"
},
"presentment_money": {
"amount": "Required, presentment currency discount amount, string type",
"currency_code": "Required, presentment currency code"
}
},
"current_total_duties_set": {
"shop_money": {
"amount": "Required, shop currency duties amount, string type",
"currency_code": "Required, shop currency code"
},
"presentment_money": {
"amount": "Required, presentment currency duties amount, string type",
"currency_code": "Required, presentment currency code"
}
},
"current_total_price": "Required, current order total amount, string type",
"current_total_price_set": {
"shop_money": {
"amount": "Required, shop currency total amount, string type",
"currency_code": "Required, shop currency code"
},
"presentment_money": {
"amount": "Required, presentment currency total amount, string type",
"currency_code": "Required, presentment currency code"
}
},
"current_total_tax": "Required, current order total tax amount, string type",
"current_total_tax_set": {
"shop_money": {
"amount": "Required, shop currency tax amount, string type",
"currency_code": "Required, shop currency code"
},
"presentment_money": {
"amount": "Required, presentment currency tax amount, string type",
"currency_code": "Required, presentment currency code"
}
},
"device_id": "Optional, device ID, null if none",
"discount_codes": "Required, discount codes list, empty array if none",
"duties_included": "Required, whether duties are included, boolean type",
"email": "Required, customer's email address",
"financial_status": "Required, order financial status (e.g., pending, authorized, partially_paid, paid, refunded, voided, partially_refunded)",
"fulfillment_status": "Optional, order fulfillment status, null if none (fulfilled, null, partial, restocked)",
"landing_site": "Required, customer's landing site URL",
"landing_site_ref": "Optional, landing site reference identifier, null if none",
"name": "Required, order name,display name",
"payment_gateway_names": "Required, payment gateway names list, array",
"phone": "Optional, customer phone number, null if none",
"presentment_currency": "Required, presentment currency code",
"processed_at": "Required, order processing time, ISO 8601 format",
"reference": "Required, order reference identifier",
"referring_site": "Required, order referring site URL, empty string if none",
"source_identifier": "Optional, order source identifier",
"source_name": "Required, order source name (e.g., web)",
"source_url": "Optional, order source URL, null if none",
"subtotal_price": "Required, order subtotal amount, string type",
"subtotal_price_set": {
"shop_money": {
"amount": "Required, shop currency subtotal amount, string type",
"currency_code": "Required, shop currency code"
},
"presentment_money": {
"amount": "Required, presentment currency subtotal amount, string type",
"currency_code": "Required, presentment currency code"
}
},
"tags": "Required, order tags, empty string if none",
"test": "Required, whether test order, boolean type",
"total_discounts": "Required, order total discounts amount, string type",
"total_discounts_set": {
"shop_money": {
"amount": "Required, shop currency total discounts amount, string type",
"currency_code": "Required, shop currency code"
},
"presentment_money": {
"amount": "Required, presentment currency total discounts amount, string type",
"currency_code": "Required, presentment currency code"
}
},
"total_line_items_price": "Required, order line items total amount, string type",
"total_line_items_price_set": {
"shop_money": {
"amount": "Required, shop currency line items total amount, string type",
"currency_code": "Required, shop currency code"
},
"presentment_money": {
"amount": "Required, presentment currency line items total amount, string type",
"currency_code": "Required, presentment currency code"
}
},
"total_price": "Required, order total amount, string type",
"total_price_set": {
"shop_money": {
"amount": "Required, shop currency total amount, string type",
"currency_code": "Required, shop currency code"
},
"presentment_money": {
"amount": "Required, presentment currency total amount, string type",
"currency_code": "Required, presentment currency code"
}
},
"total_shipping_price_set": {
"shop_money": {
"amount": "Required, shop currency shipping amount, string type",
"currency_code": "Required, shop currency code"
},
"presentment_money": {
"amount": "Required, presentment currency shipping amount, string type",
"currency_code": "Required, presentment currency code"
}
},
"total_tax": "Required, order total tax amount, string type",
"total_tax_set": {
"shop_money": {
"amount": "Required, shop currency total tax amount, string type",
"currency_code": "Required, shop currency code"
},
"presentment_money": {
"amount": "Required, presentment currency total tax amount, string type",
"currency_code": "Required, presentment currency code"
}
},
"updated_at": "Required, order update time, ISO 8601 format",
"billing_address": {
"first_name": "Required, billing address first name",
"address1": "Required, billing address line 1",
"phone": "Optional, billing address phone number, null if none",
"city": "Required, billing address city",
"zip": "Required, billing address postal code",
"province": "Required, billing address province",
"country": "Required, billing address country",
"last_name": "Required, billing address last name",
"address2": "Optional, billing address line 2, null if none",
"company": "Optional, billing address company name, null if none",
"latitude": "Optional, billing address latitude, null if none",
"longitude": "Optional, billing address longitude, null if none",
"name": "Required, billing address full name",
"country_code": "Required, billing address country code",
"province_code": "Required, billing address province code"
},
"customer": {
"id": "Required, unique customer identifier, numeric type, webpixel checkout_completed event order.customer.id",
"email": "Required, customer email address",
"created_at": "Required, customer creation time, ISO 8601 format",
"updated_at": "Required, customer update time, ISO 8601 format",
"first_name": "Required, customer first name",
"last_name": "Required, customer last name",
"state": "Required, customer status (e.g., disabled)",
"note": "Optional, customer notes, null if none",
"phone": "Optional, customer phone number, null if none",
"tags": "Required, customer tags, empty string if none",
"currency": "Required, customer currency code",
"default_address": {
"id": "Required, default address unique identifier, numeric type",
"customer_id": "Required, associated customer ID, numeric type",
"first_name": "Required, default address first name",
"last_name": "Required, default address last name",
"company": "Optional, default address company name, null if none",
"address1": "Required, default address line 1",
"address2": "Optional, default address line 2, null if none",
"city": "Required, default address city",
"province": "Required, default address province",
"country": "Required, default address country",
"zip": "Required, default address postal code",
"phone": "Optional, default address phone number, null if none",
"name": "Required, default address full name",
"province_code": "Required, default address province code",
"country_code": "Required, default address country code",
"country_name": "Required, default address country name",
"default": "Required, whether default address, boolean type"
}
},
"line_items": [
{
"id": "Required, line item unique identifier, numeric type",
"name": "Required, line item name",
"price": "Required, line item unit price, string type",
"price_set": {
"shop_money": {
"amount": "Required, shop currency unit price amount, string type",
"currency_code": "Required, shop currency code"
},
"presentment_money": {
"amount": "Required, presentment currency unit price amount, string type",
"currency_code": "Required, presentment currency code"
}
},
"product_id": "Required, associated product ID, numeric type",
"quantity": "Required, line item quantity, numeric type",
"sku": "Required, line item SKU, empty string if none",
"title": "Required, line item title",
"total_discount": "Required, line item total discount amount, string type",
"total_discount_set": {
"shop_money": {
"amount": "Required, shop currency total discount amount, string type",
"currency_code": "Required, shop currency code"
},
"presentment_money": {
"amount": "Required, presentment currency total discount amount, string type",
"currency_code": "Required, presentment currency code"
}
},
"variant_id": "Required, associated product variant ID, numeric type",
"variant_title": "Optional, variant title, null if none",
"vendor": "Optional, vendor name"
}
],
"shipping_address": {
"first_name": "Required, shipping address first name",
"address1": "Required, shipping address line 1",
"phone": "Optional, shipping address phone number, null if none",
"city": "Required, shipping address city",
"zip": "Required, shipping address postal code",
"province": "Required, shipping address province",
"country": "Required, shipping address country",
"last_name": "Required, shipping address last name",
"address2": "Optional, shipping address line 2, null if none",
"company": "Optional, shipping address company name, null if none",
"latitude": "Required, shipping address latitude, numeric type",
"longitude": "Required, shipping address longitude, numeric type",
"name": "Required, shipping address full name",
"country_code": "Required, shipping address country code",
"province_code": "Required, shipping address province code"
}
}3
Order Sample Data
{
"id": 123456789,
"browser_ip": "192.168.1.1",
"client_details": {
"browser_ip": "192.168.1.1",
"user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36"
},
"contact_email": "[email protected]",
"created_at": "2025-09-01T10:00:00Z",
"currency": "USD",
"current_subtotal_price": "100.00",
"current_subtotal_price_set": {
"shop_money": {
"amount": "100.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "100.00",
"currency_code": "USD"
}
},
"current_total_discounts": "10.00",
"current_total_discounts_set": {
"shop_money": {
"amount": "10.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "10.00",
"currency_code": "USD"
}
},
"current_total_duties_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"current_total_price": "95.00",
"current_total_price_set": {
"shop_money": {
"amount": "95.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "95.00",
"currency_code": "USD"
}
},
"current_total_tax": "5.00",
"current_total_tax_set": {
"shop_money": {
"amount": "5.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "5.00",
"currency_code": "USD"
}
},
"device_id": null,
"discount_codes": ["SUMMER20"],
"duties_included": false,
"email": "[email protected]",
"financial_status": "paid",
"fulfillment_status": "fulfilled",
"landing_site": "https://example.com/products/item1",
"landing_site_ref": null,
"name": "#1001",
"payment_gateway_names": ["Shopify Payments"],
"phone": "123-456-7890",
"presentment_currency": "USD",
"processed_at": "2025-09-01T10:05:00Z",
"reference": "REF12345",
"referring_site": "https://google.com",
"source_identifier": null,
"source_name": "web",
"source_url": null,
"subtotal_price": "100.00",
"subtotal_price_set": {
"shop_money": {
"amount": "100.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "100.00",
"currency_code": "USD"
}
},
"tags": "VIP, First Purchase",
"test": false,
"total_discounts": "10.00",
"total_discounts_set": {
"shop_money": {
"amount": "10.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "10.00",
"currency_code": "USD"
}
},
"total_line_items_price": "100.00",
"total_line_items_price_set": {
"shop_money": {
"amount": "100.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "100.00",
"currency_code": "USD"
}
},
"total_price": "95.00",
"total_price_set": {
"shop_money": {
"amount": "95.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "95.00",
"currency_code": "USD"
}
},
"total_shipping_price_set": {
"shop_money": {
"amount": "0.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "0.00",
"currency_code": "USD"
}
},
"total_tax": "5.00",
"total_tax_set": {
"shop_money": {
"amount": "5.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "5.00",
"currency_code": "USD"
}
},
"updated_at": "2025-09-01T10:10:00Z",
"billing_address": {
"first_name": "John",
"address1": "123 Main St",
"phone": "123-456-7890",
"city": "New York",
"zip": "10001",
"province": "New York",
"country": "United States",
"last_name": "Doe",
"address2": "Apt 4B",
"company": "Example Inc",
"latitude": 40.7128,
"longitude": -74.0060,
"name": "John Doe",
"country_code": "US",
"province_code": "NY"
},
"customer": {
"id": 987654321,
"email": "[email protected]",
"created_at": "2025-08-01T00:00:00Z",
"updated_at": "2025-09-01T10:00:00Z",
"first_name": "John",
"last_name": "Doe",
"state": "enabled",
"note": null,
"phone": "123-456-7890",
"tags": "VIP",
"currency": "USD",
"default_address": {
"id": 111222333,
"customer_id": 987654321,
"first_name": "John",
"last_name": "Doe",
"company": "Example Inc",
"address1": "123 Main St",
"address2": "Apt 4B",
"city": "New York",
"province": "New York",
"country": "United States",
"zip": "10001",
"phone": "123-456-7890",
"name": "John Doe",
"province_code": "NY",
"country_code": "US",
"country_name": "United States",
"default": true
}
},
"line_items": [
{
"id": 111111,
"name": "Product 1",
"price": "50.00",
"price_set": {
"shop_money": {
"amount": "50.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "50.00",
"currency_code": "USD"
}
},
"product_id": 222222,
"quantity": 2,
"sku": "PROD-001",
"title": "Product 1 Title",
"total_discount": "10.00",
"total_discount_set": {
"shop_money": {
"amount": "10.00",
"currency_code": "USD"
},
"presentment_money": {
"amount": "10.00",
"currency_code": "USD"
}
},
"variant_id": 333333,
"variant_title": "Blue, Medium",
"vendor": "Example Vendor"
}
],
"shipping_address": {
"first_name": "John",
"address1": "123 Main St",
"phone": "123-456-7890",
"city": "New York",
"zip": "10001",
"province": "New York",
"country": "United States",
"last_name": "Doe",
"address2": "Apt 4B",
"company": "Example Inc",
"latitude": 40.7128,
"longitude": -74.0060,
"name": "John Doe",
"country_code": "US",
"province_code": "NY"
}
}