Create an order

Requires write_orders access scope.
For more info, refer to:
access permission.
POST https://{handle}.myshopline.com/admin/openapi/v20260301/orders.json
handle : The store's unique identifier, which is the prefix of the store's domain name. For example, if a store's domain name is open001.myshopline.com , the store handle is open001 .
Create an order.
Request Headers
  • Content-Type string required
    The field must be set to the fixed value application/json; charset=utf-8.
  • Authorization string required
    The access token for the API resource. Refer to App authorization to obtain the access token, and then pass the obtained token in the Bearer format.
    Example:
    Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw
Request Body
  • orderobject required
    Order information.
  • billing_addressobject
    The address for sending billing invoices.
  • address1 string
    The first line of the address. This typically includes information such as the street address or a post office box number.
    Maximum length: 256
    Example: Xiaoguwei Street
  • address2 string
    The second line of the address. This typically includes information such as apartment, suite, or unit number.
    Maximum length: 256
    Example: Apartment 5
  • area string
    The district or county in the address.
    Maximum length: 64
    Example: Panyu District
  • area_code string
    The code for the district or county in the address.
    Example: 510007
  • city string
    The city in the address.
    Maximum length: 64
    Example: Guangzhou City
  • city_code string
    The code for the city in the address.
    Example: 510000
  • company string
    The company name of the billing recipient.
    Example: Company Name
  • country string
    The country or region in the billing address.
    Maximum length: 64
    Example: China
  • country_code string
    A two-letter country or region code that follows the ISO 3166-1 standard, used to identify a specific country or region in the billing address.
    Example: US
  • email string
    The email of the billing recipient.
    Example: test001@Gmail.com
  • first_name string
    The first name of the billing recipient.
    Example: Tom
  • last_name string
    The last name of the billing recipient.
    Example: Washington
  • phone string
    The phone number of the billing recipient.
    Example: 13903004000
  • province string
    The province in the address.
    Example: Guangdong Province
  • province_code string
    The code for the province in the billing address, which can be a custom code or a two-digit ISO 3166-1 international code.
    Example: 4220006
  • same_as_receiver boolean
    Indicates whether the billing_address is the same as the shipping_address.
    • true: Indicates that both addresses are the same.
    • false: Indicates that the addresses are different.
    If this parameter is set to true, other parameters under billing_address, except for this parameter, do not need to be provided.
  • zip string
    The postal code information of the address.
    Example: 510036
  • buyer_note string
    Buyer's message.
    Example: message
  • company_location_id string
    Company location ID, used to create a B2B order.
    Example: 3232423438438
  • currency string
    The currency used by the buyer to place an order. The value of this parameter is a three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • customerobject
    Buyer information.
  • area_code string
    The area or country code for the phone number.
    Example: +86
  • email string
    The email of the buyer.
    Example: test001@Gmail.com
  • first_name string
    The first name of the buyer.
    Example: Tom
  • id string
    Buyer's ID.
    Maximum length: 64
    Example: 4201057495
  • last_name string
    The last name of the buyer.
    Example: Washington
  • phone string
    The phone number of the buyer.
    Example: 13903004000
  • customer_locale string
    Buyer's language code + country or region code. The language code follows the ISO 639 standard. Country or region code follows the ISO 3166-1 standard.
    Example: enCA
  • exchange_rate string
    The exchange rate between the order currency and the store currency.
    Example: 7.1245
  • financial_status string
    The payment status of the order. Valid values are:
    • unpaid: order not paid
    • partially_paid: order partially paid
    • paid: order paid
    Default value: unpaid
    Caution: The accuracy of the inputted value will be strictly validated. If the value fails validation, the order creation will fail and an error financial_status is invalid will be triggered.
  • fulfillment_status string
    The shipment status of the order. Valid values are:
    • unshipped: order not shipped
    • shipped: order shipped
    Default value: unshipped
    Caution: The accuracy of the inputted value will be strictly validated. If the value fails validation, the order creation will fail and an error fulfillment_status is invalid will be triggered.
  • inventory_behaviour string
    The inventory processing method. Valid values are:
    • bypass: skip inventory processing
    • decrement_ignoring_policy: deduct inventory regardless of the inventory policy configured by the merchant
    • decrement_obeying_policy: deduct inventory according to the inventory policy configured by the merchant
  • line_itemsobject[] required
    List of order product snapshot information.
    Maximum size: 100
  • discount_priceobject
    Product custom discount details.
  • amount string
    Discount amount. The value is rounded to two decimal places.
    Example: 1.00
  • title string
    Discount name.
    Example: Discount name
  • location_id string
    Product storage location ID.
    Example: 5445886274929439997
  • price string
    The product price amount. The value is rounded to two decimal places.
    Example: 3.25
  • product_id string
    SPU serial number.
    Example: 16056761559984840457934011
  • propertiesobject[]
    A list of product customization information.
  • name string
    Custom attribute name.
    Example: attribute name
  • show boolean
    Whether the customized information is visible:
    • true: visible
    • false: invisible Default value: false
  • type string
    Custom information type. Valid values are:
    • text: text type
    • picture: picture type
    • link: hyperlink type
  • urls array
    URL resource list.
    • If type is picture, thumbnails are rendered via the urls values.
    • If type is link, the hyperlink is the first URL in the urls values.
    Example: ["[\"https://www.url.com\"]"]
  • value string
    Custom attribute value.
    Example: attribute value
  • quantity long
    The quantity of the product.
    Example: 1
  • requires_shipping boolean
    Whether the product requires shipping.
    • true: shipping required
    • false: shipping not required
  • shipping_line_title string
    The title of the shipping plan that the product line matches. This field is required when shipping_lines is passed.
  • tax_lineobject
    The custom product tax information.
    If you specify this parameter, you must specify its child parameters price, rate, and title. The actual tax charge is based on the price parameter.
    If tax_line is not provided, the shipping is tax-exempt by default.
  • price string
    The tax amount. The actual tax collected on the product is based on this parameter value. The rate value is for display only.
    Example: 3.25
  • rate string
    The tax rate as a decimal value, rounded to four decimal places. For example, a 2% tax rate is represented as 0.0200. This field value is for display only.
  • title string
    The title for the tax description, for display only.
    Example: Tax name
  • taxable boolean
    Whether the product is subject to tax.
    • true: Tax is required.
    • false: No tax is required.
    Default value: true
  • title string
    Product title.
    Example: beautiful skirt
  • variant_id string
    A unique code assigned to a distinct product in inventory.
    Example: 18056761559987524812644011
  • market_region_country_code string
    The country or region code of the market where the order was placed. Follows the ISO 4217 standard.
    Example: US
  • name string
    Order number. Different from the order ID, this number can have a custom prefix set in the SHOPLINE Admin.
    Example: D101
  • note string
    Order remarks.
    Maximum length: 50
    DEPRECATED：This parameter is deprecated from API version v20210901.
    Example: Notes
  • note_attributesobject[]
    A list of merchant note logs.
  • name string
    Merchant ID, indicating the note source.
    Example: Note source
  • value string
    Note content.
    Example: Notes
  • order_note string
    Merchant order notes.
    Maximum length: 50
    Example: Notes
  • price_infoobject required
    Price information.
  • current_extra_total_discounts string
    Order discount amount, excluding discounts from discount codes. The value is rounded to two decimal places.
    Example: 8.00
  • taxes_included boolean
    Indicates whether this order includes taxes.
    • true: including tax
    • false: excluding tax
  • total_shipping_price string
    The total shipping fee for the order, displayed in the store currency. The value is rounded to two decimal places.
    Example: 8.00
  • processed_at string
    Order completion time. Format: ISO 8601.
    Example: 2023-04-12T22:59:52+08:00
  • send_fulfillment_receipt boolean
    Whether to send order shipping email.
    • true: send
    • false: do not send
  • send_receipt boolean
    Whether to send order confirmation email.
    • true: send
    • false: do not send
  • shipping_addressobject
    The address used for receiving packages.
  • address1 string
    The first line of the address. This typically includes information such as the street address or a post office box number.
    Maximum length: 255
    Example: Xiaoguwei Street
  • address2 string
    The second line of the address. This typically includes information such as apartment, suite, or unit number.
    Maximum length: 255
    Example: Apartment 5
  • area string
    The district or county in the address.
    Maximum length: 64
    Example: Panyu District
  • area_code string
    The code for the district or county in the address.
    Example: 510006
  • city string
    The city in the address.
    Maximum length: 64
    Example: Guangzhou City
  • city_code string
    The code for the city in the address.
    Example: 510000
  • company string
    The company name of the recipient.
    Example: Company Name
  • country string
    The country or region in the address.
    Maximum length: 64
    Example: China
  • country_code string
    A two-letter country or region code that follows the ISO 3166-1 standard, used to identify a specific country or region in the address.
    Example: CN
  • email string
    The email of the recipient.
    Example: test001@Gmail.com
  • first_name string
    The first name of the recipient.
    Maximum length: 64
    Example: Tom
  • last_name string
    The last name of the recipient.
    Maximum length: 64
    Example: Washington
  • latitude string
    The latitude where the address is located.
    Example: 43
  • longitude string
    The longitude where the address is located.
    Example: 34
  • phone string
    The phone number of the recipient.
    Example: 13903004000
  • province string
    The province in the address.
    Example: Guangdong Province
  • province_code string
    The code for the province in the address, which can be a custom code or a two-digit ISO 3166-2 international code.
    Example: 4220006
  • zip string
    The postal code information of the address.
    Example: 510036
  • shipping_lineobject
    Shipping fee information.
  • code string
    Logistics number.
    Example: SF
  • price string
    Shipping fee amount. The value is rounded to two decimal places.
    Example: 3.25
  • tax_lineobject
    The custom product tax information.
    If you specify this parameter, you must specify its child parameters price, rate, and title. The actual tax charge is based on the price parameter.
    If tax_line is not provided, the shipping is tax-exempt by default.
  • price string
    The tax amount. The actual tax collected on the product is based on this parameter value. The rate value is for display only.
    Example: 100
  • rate string
    The tax rate as a decimal value, rounded to four decimal places. For example, a 2% tax rate is represented as 0.0200. This field value is for display only.
  • title string
    The title for the tax description, for display only.
    Example: Tax name
  • title string
    Shipping fee name.
    Example: Shipping name
  • shipping_linesobject[]
    Shipping lines
  • price string
    Shipping amount
  • tax_lineobject
    Shipping tax details
  • price string
    Shipping amount
  • rate string
    The tax rate as a decimal value, rounded to four decimal places. For example, a 2% tax rate is represented as 0.0200. This field value is for display only.
  • title string
    Tax name
  • title string
    Shipping name
  • transaction_listobject[]
    A list of payments.
  • amount string
    Payment amount. The value is rounded to two decimal places.
    Example: 3.25
  • gateways string
    Payment channel used for the payment.
    Example: PayPal
  • processed_at string
    Payment creation time. Format: ISO 8601.
    Example: 2023-04-12T22:59:52+08:00
  • status string required
    Payment status. Valid values are:
    • unpaid: unpaid
    • failure: payment failed
    • success: payment successful
    • error: payment error
    Example: string
  • transactionsobject
    Payment information.
  • id string
    Payment method ID.
    Example: 424243
