Create order
POST/openapi/2026-07/orders
Merchants can use this feature to create orders on behalf of their customers.
Request
- application/json
- Body
- Example
Bodyrequired
- Array [
- ]
1: express delivery2: local delivery3: store pickup- If you specify "COD" (Cash on Delivery) and the merchant has enabled this option, the order will use the Cash on Delivery payment method.
- If "COD" is disabled by the merchant, any value entered will default to the payment method configured in the store's admin settings.
- For completed payment orders, payment_line reflects the final payment method used.
- For unpaid orders, payment_line serves as a suggested payment method and may not represent the final payment method used during checkout.
0: follow system config1: send email2: do not send email0: follow system config1: send email2: do not send email0: follow system config1: send email2: do not send email0: follow system config1: send email2: do not send email
order objectrequired
Order
line_items object[]required
A list of products included in the order. Each line item contains details like product ID, variant ID, and quantity
Product ID
Variant ID
The quantity of the product being purchased
The price of the line item. If not provided, the price will be retrieved from the variant
Whether to apply discount to this line item. Defaults to true if not provided
Product title
Total price
shipping_address objectrequired
The recipient's delivery address, including name, phone, email, and location details such as street address, city, province, country, and postal code
First name of the recipient
Last name of the recipient
Email address of the recipient
Area code of the phone number
Recipient's phone number
Country where the order will be delivered (e.g., United States)
ISO country code (e.g., US)
Province or state (e.g., New Mexico)
Province code (e.g., NM)
Area or region of the address
City for delivery (e.g., San Jose)
The main street address for delivery (e.g., 1 Rue des Carrieres)
Additional address information (e.g., Suite 1234)
Company name associated with the address
ZIP or postal code for delivery (e.g., 87036)
CPF (Brazilian tax ID)
shipping_line objectrequired
Details of the shipping method selected for the order, including name, price, and description
Name of the shipping method (e.g., Free Shipping)
Description of the shipping method
Price of the shipping method (e.g., "10.00")
Delivery method:
business_info object
Business information
Remarks for store pickup time when the pickup time cannot be estimated
The total tax amount applied to the order, represented as a numeric string (e.g., "9.99")
The currency code for the order (e.g., USD)
Custom labels or tags for the order
Discount amount or percentage applied to the order (e.g., "10.00" or "10%")
A note about the order
The payment method used for the order
Additional order configuration information in JSON format, including multi-market settings, tax-inclusive pricing, etc
discount_application object
Discount application details for the order
The discount code applied to the order
The title or name of the discount
Whether to send the order confirmation notification to the customer:
Whether to send the order fulfillment notification to the customer:
Whether to send the partial fulfillment notification to the customer:
Whether to send the shipping delivered notification to the customer:
{
"order": {
"line_items": [
{
"product_id": "string",
"variant_id": "string",
"quantity": 0,
"price": "string",
"use_discount": true,
"product_title": "string",
"total_price": "string"
}
],
"shipping_address": {
"first_name": "string",
"last_name": "string",
"email": "string",
"phone_area_code": "string",
"phone": "string",
"country": "string",
"country_code": "string",
"province": "string",
"province_code": "string",
"area": "string",
"city": "string",
"address": "string",
"address1": "string",
"company": "string",
"zip": "string",
"cpf": "string"
},
"shipping_line": {
"shipping_name": "string",
"shipping_desc": "string",
"shipping_price": "string",
"delivery_method": 0,
"business_info": {
"time_remark": "string"
}
},
"tax_total": "string",
"currency_code": "string",
"tags": [
"string"
],
"discount": "string",
"note": "string",
"payment_line": "string",
"config": "string",
"discount_application": {
"discount_code": "string",
"title": "string"
},
"order_confirm_notify": 0,
"fulfillment_notify": 0,
"partial_fulfillment_notify": 0,
"order_delivered_notify": 0
}
}
Responses
- 200
OK
- application/json
- Schema
- Example
Schema
- If order.config.product_tax_included is true, the amount includes total_tax (excluding shipping_tax_total); otherwise, it excludes tax:
Formula: sub_total = sum(line_item.price * line_item.quantity)waiting: pending paymentpaying: payment under reviewauthorized: authorizedpartially_paid: partially paidpaid: paidcancelled: cancelledfailed: payment failedrefunding: refund in progressrefund_failed: refund failedrefunded: fully refundedpartially_refunded: partially refundedopened: pending paymentcancelled: cancelledplaced: in progressfinished: completedinitialled: initialwaiting: waiting to shippartially_shipped: partially shippedshipped: fully shippedpartially_finished: partially receivedfinished: fully receivedcancelled: cancelledreturning: return in progresspartially_returned: partially returnedreturned: fully returned- Array [
- Array [
- ]
- ]
- Array [
pending: pending shipmentshipped: shippedfinished: finishedcancelled: cancelled- Array [
- Array [
- ]
- ]
- Array [
- ]
- ]
pending: refund in progressfinished: refund completedfailed: refund failedwaiting: pending to sendsend: sentwaiting: waiting to be recalledsending: recall notification in progressrecalling: recall in progressfailed: recall failedsuccess: recall successful- Array [
- ]
- Array [
- ]
0: follow system config1: send email2: do not send email0: follow system config1: send email2: do not send email0: regular order1: gift card order
error code
error message
data object
order object
Order
Order ID
Time when the order was created (e.g., 2018-11-02T12:30:10Z)
Time when the order was last updated (e.g., 2018-11-02T12:30:10Z)
A custom note input by the merchant regarding the order
Order number
The final price paid by the customer, including taxes, discounts, tips, additional fee and shipping fees
The sum of the prices for all line items in the order
Currency code for the order
Payment status of the order:
Order status:
Time when the order was canceled
Reason for order cancellation
The payment method used for the order (e.g., apple_pay, credit_card, online)
Order fulfillment status:
Time when the customer associated with the order was deleted
Time when the order was deleted
Time when the order was paid
Custom tags added to the order by merchants or the system
Indicates whether the customer has agreed to receive marketing promotions
Total discount from discount codes applied to the order
A note provided by the customer during checkout
Total amount of discounts applied to the order, including product, shipping, and payment discounts
Total tax amount applied to the products in the order, excluding shipping tax
Total shipping fee for the order
line_items object[]
List of purchased products
Line item ID
Product associated with this line item ID
The name of the product purchased
Specific variant of the product ID
The title of the product variant, for example, "Blue, Size M"
The number of units of this product purchased
A note related to the product in this line item, added by the merchant or customer
image object
Image
The source URL of the image
The width of the image in pixels
The height of the image in pixels
Alt text for the image
Price
Compare-at price
Total price
The fulfillment status of this line item. For example, "fulfilled", "unfulfilled". See Fulfillment Status
Stock Keeping Unit (SKU) for the product variant, used for inventory tracking
Weight of the product
Unit of measurement for the product weight. For example, "kg", "lbs"
The vendor or supplier of the product
The URL of the product page for customers
Creation time, in ISO-8601 format
Last update time, in ISO-8601 format
options object[]
Product option values (a.k.a. variant option values) associated with this line item
Option name
Option value
URL-friendly identifier of the product
Whether the line item is taxable
Whether this line item requires shipping
Standard Product Unit (SPU)
Product tags
Refunded quantity for this line item
Whether the line item is a custom item
Trunk price
Number of discounts applied to the shipping for this line item
Tax of the line item
Duty cost
Price of payment discounts applied to the line item
Custom properties of the line item, such as size, color, etc. JSON format
payment_line object
Payment details
Payment line ID
The name of the payment channel for display purposes (e.g., PayPal, Credit Card)
The payment channel used for the transaction (e.g., PayPal, Stripe, Bank Transfer)
The specific method of payment used within the channel (e.g., Visa, MasterCard,online(e.g. paypal))
The last few digits of the credit card used
Transaction channel
Transaction method
The unique transaction number associated with this payment
Merchant email address
shipping_line object
Information about the shipping plan selected for the order
Shipping ID
Name
Description
Delivery method
billing_address object
Billing address
First name of consignee
Last name of consignee
The main street address for delivery (e.g., 1 Rue des Carrieres)
Additional address information (e.g., Suite 1234)
Phone number (e.g., +86 1231231234)
City (e.g., SAN JOSE)
ZIP code (e.g., 87036)
Province (e.g., New Mexico)
Country (e.g., United States)
Company (e.g., ABC Limited)
Latitude of the delivery address (e.g., 22.54)
Longitude of the delivery address (e.g., 114.06)
Name of consignee
Country code (e.g., US)
Province code (e.g., NM)
Area code (e.g., +86)
Email address
Area (e.g., Bay area)
extra_info object
Special shipping information fields, including tax ID, etc
addition object
Additional key-value items for special shipping information, such as tax ID fields
property name* AdditionItem
Name
Value
Personal tax ID
Tax text
shipping_address object
Delivery address
First name of consignee
Last name of consignee
The main street address for delivery (e.g., 1 Rue des Carrieres)
Additional address information (e.g., Suite 1234)
Phone number (e.g., +86 1231231234)
City (e.g., SAN JOSE)
ZIP code (e.g., 87036)
Province (e.g., New Mexico)
Country (e.g., United States)
Company (e.g., ABC Limited)
Latitude of the delivery address (e.g., 22.54)
Longitude of the delivery address (e.g., 114.06)
Name of consignee
Country code (e.g., US)
Province code (e.g., NM)
Area code (e.g., +86)
Email address
Area (e.g., Bay area)
extra_info object
Special shipping information fields, including tax ID, etc
addition object
Additional key-value items for special shipping information, such as tax ID fields
property name* AdditionItem
Name
Value
Personal tax ID
Tax text
fulfillments object[]
List of fulfillments
Fulfillment ID
Order's ID
Fulfillment status:
Creation time, in ISO-8601 format
Last update time, in ISO-8601 format
Logistics company
Tracking number
Logistics company code
line_items object[]
Line items included in this fulfillment
Line item ID
Product associated with this line item ID
The name of the product purchased
Specific variant of the product ID
The title of the product variant, for example, "Blue, Size M"
The number of units of this product purchased
A note related to the product in this line item, added by the merchant or customer
image object
Image
The source URL of the image
The width of the image in pixels
The height of the image in pixels
Alt text for the image
Price
Compare-at price
Total price
The fulfillment status of this line item. For example, "fulfilled", "unfulfilled". See Fulfillment Status
Stock Keeping Unit (SKU) for the product variant, used for inventory tracking
Weight of the product
Unit of measurement for the product weight. For example, "kg", "lbs"
The vendor or supplier of the product
The URL of the product page for customers
Creation time, in ISO-8601 format
Last update time, in ISO-8601 format
options object[]
Product option values (a.k.a. variant option values) associated with this line item
Option name
Option value
URL-friendly identifier of the product
Whether the line item is taxable
Whether this line item requires shipping
Standard Product Unit (SPU)
Product tags
Refunded quantity for this line item
Shipped quantity for this line item
Whether the line item is a custom item
Trunk price
Number of discounts applied to the shipping for this line item
Tax of the line item
Duty cost
Price of payment discounts applied to the line item
Custom properties of the line item, such as size, color, etc. JSON format
Tracking URL
Phone number
tracking_items object[]
List of tracking items included in this fulfillment
Tracking number
Logistics company
Logistics company code
Tracking URL
customer object
Customer details
Order ID
Email address
First name
Last name
Phone number
Time when the customer record was created (e.g., 2018-11-02T12:30:10Z)
Time when the customer record was last updated (e.g., 2018-11-02T12:30:10Z)
Number of orders
Total amount spent by the customer
Visit information
Sales channel
Total refund amount has been successfully processed, numeric string (e.g., "9.99")
primary_market_price object
Primary market price
The compare-at price in the main/store currency
The unit price in the main currency
The total price (main_currency_prices.price * quantity)
The actual exchange rate used for conversion
Total amount of tips received for the order
Details of discounts
Refund status:
The status of recall emails for the order:
The progress of an order recall process:
Total amount paid by the customer for the order
payment_lines object[]
List of payment lines
Payment line ID
The name of the payment channel for display purposes (e.g., PayPal, Credit Card)
The payment channel used for the transaction (e.g., PayPal, Stripe, Bank Transfer)
The specific method of payment used within the channel (e.g., Visa, MasterCard,online(e.g. paypal))
The last few digits of the credit card used
Transaction channel
Transaction method
The unique transaction number associated with this payment
Merchant email address
Gift card discount amount, numeric string (e.g., "9.99")
Logistics code
Total shipping tax amount of the order
location_line object
Merchant's warehouse address
Warehouse location ID
Identifier for the associated location
Name of the location, such as a store or warehouse
Total amount of additional charges, numeric string (e.g., "9.99")
additional_prices object[]
The detail list of additional charges
Name of the additional charge
Amount of the additional charge
Business ID
Custom Charge Name
config object
Order configuration information
Checkout page type (e.g., three_step)
Specifies whether the order requires shipping
Indicates whether product prices include taxes
market_setting object
Specifies market-specific configurations for the order (e.g., regional taxes, currency settings)
Primary market language
Market language (e.g., en-US)
Market configuration ID
Market currency code (e.g., USD)
market_currency_symbol object
Market currency symbol
Currency code (e.g., USD)
Currency symbol (e.g., $)
Content displayed to the left of the number (e.g., $)
Content displayed to the right of the number
Market base ID
Market base currency (e.g., USD)
market_base_currency_symbol object
Market base currency symbol
Currency code (e.g., USD)
Currency symbol (e.g., $)
Content displayed to the left of the number (e.g., $)
Content displayed to the right of the number
Primary market ID
Primary market currency code (e.g., USD)
primary_market_currency_symbol object
Primary market currency symbol
Currency code (e.g., USD)
Currency symbol (e.g., $)
Content displayed to the left of the number (e.g., $)
Content displayed to the right of the number
market_price_setting object
Market price settings
Local currency enable status
Custom rate enable status
Custom rate: primary market currency to market base currency
Rate: primary market currency to market base currency or local currency
Back rate: market base currency or local currency to primary market currency
Actual exchange rate: primary market currency to market base currency or local currency
Rate: market base currency to local currency
Local to rate
Price adjustment
Enable price rounding
Market country (e.g., US)
The checkout page URL for the order (including store domain)
Total customs duty and tax amount
Whether to send order confirmation notification
Whether to send the order fulfillment notification to the customer:
Whether to send the partial fulfillment notification to the customer:
Whether to send delivery notification
Time when the order was completed
Device
Order type:
First visited page
First touchpoint
Last visited page
Last touchpoint
Browser IP address
{
"code": "string",
"message": "string",
"data": {
"order": {
"id": "string",
"created_at": "string",
"updated_at": "string",
"note": "string",
"number": "string",
"total_price": "string",
"sub_total": "string",
"currency": "string",
"financial_status": "string",
"status": "string",
"cancelled_at": "string",
"cancel_reason": "string",
"payment_method": "string",
"fulfillment_status": "string",
"customer_deleted_at": "string",
"deleted_at": "string",
"placed_at": "string",
"tags": "string",
"buyer_accepts_marketing": true,
"code_discount_total": "string",
"customer_note": "string",
"total_discount": "string",
"total_tax": "string",
"total_shipping": "string",
"line_items": [
{
"id": "string",
"product_id": "string",
"product_title": "string",
"variant_id": "string",
"variant_title": "string",
"quantity": 0,
"note": "string",
"image": {
"src": "string",
"width": 0,
"height": 0,
"alt": "string"
},
"price": "string",
"compare_at_price": "string",
"total_price": "string",
"fulfillment_status": "string",
"sku": "string",
"weight": "string",
"weight_unit": "string",
"vendor": "string",
"product_url": "string",
"created_at": "string",
"updated_at": "string",
"options": [
{
"name": "string",
"value": "string"
}
],
"product_slug": "string",
"taxable": true,
"requires_shipping": true,
"spu": "string",
"product_tags": "string",
"refund_quantity_total": 0,
"custom": true,
"trunk_price": "string",
"discount_applications": "string",
"tax_price": "string",
"duty_price": "string",
"payment_discount_price": "string",
"custom_properties": {}
}
],
"payment_line": {
"id": "string",
"payment_name": "string",
"payment_channel": "string",
"payment_method": "string",
"credit_card_number": "string",
"trans_channel": "string",
"trans_method": "string",
"transaction_no": "string",
"merchant_email": "string"
},
"shipping_line": {
"id": "string",
"name": "string",
"desc": "string",
"delivery_method": 0
},
"billing_address": {
"first_name": "string",
"last_name": "string",
"address": "string",
"address1": "string",
"phone": "string",
"city": "string",
"zip": "string",
"province": "string",
"country": "string",
"company": "string",
"latitude": "string",
"longitude": "string",
"name": "string",
"country_code": "string",
"province_code": "string",
"phone_area_code": "string",
"email": "string",
"area": "string",
"extra_info": {
"addition": {},
"cpf": "string",
"tax_text": "string"
}
},
"shipping_address": {
"first_name": "string",
"last_name": "string",
"address": "string",
"address1": "string",
"phone": "string",
"city": "string",
"zip": "string",
"province": "string",
"country": "string",
"company": "string",
"latitude": "string",
"longitude": "string",
"name": "string",
"country_code": "string",
"province_code": "string",
"phone_area_code": "string",
"email": "string",
"area": "string",
"extra_info": {
"addition": {},
"cpf": "string",
"tax_text": "string"
}
},
"fulfillments": [
{
"id": "string",
"order_id": "string",
"status": "string",
"created_at": "string",
"updated_at": "string",
"tracking_company": "string",
"tracking_number": "string",
"tracking_company_code": "string",
"line_items": [
{
"id": "string",
"product_id": "string",
"product_title": "string",
"variant_id": "string",
"variant_title": "string",
"quantity": 0,
"note": "string",
"image": {
"src": "string",
"width": 0,
"height": 0,
"alt": "string"
},
"price": "string",
"compare_at_price": "string",
"total_price": "string",
"fulfillment_status": "string",
"sku": "string",
"weight": "string",
"weight_unit": "string",
"vendor": "string",
"product_url": "string",
"created_at": "string",
"updated_at": "string",
"options": [
{
"name": "string",
"value": "string"
}
],
"product_slug": "string",
"taxable": true,
"requires_shipping": true,
"spu": "string",
"product_tags": "string",
"refund_quantity_total": 0,
"ship_quantity": 0,
"custom": true,
"trunk_price": "string",
"discount_applications": "string",
"tax_price": "string",
"duty_price": "string",
"payment_discount_price": "string",
"custom_properties": {}
}
],
"tracking_url": "string",
"phone_number": "string",
"tracking_items": [
{
"tracking_number": "string",
"tracking_company": "string",
"tracking_company_code": "string",
"tracking_url": "string"
}
]
}
],
"customer": {
"id": "string",
"email": "string",
"first_name": "string",
"last_name": "string",
"phone": "string",
"created_at": "string",
"updated_at": "string",
"order_count": 0,
"total_spent": "string"
},
"refer_info": "string",
"sales_platform": "string",
"total_refund_price": "string",
"primary_market_price": {
"compare_at_price": "string",
"price": "string",
"total_price": "string",
"actual_rate": "string"
},
"total_tip_received": "string",
"discount_applications": "string",
"refund_status": "string",
"email_status": "string",
"recovery_status": "string",
"total_paid": "string",
"payment_lines": [
{
"id": "string",
"payment_name": "string",
"payment_channel": "string",
"payment_method": "string",
"credit_card_number": "string",
"trans_channel": "string",
"trans_method": "string",
"transaction_no": "string",
"merchant_email": "string"
}
],
"gift_card_total": "string",
"logistics_code": "string",
"shipping_tax_total": "string",
"location_line": {
"id": "string",
"location_id": "string",
"location_name": "string"
},
"additional_total": "string",
"additional_prices": [
{
"name": "string",
"price": "string",
"biz_id": "string",
"fee_title": "string"
}
],
"config": {
"page_type": "string",
"requires_shipping": true,
"product_tax_included": true,
"market_setting": {
"primary_market_lang": "string",
"market_lang": "string",
"market_id": "string",
"market_currency": "string",
"market_currency_symbol": {
"code": "string",
"val": "string",
"left": "string",
"right": "string"
},
"market_base_id": "string",
"market_base_currency": "string",
"market_base_currency_symbol": {
"code": "string",
"val": "string",
"left": "string",
"right": "string"
},
"primary_market_id": "string",
"primary_market_currency": "string",
"primary_market_currency_symbol": {
"code": "string",
"val": "string",
"left": "string",
"right": "string"
},
"market_price_setting": {
"local_currency_enabled": true,
"custom_rate_enabled": true,
"custom_rate": 0,
"rate": 0,
"back_rate": 0,
"actual_rate": 0,
"base_to_rate": 0,
"local_to_rate": 0,
"adjust": 0,
"price_round_enabled": true
},
"market_country": "string"
}
},
"checkout_url": "string",
"duty_total": "string",
"order_confirm_notify": 0,
"fulfillment_notify": 0,
"partial_fulfillment_notify": 0,
"order_delivered_notify": 0,
"finished_at": "string",
"device": "string",
"order_type": "string",
"source": "string",
"source_name": "string",
"last_landing_url": "string",
"last_referrer_show": "string",
"browser_ip": "string"
}
}
}