Create an order

Requires write_orders access scope.

For more info , refer to:

[]

access permission

POST https://{handle}.myshopline.com/admin/openapi/v20250601/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 Order

Request Headers

Content-Type required
[]
The value of this field is fixed to application/json; charset=utf-8
Authorization string required
[]
The access token for the API. Please refer to App authorization to obtain the access token, and then put the obtained access token into the API request header in Bearer Token.
Example:
[]
Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

Request Body

orderobject required
[]
order information
billing_addressobject
[]
billing address
address1 string
[]
Detailed address of bill recipient (maximum 255 characters)
[]
Example: Nancun Wanbo, Panyu District, Guangzhou City, Guangdong Province
address2 string
[]
Billing recipient address details appended (maximum 255 characters)
[]
Example: Xiaoguwei Street, Panyu District, Guangzhou City, Guangdong Province
area string
[]
Bill recipient district and county (maximum 64 characters)
[]
Example: Panyu District
area_code string
[]
Bill recipient district and county code
[]
Example: 510007
city string
[]
Bill recipient city (maximum 64 characters)
[]
Example: Guangzhou City
city_code string
[]
Bill recipient city code
[]
Example: 510000
company string
[]
Company Name
[]
Example: Company Name
country string
[]
Billing recipient country (maximum 64 characters)
[]
Example: China
country_code string
[]
Bill recipient country code
[]
Example: CN
email string
[]
Bill recipient email
[]
Example: test001@Gmail.com
first_name string
[]
Bill recipient name
[]
Example: Tom
last_name string
[]
Bill Recipient Last Name
[]
Example: Washington
phone string
[]
Bill recipient’s name and mobile phone number
[]
Example: 13903004000
province string
[]
Bill recipient name province
[]
Example: Guangdong Province
province_code string
[]
Billing consignee state or province code, custom code, or two-letter code abbreviation (ISO-3166-2).
[]
Example: 4220006
same_as_receiver boolean
[]
Is it the same as the receipt information (other parameters that are the same do not need to be passed)
[]
Example: true
zip string
[]
Bill recipient name zip code
[]
Example: 510036
buyer_note string
[]
Buyer's message
[]
Example: message
company_location_id string
[]
B2B Company Location ID
[]
Example: 3232423438438
currency string
[]
Order currency, only store currency is supported, strong verification will be performed
[]
Example: USD
customerobject
[]
Buyer information
area_code string
[]
User mobile phone number area code
[]
Example: +86
email string
[]
User mailbox
[]
Example: test001@Gmail.com
first_name string
[]
First name
[]
Example: Tom
id string
[]
User ID
[]
Example: 4201057495
last_name string
[]
Last name
[]
Example: Washington
phone string
[]
User mobile phone number
[]
Example: 13903004000
customer_locale string
[]
Language
[]
Example: en
exchange_rate string
[]
Order amount conversion exchange rate
[]
Example: 7.1245
financial_status string
[]
Non-required fields, the default is not paid. Strong verification enumeration value. If the enumeration value verification fails, the creation of the order fails, and an error is reported: financial_status is invalid unpaid - not paid; partially_paid - partially paid; paid - paid.
[]
Example: paid
fulfillment_status string
[]
Non-required fields, unshipped by default. Strong verification of enumeration values. If the enumeration value verification fails, the order creation fails and an error is reported: fulfillment_status is invalid. unshipped-unshipped; shipped-shipped
[]
Example: shipped
inventory_behaviour string
[]
Inventory processing method, supports three enumerations: ① bypass: do not process inventory ② decrement_ignoring_policy: deduct inventory (not affected by the inventory policy configured by the merchant) ③ decrement_obeying_policy: deduct inventory according to the inventory policy configured by the merchant
[]
Example: bypass
line_itemsobject[] required
[]
Order product snapshot information
discount_priceobject
[]
Product custom discount details
amount string
[]
Discount amount
[]
Example: 1.00
title string
[]
Discount name
[]
Example: Discount name
location_id string
[]
location information
[]
Example: 5445886274929439997
price string
[]
Commodity price, precision 2
[]
Example: 3.25
product_id string
[]
SPU serial number
[]
Example: 16056761559984840457934011
quantity long
[]
Quantity of items in the order
[]
Example: 1
requires_shipping boolean
[]
Whether transportation is required
[]
Example: true
tax_lineobject
[]
1)If you want to customize the tax fees for the product, please provide values for “price/rate/title”, and the tax will be based on the specified “price” 2) If these values are not filled in, the tax will not be calculated for the product.
price string
[]
When you provide the tax fee value, the product tax will be calculated based on that amount. The tax rate you provide will be used for display purposes only.
[]
Example: 3.25
rate string
[]
The tax rate is used for display purposes only. For example, if the tax rate is 2%, you would input 0.02.
[]
Example: 0.02
title string
[]
Tax title, only for display
[]
Example: Tax name
taxable boolean
[]
Tax or not？
title string
[]
Product title
[]
Example: beautiful skirt
variant_id string
[]
Product SKU serial number
[]
Example: 18056761559987524812644011
market_region_country_code string
[]
Order market country code
[]
Example: US
name string
[]
Order custom number
[]
Example: D101
note string
[]
Order remarks, maximum 50 characters
[]
Example: Notes
note_attributesobject[]
[]
Additional information
name string
[]
Name
[]
Example: Note source
value string
[]
content
[]
Example: Notes
order_note string
[]
order notes
[]
Example: Notes
price_infoobject required
[]
price information
current_extra_total_discounts string
[]
Order discount amount, non-discount code amount
[]
Example: 8.00
taxes_included boolean
[]
Whether it is a tax-included order, the default is false
total_shipping_price string
[]
Shipping fee, dubbo string with precision 2
[]
Example: 8.00
processed_at string
[]
Order completion time, format: 2023-04-12T22:59:52+08:00
[]
Example: 2023-04-12T22:59:52+08:00
send_fulfillment_receipt boolean
[]
Whether to send order shipping email
[]
Example: true
send_receipt boolean
[]
Whether to send order confirmation email
[]
Example: true
shipping_addressobject
[]
Consignee address information
address1 string
[]
Consignee’s detailed address (maximum 255 characters)
[]
Example: Nancun Wanbo, Panyu District, Guangzhou City, Guangdong Province
address2 string
[]
Consignee detailed address appended (maximum 255 characters)
[]
Example: Xiaoguwei Street, Panyu District, Guangzhou City, Guangdong Province
area string
[]
Consignee’s district and county name (maximum 64 characters)
[]
Example: Panyu District
area_code string
[]
Consignee district and county code
[]
Example: 510006
city string
[]
Consignee city name (maximum 64 characters)
[]
Example: Guangzhou City
city_code string
[]
Consignee city code
[]
Example: 510000
company string
[]
Company Name
[]
Example: Company Name
country string
[]
Consignee's country name (less than 64 characters)
[]
Example: China
country_code string
[]
Country or region, please refer to the country code
[]
Example: CN
email string
[]
Consignee’s contact email
[]
Example: test001@Gmail.com
first_name string
[]
Consignee name (maximum 64 characters)
[]
Example: Tom
last_name string
[]
Consignee’s last name (maximum 64 characters)
[]
Example: Washington
latitude string
[]
latitude
[]
Example: 43
longitude string
[]
longitude
[]
Example: 34
phone string
[]
Consignee contact information (maximum 32 characters)
[]
Example: 13903004000
province string
[]
Consignee province (maximum 64 characters)
[]
Example: Guangdong Province
province_code string
[]
Consignee state or province code, custom code, or two-letter code abbreviation (ISO-3166-2).
[]
Example: 4220006
zip string
[]
Postal code
[]
Example: 510036
shipping_lineobject
[]
Shipping information
code string
[]
Logistics number
[]
Example: SF
price string
[]
Freight amount, precision 2 digits
[]
Example: 3.25
tax_lineobject
[]
Shipping tax details
price string
[]
The tax amount and pricing are based on this, with an accuracy of two digits.
[]
Example: 100
rate string
[]
Tax rate, precision to two digits
[]
Example: 0.02
title string
[]
Tax name
[]
Example: Tax name
title string
[]
Shipping name
[]
Example: Shipping name
transaction_listobject[]
[]
Payment order list
amount string
[]
Payment order amount
[]
Example: 3.25
gateways string
[]
Payment channels
[]
Example: PayPal
processed_at string
[]
Payment creation time, format: 2023-04-12T22:59:52+08:00
[]
Example: 2023-04-12T22:59:52+08:00
status string required
[]
Payment status, enumeration value: unpaid\failure\success\error
[]
Example: success
transactionsobject
[]
Payment slip information
id string
[]
Payment method ID
[]
Example: 424243