Status Codes
For the complete list of codes and messages, see Http status code.
Response Headers
  • traceId
    A globally unique identifier for the request. It is used to track the request flow throughout the system, allowing for easy location and debugging when issues arise.
Response Body
  • orderobject
    Order details.
  • adjust_price string
    The amount discrepancy due to rounding adjustments in POS transactions, expressed in the store currency.
    Example: 7.23
  • adjust_price_setobject
    The amount discrepancy due to rounding adjustments in POS transactions, displayed in both the buyer currency and the store currency.
  • presentment_moneyobject
    The amount discrepancy information presented to the buyer.
  • amount string
    The adjusted price amount. The value is rounded to two decimal places.
    Example: 3.25
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • shop_moneyobject
    The amount discrepancy information recorded by the merchant.
  • amount string
    The adjusted price amount. The value is rounded to two decimal places.
    Example: 3.25
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • billing_addressobject
    The address for sending billing invoices.
  • address1 string
    The first line of the address. This typically includes information such as the street address or a post office box number.
    Example: Xiaoguwei Street,
  • address2 string
    The second line of the address. This typically includes information such as apartment, suite, or unit number.
    Example: Apartment 5
  • city string
    The city in the address.
    Example: Guangzhou City
  • company string
    The company name of the billing recipient.
    Example: new company
  • country string
    The country or region in the address.
    Example: China
  • country_code string
    A two-letter country or region code that follows the ISO 3166-1 standard, used to identify a specific country or region in the address.
    Example: CN
  • first_name string
    The first name of the billing recipient.
    Example: Tom
  • last_name string
    The last name of the billing recipient.
    Example: Washington
  • phone string
    The phone number of the billing recipient.
    Example: 13100000000
  • province string
    The province in the address.
    Example: Guangdong Province
  • province_code string
    The code for the province in the billing address, which can be a custom code or a two-digit ISO 3166-2 international code.
    Example: 4200006
  • standard_province_code string
    The code for the province in the billing address, which is a two-digit ISO 3166-2 international code.This differs from province_code - the province_code response field uses a custom code.
  • zip string
    The postal code information of the address.
    Example: 510000
  • created_at string
    The date and time when the order was created. Format: ISO 8601.
    Example: 2021-08-16T08:27:57+00:00
  • currency string
    Transaction currency. A three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • current_subtotal_price string
    The total amount of products, calculated by multiplying the unit price by the quantity and displayed in the store currency.
    Example: 7.12
  • current_subtotal_price_setobject
    The total amount of products, calculated by multiplying the unit price by the quantity and displayed in both the buyer currency and the store currency.
  • presentment_moneyobject
    The order price information presented to the buyer.
  • amount string
    The order amount. The value is rounded to two decimal places.
    Example: 3.25
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • shop_moneyobject
    The order price information recorded by the merchant.
  • amount string
    The order amount. The value is rounded to two decimal places.
    Example: 3.25
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • current_total_discounts string
    The total discount amount in the store currency. It is calculated by adding marketing discounts and custom discounts, with the resulting amount rounded to two decimal places.
    Example: 0.25
  • current_total_discounts_setobject
    The total discount amount displayed in both the buyer currency and the store currency. It is calculated by adding marketing discounts and custom discounts, with the resulting amount rounded to two decimal places.
  • presentment_moneyobject
    The total discount amount information presented to the buyer.
  • amount string
    The total discount amount. The value is rounded to two decimal places.
    Example: 3.25
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • shop_moneyobject
    The total discount amount information recorded by the merchant.
  • amount string
    The total discount amount. The value is rounded to two decimal places.
    Example: 3.25
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • current_total_duties_setobject
    The total customs duties for the products, displayed in both the buyer currency and the store currency.
  • presentment_moneyobject
    The total customs duties information for the products presented to the buyer.
  • amount string
    The duty amount. The value is rounded to two decimal places.
    Example: 8.88
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • shop_moneyobject
    The total customs duties information for the products recorded by the merchant.
  • amount string
    The duty amount. The value is rounded to two decimal places.
    Example: 8.88
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • current_total_price string
    The total order amount, displayed in the store currency.
    Example: 1000.25
  • current_total_price_setobject
    The total order amount, displayed in both the buyer currency and the store currency.
  • presentment_moneyobject
    The order price information presented to the buyer.
  • amount string
    The total order amount. The value is rounded to two decimal places.
    Example: 3.25
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • shop_moneyobject
    The order price information recorded by the merchant.
  • amount string
    The total order amount. The value is rounded to two decimal places.
    Example: 3.25
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • current_total_tax string
    The total tax amount, displayed in the store currency.
    Example: 2.41
  • current_total_tax_setobject
    The total tax amount, displayed in both the buyer currency and the store currency.
  • presentment_moneyobject
    The tax information presented to the buyer.
  • amount string
    The tax amount. The value is rounded to two decimal places.
    Example: 1.03
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • shop_moneyobject
    The tax information recorded by the merchant.
  • amount string
    The tax amount. The value is rounded to two decimal places.
    Example: 1.03
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • customerobject
    Buyer information.
  • area_code string
    The area or country code for the phone number.
    Example: +86
  • currency string
    A three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • email string
    The email of the buyer.
    Example: test001@Gmail.com
  • first_name string
    The first name of the buyer.
    Example: Tom
  • id string
    Buyer's ID.
    Example: 4201057495
  • last_name string
    The last name of the buyer.
    Example: Washington
  • phone string
    The phone number of the buyer.
    Example: 13100000000
  • deduct_member_point_amount string
    The amount deducted from the order using member points, expressed in the store currency and rounded to two decimal places.
    Example: 3.25
  • deduct_member_point_amount_setobject
    The amount deducted from the order using member points, displayed in both the buyer currency and the store currency.
  • presentment_moneyobject
    The deduction amount information presented to the buyer.
  • amount string
    The deduction amount. The value is rounded to two decimal places.
    Example: 3.25
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • shop_moneyobject
    The deduction amount information recorded by the merchant.
  • amount string
    The deduction amount. The value is rounded to two decimal places.
    Example: 3.25
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • discount_codesobject
    Promo code information.
  • amount string
    Discount amount in the store currency. The value is rounded to two decimal places.
    Example: 3.25
  • code string
    Promo code.
    Example: 82UD6BTPX9L2
  • type string
    Type of discount. Valid values are:
    • 减金额: amount reduction
    • 打折: offer a discount
    • 免运费: free shipping
    • 加价品: add-on purchase deal
    • 任意N件优惠价: discount for purchasing any N items
    • A+B组合优惠价: discount for purchasing the product A and B combo
    • 赠品: free gift
    • 固定售价: fixed price
    • 最低价商品免费: lowest-priced product free
    • 打包价: package price
    • 第N件打折: discount on the Nth item
    • 买x送y: buy x and get y free
    • 自定义: custom discount
    Tip: The returned enum values are in Chinese.
  • email string
    Buyer's email.
    Example: test001@Gmail.com
  • financial_status string
    Order payment status. Valid values are:
    • unpaid: order not paid
    • authorized: order payment has been authorized
    • pending: order payment in progress
    • partially_paid: order partially paid
    • paid: order paid
    • partially_refunded: order partially refund
    • refunded: order refund
  • id string
    Order ID, system-defined number.
    Example: 21050224312121887324667162, 21050224312121887324667164
  • line_itemsobject[]
    A list of order product snapshot.
  • attribute string
    The option information of the product variant, composed of the variant name and the option value.
    Example: red
  • country_code_of_origin string
    Country or region code indicating the place of origin or shipping origin. Format: ISO 3166-1.
    Example: US
  • dutiesobject[]
    A list of duty information.
  • country_code_of_origin string
    Country or region code indicating the place of origin or shipping origin. Format: ISO 3166-1.
    Example: US
  • harmonized_system_code string
    Harmonized system code, used to categorize a product in international trade.
    Example: D2314244
  • id string
    Tariff number.
    Example: 3155232
  • priceobject
    The duty amount, displayed in both the buyer currency and the store currency.
  • presentment_moneyobject
    The duty amount information presented to the buyer.
  • amount string
    The duty amount. The value is rounded to two decimal places.
    Example: 8.88
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • shop_moneyobject
    The duty amount information recorded by the merchant.
  • amount string
    The duty amount. The value is rounded to two decimal places.
    Example: 8.88
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • tax_linesobject[]
    A list of tax information.
  • price_setobject
    The tax amount, displayed in both the buyer currency and the store currency.
  • presentment_moneyobject
    The tax amount information presented to the buyer.
  • amount string
    The tax amount. The value is rounded to two decimal places.
    Example: 8.88
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • shop_moneyobject
    The tax amount information recorded by the merchant.
  • amount string
    The tax amount. The value is rounded to two decimal places.
    Example: 8.88
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • rate double
    The tax rate as a decimal value, rounded to four decimal places. For example, a 2% tax rate is represented as 0.0200. This field value is for display only.
  • rate_percentage double
    The tax rate as a percentage numerical value, rounded to two decimal places. For example, a 2% tax rate is represented as 2.00. This field value is for display only.
  • title string
    The title for the tax description, for display only.
    Example: tariff
  • harmonized_system_code string
    Harmonized system code, used to categorize a product in international trade.
    Example: harmonized system code
  • id string
    The ID of the product snapshots table, generated by the system. Combined with the order.id, it uniquely identifies a product.
    Example: 3452
  • image_url string
    The URL address that stores the product image.
    Example: https://d2n979dmt31clo.cloudfront.net/image/store/4211449909/1667384795847/63928f08a7174ab2958c6a969
  • name string
    SKU title, same as title.
    Example: skirt
  • price string
    The product price in store currency. The value is rounded to two decimal places.
    Example: 100
  • price_setobject
    The product price, displayed in both the store currency and the buyer currency.
  • presentment_moneyobject
    The product price information presented to the buyer.
  • amount string
    The product price. The value is rounded to two decimal places.
    Example: 1.03
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • shop_moneyobject
    The product price information recorded by the merchant.
  • amount string
    The product price. The value is rounded to two decimal places.
    Example: 1.03
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • product_id string
    SPU serial number.
    Example: 16056761559984840457934011
  • propertiesobject[]
    A list of product customization information.
  • name string
    Custom attribute name.
    Example: attribute name
  • show boolean
    Whether the customized information is visible:
    • true: visible
    • false: invisible Default value: false
  • type string
    Custom information type. Valid values are:
    • text: text type
    • picture: picture type
    • link: hyperlink type
  • urls array
    URL resource list.
    • If type is picture, thumbnails are rendered via the urls values.
    • If type is link, the hyperlink is the first URL in the urls values.
    Example: ["[\"https://www.url.com\"]"]
  • value string
    Custom attribute value.
    Example: attribute value
  • quantity integer
    Quantity of items in the order.
    Example: 1
  • requires_shipping boolean
    Indicates whether the product is subject to shipping.
    • true：Shipping is required.
    • false：Shipping is not required.
  • sku string
    Product SKU serial number.
    Example: 18056761559987524812644011
  • tags string
    Product tags. Multiple tags are separated by commas.
    Example: watch
  • tax_linesobject[]
    A list of tax information.
  • name string
    Tax in store currency. The value is rounded to two decimal places.
    Example: taxes
  • price string
    Tax in store currency. The value is rounded to two decimal places.
    Example: 3.25
  • price_setobject
    The tax amount, displayed in both the buyer currency and the store currency.
  • presentment_moneyobject
    The tax amount information presented to the buyer.
  • amount string
    The tax amount. The value is rounded to two decimal places.
    Example: 1.03
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • shop_moneyobject
    The tax amount information recorded by the merchant.
  • amount string
    The tax amount. The value is rounded to two decimal places.
    Example: 1.03
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • rate double
    The tax rate as a decimal value, rounded to four decimal places. For example, a 2% tax rate is represented as 0.0200. This field value is for display only.
  • title string
    The title for the tax description, for display only.
    Example: taxes
  • taxable boolean
    Whether the product is subject to tax.
    • true: Tax is required.
    • false: No tax is required.
  • title string
    Product title.
    Example: beautiful skirt
  • variant_id string
    A unique code assigned to a distinct product in inventory.
    Example: 18056761559987524812644011
  • variant_title string
    Product variant value. Multiple values are separated by /.
    Example: 155 / red / large
  • vendor string
    Supplier.
    Example: Supplier
  • locationsobject[]
    A list of product pickup location addresses.
  • location_id string
    Unique code of the pickup location.
    Example: 5327026538935748524
  • name string
    Pickup location name.
    Example: us.street
  • type string
    Location types. Valid values are:
    • posLocation: The store location where the order was placed using the POS channel. It is recommended to use posLocationId, because posLocation will be deprecated soon.
    • pickupLocation: The store location for customer pickup when the order's delivery method is self-pickup.
    • productLocation: The inventory location of the products in the order. It is recommended to use the location information in the product line, because productLocation will be deprecated soon.
  • name string
    Store custom order number, starting from 1001. You can set a prefix for this value, such as test1001.
    Example: test1001
  • note string
    Merchant notes.
    Example: Notes
  • note_attributesobject[]
    A list of merchant note logs.
  • name string
    Merchant ID, indicating the note source.
    Example: Note source
  • value string
    Note content.
    Example: Notes
  • order_source string
    The order source channel handle. The handle is a semantic identifier.
  • order_status_url string
    Order status page URL.
    Example: https://shoptest.myshoplinestg.com/trade/thank_you?mainOrderMark=xxx&mainOrderSeq=200565776406008509
  • payment_detailsobject[]
    A list of order payment information.
  • pay_amount string
    Payment amount in the store currency. The value is rounded to two decimal places.
    Example: 3.25
  • pay_channel string
    Payment channel.
    Example: Paypal
  • pay_channel_deal_id string
    Payment serial number from the external channel.
    Example: pi_3MI897Hezv8FxjBO1uGxMPhX
  • pay_seq string
    Payment order number.
    Example: 23057287797738260472676128
  • pay_status string
    Payment status. Valid values are:
    • unpaid: unpaid
    • pending: payment in process
    • risking: under risk control
    • paid：paid
    • paid_overtime: payment timeout
    • paid_failed: payment failed
  • processed_at string
    Actual payment time. Format: ISO 8601.
    Example: 2023-04-12T22:59:52+08:00
  • phone string
    Buyer's mobile phone number.
    Example: 13900000000
  • po_number string
    Purchase order number for a B2B order.
  • pos_location_id string
    POS trading location ID.
    Example: 5327026538935748524
  • presentment_currency string
    Buyer currency, the same as the store currency. A three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • processed_at string
    Order completion time. Format: ISO 8601.
    Example: 2023-04-12T22:59:52+08:00
  • shipping_addressobject
    The address used for receiving packages.
  • address1 string
    The first line of the address. This typically includes information such as the street address or a post office box number.
    Example: Address 1
  • address2 string
    The second line of the address. This typically includes information such as apartment, suite, or unit number.
    Example: Address 2
  • city string
    The city in the address.
    Example: New York
  • company string
    The company name of the recipient.
    Example: New company name
  • country string
    The country or region in the address.
    Example: USA
  • country_code string
    A two-letter country or region code that follows the ISO 3166-1 standard, used to identify a specific country or region in the address.
    Example: US
  • district string
    The district in the address.
    Example: Manhattan
  • district_code string
    The district code in the address.
    Example: NY100xx
  • first_name string
    The first name of the recipient.
    Example: Tom
  • last_name string
    The last name of the recipient.
    Example: Washington
  • latitude string
    The latitude where the address is located.
    Example: 40.7831°N
  • longitude string
    The longitude where the address is located.
    Example: 73.9712°W
  • phone string
    The phone number of the recipient.
    Example: 19821119121
  • province string
    The province in the address.
    Example: New York state
  • province_code string
    The code for the province in the address, which can be a custom code or a two-digit ISO 3166-2 international code.
    Example: NY
  • standard_province_code string
    The code for the province in the billing address, which is a two-digit ISO 3166-2 international code.This differs from province_code - the province_code response field uses a custom code.
  • zip string
    The postal code information of the address.
    Example: 10007
  • status string
    Order status. Valid values are：
    • open: The order is processing.
    • canceled: The order is cancelled.
  • subtotal_price string
    The final price after discounts, calculated as the total product price minus any marketing discounts and custom discounts. The amount is displayed in the store currency.
    Example: 4.12
  • subtotal_price_setobject
    The final price after discounts, calculated as the total product price minus any marketing discounts and custom discounts. This field contains amounts displayed in both the buyer and store currencies.
  • presentment_moneyobject
    The final price information presented to the buyer.
  • amount string
    The final price. The value is rounded to two decimal places.
    Example: 4.12
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • shop_moneyobject
    The final price information recorded by the merchant.
  • amount string
    The final price. The value is rounded to two decimal places.
    Example: 4.12
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • tax_linesobject[]
    A list of tax information.
  • name string
    Tax name.
    Example: taxes
  • price string
    Tax in store currency. The value is rounded to two decimal places.
    Example: 3.25
  • price_setobject
    The tax amount, displayed in both the buyer currency and the store currency.
  • presentment_moneyobject
    The tax amount information presented to the buyer.
  • amount string
    The tax amount. The value is rounded to two decimal places.
    Example: 3.25
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • shop_moneyobject
    The tax amount information recorded by the merchant.
  • amount string
    The tax amount. The value is rounded to two decimal places.
    Example: 3.25
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • rate double
    The tax rate as a decimal value, rounded to four decimal places. For example, a 2% tax rate is represented as 0.0200. This field value is for display only.
  • title string
    The title for the tax description, for display only.
    Example: taxes
  • tax_number string
    Tax ID.
    Example: 111111111111
  • tax_type string
    The type of tax applicable to the order. Valid values are:
    • product_tax: product tax
    • shipping_tax: shipping tax
  • taxes_included boolean
    Indicates whether this order includes taxes.
    • true: including taxes
    • false: excluding taxes
  • total_discounts string
    The total order discount, calculated as the sum of marketing discounts and custom discounts. The amount is rounded to two decimal places and displayed in the store currency.
    DEPRECATED：This parameter is deprecated from API version v20210901.
    Example: 3.25
  • total_discounts_setobject
    The total order discount, calculated as the sum of marketing discounts and custom discounts. This field contains amounts displayed in both the buyer and store currencies.
    DEPRECATED：This parameter is deprecated from API version v20210901.
  • presentment_moneyobject
    The discount amount information presented to the buyer.
  • amount string
    The discount amount. The value is rounded to two decimal places.
    Example: 3.25
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • shop_moneyobject
    The discount amount information recorded by the merchant.
  • amount string
    The discount amount. The value is rounded to two decimal places.
    Example: 3.25
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • total_line_items_price string
    The total original price of the products, rounded to two decimal places, displayed in the store currency.
    Example: 3.25
  • total_line_items_price_setobject
    The total original price of the products, displayed in both the buyer currency and the store currency.
  • presentment_moneyobject
    The original price information presented to the buyer.
  • amount string
    The original price. The value is rounded to two decimal places.
    Example: 3.25
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • shop_moneyobject
    The original price information recorded by the merchant.
  • amount string
    The original price. The value is rounded to two decimal places.
    Example: 3.25
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • total_outstanding string
    The total unpaid amount in the store currency. The value is rounded to two decimal places.
    Example: 3.25
  • total_shipping_price_setobject
    The total shipping fee for the order, displayed in both the buyer currency and the store currency.
  • presentment_moneyobject
    The shipping fee information presented to the buyer.
  • amount string
    The shipping fee. The value is rounded to two decimal places.
    Example: 3.25
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • shop_moneyobject
    The shipping fee information recorded by the merchant.
  • amount string
    The shipping fee. The value is rounded to two decimal places.
    Example: 3.25
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • total_tax string
    The total tax amount in the store currency. The value is rounded to two decimal places.
    Example: 3.25
  • total_tax_setobject
    The total tax amount, displayed in both the buyer currency and the store currency.
  • presentment_moneyobject
    The tax amount information presented to the buyer.
  • amount string
    The tax amount. The value is rounded to two decimal places.
    Example: 3.25
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • shop_moneyobject
    The tax amount information recorded by the merchant.
  • amount string
    The tax amount. The value is rounded to two decimal places.
    Example: 3.25
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • total_tip_received string
    The tip amount in the store currency. The value is rounded to two decimal places.
    Example: 3.25
  • total_weight string
    The total weight of products in grams(g).
    Example: 1000
API Explorer
https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301

ParamOptions

— header required

Body

required
{
  "order": {
    "billing_address": {
      "address1": "Xiaoguwei Street",
      "address2": "Apartment 5",
      "area": "Panyu District",
      "area_code": "510007",
      "city": "Guangzhou City",
      "city_code": "510000",
      "company": "Company Name",
      "country": "China",
      "country_code": "US",
      "email": "test001@Gmail.com",
      "first_name": "Tom",
      "last_name": "Washington",
      "phone": "13903004000",
      "province": "Guangdong Province",
      "province_code": "4220006",
      "same_as_receiver": null,
      "zip": "510036"
    },
    "buyer_note": "message",
    "company_location_id": "3232423438438",
    "currency": "USD",
    "customer": {
      "area_code": "+86",
      "email": "test001@Gmail.com",
      "first_name": "Tom",
      "id": "4201057495",
      "last_name": "Washington",
      "phone": "13903004000"
    },
    "customer_locale": "enCA",
    "exchange_rate": "7.1245",
    "financial_status": null,
    "fulfillment_status": null,
    "inventory_behaviour": null,
    "line_items": [
      {
        "discount_price": {
          "amount": "1.00",
          "title": "Discount name"
        },
        "location_id": "5445886274929439997",
        "price": "3.25",
        "product_id": "16056761559984840457934011",
        "properties": [
          {
            "name": "attribute name",
            "show": null,
            "type": null,
            "urls": [
              "[\"https://www.url.com\"]"
            ],
            "value": "attribute value"
          }
        ],
        "quantity": 1,
        "requires_shipping": null,
        "shipping_line_title": null,
        "tax_line": {
          "price": "3.25",
          "rate": null,
          "title": "Tax name"
        },
        "taxable": null,
        "title": "beautiful skirt",
        "variant_id": "18056761559987524812644011"
      }
    ],
    "market_region_country_code": "US",
    "name": "D101",
    "note": "Notes",
    "note_attributes": [
      {
        "name": "Note source",
        "value": "Notes"
      }
    ],
    "order_note": "Notes",
    "price_info": {
      "current_extra_total_discounts": "8.00",
      "taxes_included": null,
      "total_shipping_price": "8.00"
    },
    "processed_at": "2023-04-12T22:59:52+08:00",
    "send_fulfillment_receipt": null,
    "send_receipt": null,
    "shipping_address": {
      "address1": "Xiaoguwei Street",
      "address2": "Apartment 5",
      "area": "Panyu District",
      "area_code": "510006",
      "city": "Guangzhou City",
      "city_code": "510000",
      "company": "Company Name",
      "country": "China",
      "country_code": "CN",
      "email": "test001@Gmail.com",
      "first_name": "Tom",
      "last_name": "Washington",
      "latitude": "43",
      "longitude": "34",
      "phone": "13903004000",
      "province": "Guangdong Province",
      "province_code": "4220006",
      "zip": "510036"
    },
    "shipping_line": {
      "code": "SF",
      "price": "3.25",
      "tax_line": {
        "price": "100",
        "rate": null,
        "title": "Tax name"
      },
      "title": "Shipping name"
    },
    "shipping_lines": [
      {
        "price": null,
        "tax_line": {
          "price": null,
          "rate": null,
          "title": null
        },
        "title": null
      }
    ],
    "transaction_list": [
      {
        "amount": "3.25",
        "gateways": "PayPal",
        "processed_at": "2023-04-12T22:59:52+08:00",
        "status": "string"
      }
    ],
    "transactions": {
      "id": "424243"
    }
  }
}

Language

curl --request POST \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/orders.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'
Was this article helpful to you?
SHOPLINE
SHOPLINE
SHOPLINE Enterprise
Legal
Privacy
Terms
Developer Agreement
LinkedInEmail
LinkedInEmail
© Copyright 2013-2025 SHOPLINE Limited.