Response

[]

For more information about status codes, see Http status code.

Response Headers

traceId
[]
traceId

Response Body

orderobject
[]
order information
adjust_price string
[]
Adjustment amount
[]
Example: 7.23
adjust_price_setobject
[]
Adjustment amount
presentment_moneyobject
[]
Buyer side amount information
amount string
[]
Amount
[]
Example: 3.25
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side amount information
amount string
[]
Amount
[]
Example: 3.25
currency_code string
[]
Currency
[]
Example: USD
billing_addressobject
[]
Billing address information
address1 string
[]
Detailed address 1
[]
Example: Nancun Wanbo, Panyu District, Guangzhou City, Guangdong Province
address2 string
[]
Detailed address 2, optional
[]
Example: Xiaoguwei Street, Guangzhou City, Guangdong Province
city string
[]
City
[]
Example: Guangzhou City
company string
[]
Company Name
[]
Example: new company
country string
[]
Country
[]
Example: China
country_code string
[]
Country code
[]
Example: CN
first_name string
[]
Last name
[]
Example: Tom
last_name string
[]
First name
[]
Example: Washington
phone string
[]
Phone
[]
Example: 13100000000
province string
[]
Province
[]
Example: Guangdong Province
province_code string
[]
State or province code, custom code, or two-letter code abbreviation (ISO-3166-2).
[]
Example: 4200006
zip string
[]
Postal code
[]
Example: 510000
created_at string
[]
Order creation time (see IOS8601 for the format)
[]
Example: 2021-08-16T08:27:57+00:00
currency string
[]
Transaction currency
[]
Example: USD
current_subtotal_price string
[]
Sum of current products, total price of products * quantity
[]
Example: 7.12
current_subtotal_price_setobject
[]
Multi-currency information of the current commodity sum, the buyer's and seller's currency and the amount are the same
presentment_moneyobject
[]
Buy side currency
amount string
[]
Amount
[]
Example: 3.25
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side currency
amount string
[]
Amount
[]
Example: 3.25
currency_code string
[]
Currency
[]
Example: USD
current_total_discounts string
[]
Sum of discounts, precision 2, marketing offers + artificial discounts
[]
Example: 0.25
current_total_discounts_setobject
presentment_moneyobject
[]
Currency information
amount string
[]
Amount
[]
Example: 3.25
currency_code string
[]
Currency information
[]
Example: USD
shop_moneyobject
[]
Sell side amount
amount string
[]
Amount
[]
Example: 3.25
currency_code string
[]
Currency information
[]
Example: USD
current_total_duties_setobject
[]
Current Product total duty
presentment_moneyobject
[]
Buyer side amount information
amount string
[]
Amount
[]
Example: 8.88
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side amount information
amount string
[]
Amount
[]
Example: 8.88
currency_code string
[]
Currency
[]
Example: USD
current_total_price string
[]
Current order total, value logic: total product - total discount + shipping + tax
[]
Example: 1000.25
current_total_price_setobject
[]
Multi-currency information of the current order total, the buyer's and seller‘s currency and the amount are the same
presentment_moneyobject
[]
Currency information
amount string
[]
Amount
[]
Example: 3.25
currency_code string
[]
Currency information
[]
Example: USD
shop_moneyobject
[]
Sell side amount
amount string
[]
Amount
[]
Example: 3.25
currency_code string
[]
Currency information
[]
Example: USD
current_total_tax string
[]
Total tax, product tax + shipping tax
[]
Example: 2.41
current_total_tax_setobject
[]
Multi-currency information of the sum of taxes, the currency and amount of buyers and sellers are the same
presentment_moneyobject
[]
Currency information
amount string
[]
Currency information
[]
Example: 1.03
currency_code string
[]
Currency information
[]
Example: USD
shop_moneyobject
[]
Sell side amount
amount string
[]
Currency information
[]
Example: 1.03
currency_code string
[]
Currency information
[]
Example: USD
customerobject
[]
Buyer information
area_code string
[]
Phone area code
[]
Example: +86
currency string
[]
Currency
[]
Example: USD
email string
[]
User mailbox
[]
Example: test001@Gmail.com
first_name string
[]
First name
[]
Example: Tom
id string
[]
User ID
[]
Example: 4201057495
last_name string
[]
Last name
[]
Example: Washington
phone string
[]
User mobile phone number
[]
Example: 13100000000
deduct_member_point_amount string
[]
Current order membership credit
[]
Example: 3.25
deduct_member_point_amount_setobject
[]
Current order member points deduction amount, multi-currency information
presentment_moneyobject
[]
Currency information
amount string
[]
Currency amount information
[]
Example: 3.25
currency_code string
[]
Currency information
[]
Example: USD
shop_moneyobject
[]
Sell side amount
amount string
[]
Currency amount information
[]
Example: 3.25
currency_code string
[]
Currency information
[]
Example: USD
discount_codesobject
[]
Promo code information
amount string
[]
Discount amount, precision 2
[]
Example: 3.25
code string
[]
Promo code
[]
Example: 82UD6BTPX9L2
type string
[]
Type of discount, reduced amount; discount; free shipping; fixed price; the lowest price item is free; package price; the Nth item is discounted;
[]
Example: manual
email string
[]
Buyer's email
[]
Example: test001@Gmail.com
financial_status string
[]
Payment status, unpaid, authorized, pending, partially_paid, paid, partially_refunded, refunded
[]
Example: unpaid
id string
[]
System order number
[]
Example: 21050224312121887324667162, 21050224312121887324667164
line_itemsobject[]
[]
Order product snapshot information
attribute string
[]
Product attributes : name-attribute value multiple comma " , " division like : color-red , size-x
[]
Example: red
country_code_of_origin string
[]
Country of origin
[]
Example: Country of origin
dutiesobject[]
[]
Duty information
country_code_of_origin string
[]
Country code of origin/shipping point
[]
Example: UK
harmonized_system_code string
[]
Customs code
[]
Example: D2314244
id string
[]
Tariff number
[]
Example: 3155232
priceobject
[]
Tariff multi-currency information
presentment_moneyobject
[]
Buyer side amount information
amount string
[]
Amount
[]
Example: 8.88
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side amount information
amount string
[]
Amount
[]
Example: 8.88
currency_code string
[]
Currency
[]
Example: USD
tax_linesobject[]
[]
Tax details list
price_setobject
[]
Multi-currency information of tax
presentment_moneyobject
[]
Buyer side amount information
amount string
[]
Amount
[]
Example: 8.88
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side amount information
amount string
[]
Amount
[]
Example: 8.88
currency_code string
[]
Currency
[]
Example: USD
rate double
[]
Tax rate
[]
Example: 0.08
rate_percentage double
[]
Tax rate (percentage value, i.e. rate * 100)
[]
Example: 8
title string
[]
Tax title
[]
Example: tariff
harmonized_system_code string
[]
harmonized system code
[]
Example: harmonized system code
image_url string
[]
product picture
[]
Example: https://d2n979dmt31clo.cloudfront.net/image/store/4211449909/1667384795847/63928f08a7174ab2958c6a969
name string
[]
SKU title, same as title
[]
Example: skirt
price string
[]
Commodity price, precision 2
[]
Example: 100
price_setobject
[]
Product selling price , multi-currency information
presentment_moneyobject
[]
Buy side currency
amount string
[]
Amount
[]
Example: 1.03
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side currency
amount string
[]
Amount
[]
Example: 1.03
currency_code string
[]
Currency
[]
Example: USD
product_id string
[]
SPU serial number
[]
Example: 16056761559984840457934011
propertiesobject[]
[]
Product customization information
name string
[]
Custom attribute name
[]
Example: Attribute name
type string
[]
Attribute type, text-character, the display format is name: value; picture-picture, the display type is name: get the rendered thumbnail through URLs; link-hyperlink, the display type is name: value, supports clicking on the link to jump to urls First
[]
Example: text
urls string
[]
URL resource list
[]
Example: https://www.url.com
value string
[]
Custom attribute values
[]
Example: attribute value
quantity integer
[]
Quantity of items in the order
[]
Example: 1
requires_shipping boolean
[]
Shipping or not
[]
Example: true
sku string
[]
Product code, barCode
[]
Example: 18056761559987524812644011
tags string
[]
Product tags (multiple commas separated)
[]
Example: watch
tax_linesobject[]
[]
Tax information
name string
[]
Tax name
[]
Example: taxes
price string
[]
Tax, precision 2
[]
Example: 3.25
price_setobject
[]
Multi-currency information of tax
presentment_moneyobject
[]
Buy side currency
amount string
[]
Amount
[]
Example: 1.03
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side currency
amount string
[]
Amount
[]
Example: 1.03
currency_code string
[]
Currency
[]
Example: USD
rate double
[]
Tax rate
[]
Example: 1
title string
[]
Tax description
[]
Example: taxes
taxable boolean
[]
Tax or not？
[]
Example: true
title string
[]
Product title
[]
Example: beautiful skirt
variant_id string
[]
Product SKU serial number
[]
Example: 18056761559987524812644011
variant_title string
[]
Commodity attribute value, multiple divided by " / ", such as: "155 / red / large"
[]
Example: 155 / red / large
vendor string
[]
Supplier
[]
Example: Supplier
locationsobject[]
[]
Order location information
location_id string
[]
Location ID
[]
Example: 5327026538935748524
name string
[]
Place name
[]
Example: us.street
type string
[]
Location type. 1.posLocation: The store location where the order was created through the POS channel (it is recommended to use posLocationId, which will be abandoned later) 2.pickupLocation: When the delivery method of the order is self-pickup, the store location for self-pickup 3.productLocation: The inventory location of the goods in the order (It is recommended to use the location information in the product line, which will be abandoned later)
[]
Example: posLocation
name string
[]
Custom order number
[]
Example: test1001
note string
[]
Merchant notes
[]
Example: Notes
note_attributesobject[]
[]
Additional information
name string
[]
Note source
[]
Example: Note source
value string
[]
Notes
[]
Example: Notes
order_source string
[]
Order source channels
[]
Example: pos
order_status_url string
[]
Order status page URL
[]
Example: https://shoptest.myshoplinestg.com/trade/thank_you?mainOrderMark=xxx&mainOrderSeq=200565776406008509
payment_detailsobject[]
[]
Payment slip information
pay_amount string
[]
Payment amount
[]
Example: 3.25
pay_channel string
[]
Payment channels
[]
Example: Paypal
pay_channel_deal_id string
[]
External channel payment serial number
[]
Example: pi_3MI897Hezv8FxjBO1uGxMPhX
pay_seq string
[]
Payment slip number
[]
Example: 23057287797738260472676128
pay_status string
[]
Payment slip status
[]
Example: unpaid
processed_at string
[]
Payment creation time, format: 2023-04-12T22:59:52+08:00
[]
Example: 2023-04-12T22:59:52+08:00
phone string
[]
Buyer contact information
[]
Example: 13900000000
po_number string
[]
Purchase order number recorded on the order in B2B scenarios
pos_location_id string
[]
Pos transaction location
[]
Example: 5327026538935748524
presentment_currency string
[]
Buy side currency
[]
Example: USD
processed_at string
[]
Order completion time, format: 2023-04-12T22:59:52+08:00
[]
Example: 2023-04-12T22:59:52+08:00
shipping_addressobject
[]
Shipping address
address1 string
[]
Detailed address 1
[]
Example: Address 1
address2 string
[]
Detailed address 2, optional
[]
Example: Address 2
city string
[]
City
[]
Example: New York
company string
[]
Company Name
[]
Example: New company name
country string
[]
Country
[]
Example: USA
country_code string
[]
Country code
[]
Example: US
district string
[]
District
[]
Example: Manhattan
district_code string
[]
District code
[]
Example: NY100xx
first_name string
[]
Last name
[]
Example: Tom
last_name string
[]
First name
[]
Example: Washington
latitude string
[]
latitude
[]
Example: 40.7831°N
longitude string
[]
longitude
[]
Example: 73.9712°W
phone string
[]
Phone
[]
Example: 19821119121
province string
[]
Province
[]
Example: New York state
province_code string
[]
State or province code, custom code, or two-letter code abbreviation (ISO-3166-2).
[]
Example: NY
zip string
[]
Postal code
[]
Example: 10007
status string
[]
Order status open=processing, canceled-cancelled
[]
Example: open
subtotal_price string
[]
Total product price after discount, total product price - marketing discount - artificial discount
[]
Example: 4.12
subtotal_price_setobject
[]
Multi-currency information of total product price after discount
presentment_moneyobject
[]
Buyer side amount information
amount string
[]
Amount
[]
Example: 4.12
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side amount information
amount string
[]
Amount
[]
Example: 4.12
currency_code string
[]
Currency
[]
Example: USD
tax_linesobject[]
[]
Tax information
name string
[]
Tax name
[]
Example: taxes
price string
[]
Tax, precision 2
[]
Example: 3.25
price_setobject
[]
Multi-currency information of tax
presentment_moneyobject
[]
Buyer side amount information
amount string
[]
Amount
[]
Example: 3.25
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side amount information
amount string
[]
Amount
[]
Example: 3.25
currency_code string
[]
Currency
[]
Example: USD
rate double
[]
Tax rate
[]
Example: 1
title string
[]
Tax description
[]
Example: taxes
tax_number string
[]
TIN
[]
Example: 111111111111
tax_type string
[]
Types of tax ID
[]
Example: type
taxes_included boolean
[]
Does the total include tax?
[]
Example: true
total_discounts string
[]
Total discount, marketing discount + artificial discount
[]
Example: 3.25
total_discounts_setobject
[]
Multi-currency information of discount total
presentment_moneyobject
[]
Buyer side amount information
amount string
[]
Amount
[]
Example: 3.25
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side amount information
amount string
[]
Amount
[]
Example: 3.25
currency_code string
[]
Currency
[]
Example: USD
total_line_items_price string
[]
Sum of original prices of goods, precision 2
[]
Example: 3.25
total_line_items_price_setobject
[]
Sum of original price of goods, multi-currency information
presentment_moneyobject
[]
Sell side amount information
amount string
[]
Amount
[]
Example: 3.25
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side amount information
amount string
[]
Amount
[]
Example: 3.25
currency_code string
[]
Currency
[]
Example: USD
total_outstanding string
[]
Sum of unpaid amount, precision 2
[]
Example: 3.25
total_shipping_price_setobject
[]
Order shipping sum, multi-currency information
presentment_moneyobject
[]
Buyer side amount information
amount string
[]
Amount
[]
Example: 3.25
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side amount information
amount string
[]
Amount
[]
Example: 3.25
currency_code string
[]
Currency
[]
Example: USD
total_tax string
[]
Sum of taxes, precision 2, commodity tax + shipping tax
[]
Example: 3.25
total_tax_setobject
[]
Total taxes and fees, multi-currency information
presentment_moneyobject
[]
Buyer side amount information
amount string
[]
Amount
[]
Example: 3.25
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side amount information
amount string
[]
Amount
[]
Example: 3.25
currency_code string
[]
Currency
[]
Example: USD
total_tip_received string
[]
Tip, precision 2
[]
Example: 3.25
total_weight string
[]
Total product weight ( g )
[]
Example: 1000

API Explorer

Debugger

Base URL

https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601

ParamOptions

Authorization — header required

Body

Body required

{
  "order": {
    "billing_address": {
      "address1": "Nancun Wanbo, Panyu District, Guangzhou City, Guangdong Province",
      "address2": "Xiaoguwei Street, Panyu District, Guangzhou City, Guangdong Province",
      "area": "Panyu District",
      "area_code": "510007",
      "city": "Guangzhou City",
      "city_code": "510000",
      "company": "Company Name",
      "country": "China",
      "country_code": "CN",
      "email": "test001@Gmail.com",
      "first_name": "Tom",
      "last_name": "Washington",
      "phone": "13903004000",
      "province": "Guangdong Province",
      "province_code": "4220006",
      "same_as_receiver": true,
      "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": "en",
    "exchange_rate": "7.1245",
    "financial_status": "paid",
    "fulfillment_status": "shipped",
    "inventory_behaviour": "bypass",
    "line_items": [
      {
        "discount_price": {
          "amount": "1.00",
          "title": "Discount name"
        },
        "location_id": "5445886274929439997",
        "price": "3.25",
        "product_id": "16056761559984840457934011",
        "quantity": 1,
        "requires_shipping": true,
        "tax_line": {
          "price": "3.25",
          "rate": "0.02",
          "title": "Tax name"
        },
        "taxable": false,
        "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": false,
      "total_shipping_price": "8.00"
    },
    "processed_at": "2023-04-12T22:59:52+08:00",
    "send_fulfillment_receipt": true,
    "send_receipt": true,
    "shipping_address": {
      "address1": "Nancun Wanbo, Panyu District, Guangzhou City, Guangdong Province",
      "address2": "Xiaoguwei Street, Panyu District, Guangzhou City, Guangdong Province",
      "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": "0.02",
        "title": "Tax name"
      },
      "title": "Shipping name"
    },
    "transaction_list": [
      {
        "amount": "3.25",
        "gateways": "PayPal",
        "processed_at": "2023-04-12T22:59:52+08:00",
        "status": "success"
      }
    ],
    "transactions": {
      "id": "424243"
    }
  }
}

Language

curl --request POST \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601/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

Legal