Query order

Requires read_orders access scope.

For more info , refer to:

[]

access permission

GET https://{handle}.myshopline.com/admin/openapi/v20240301/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 .

[]

Query order details in batches based on request conditions

Query Parameters

buyer_id string
[]
Order user id
[]
Example: 4201057495
contract_ids string
[]
Subscription contract ID, multiples separated by commas, up to 50 supported
[]
Example: 3005619945158043247856
created_at_max string
[]
Order creation time ( end ) ( format see ISO 8601 )
[]
Example: 2021-08-18T23:59:59+08:00
created_at_min string
[]
Order creation time ( start ) ( format see ISO 8601 )
[]
Example: 2021-08-04T23:59:59+08:00
email string
[]
Email of the user who placed the order
[]
Example: Washingtontest@gmail.com
fields string
[]
The fields to be queried, separated by commas, do not pass all field information, currently all fields are returned
[]
Example: id
financial_status string
[]
Payment status: unpaid-unpaid; pending-pending; partially_paid-partially paid; paid-paid; partially_refunded-partially refunded; refunded-refunded;
[]
Example: unpaid
fulfillment_status string
[]
Shipping status, unshipped-unshipped; partial-partially shipped; shipped-shipped;
[]
Example: unshipped
hidden_order boolean
[]
Whether it is an archived order, true=archived order, false=unarchived order
ids string
[]
Order numbers, separated by commas, up to 100
[]
Example: "21050224312121887324667162, 21050224312121887324667164"
limit integer
[]
Query quantity limit, default 50, cannot exceed 100
[]
Example: 10
location string
[]
The location (or POS trading point) where the goods in the order are fulfilled, supporting multiple locations , separated by ","
[]
Example: 5453386037065169090,5564834083287605454
name string
[]
Custom order number
[]
Example: D2034
page_info string
[]
The encrypted request parameters are used for the previous page and the next page, and the field is directly parsed and accessed.
[]
Example: 7AFD7393C6E7CF18672C038477E2EF6A463464BDBAF766DD8F8CB8E0085F82419A94B80084BCDA0B838B3F13C302A2C9044E
search_content string
[]
Search content, involving order number, payment serial number, express delivery number, product name, product SKU number, order amount
[]
Example: D203
since_id string
[]
The starting position of the order number ID of the data to be queried
[]
Example: 21056199447626881527947685
sort_condition string
[]
Sorting : format such as : order_at : desc , id : asc multi sorting and comma segmentation ;Sorting rules : such as order_at : desc , id : asc , first in order_at , and then in order to be order_at ; currently support order_at , id sortingco
[]
Example: order_at:desc
status string
[]
Order status, open-processing, canceled-cancelled, any-including any status, including archived;
[]
Example: open
updated_at_max string
[]
Order update time ( end ) ( format see ISO 8601 )
[]
Example: 2021-08-18T23:59:59+08:00
updated_at_min string
[]
Order update time ( start ) ( format see ISO 8601 )
[]
Example: 2021-08-04T23:59:59+08:00

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

Response

[]

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

Response Headers

link
[]
Contain the request parameters of the previous page and the next page
traceId
[]
traceId

Response Body

ordersobject[]
[]
Datasheets
adjust_price string
[]
Adjust the amount ( store currency amount ) , the balanced amount brought by the amount rounded up under the pos scenario
[]
Example: 8.00
adjust_price_setobject
[]
Adjustment amount information based on store currency and transaction currency
presentment_moneyobject
[]
Buyer side amount information
amount string
[]
Amount, Precision 2
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side amount information
amount string
[]
Amount, Precision 2
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
billing_addressobject
[]
Billing address information
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
first_name string
[]
Last name
[]
Example: Tom
last_name string
[]
First name
[]
Example: Washington
name string
[]
Full name
[]
Example: test1001
phone string
[]
Phone
[]
Example: 13100000000
province string
[]
Province
[]
Example: California
province_code string
[]
Province code
[]
Example: 4200006
zip string
[]
Postal code
[]
Example: 92503
browser_ip string
[]
Client IP
[]
Example: 157.119.232.35
buyer_note string
[]
Buyer's message
[]
Example: message
cancel_reason string
[]
Seller's reason for cancellation
[]
Example: I don't want to buy it.
cancelled_at string
[]
Order cancellation time ( end ) ( format see ISO 8601 ) , 2012-05-01T14 : 22 : 25-04 : 00
[]
Example: 2012-05-01T14:22:25-04:00
cart_token string
[]
shopping cart token
[]
Example: c2c4a58186b9d96395d7e6b5c2969577
checkout_id string
[]
abandoned order id
[]
Example: 2404785166526352972864
checkout_token string
[]
Checkout page token
[]
Example: c2c4a58186b9d96395d7e6b5c2969577
client_detailsobject
[]
Client Details
browser_ip string
[]
Browser address
[]
Example: 157.119.232.35
session_hash string
[]
Member session encryption information
[]
Example: c2c4a58186b9d96395d7e6b5c2969577
user_agent string
[]
Client Proxy
[]
Example: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/106.0.0.0 Sa
companyobject
[]
Company info
id string
[]
Company id
[]
Example: 1005619945158043247856
location_id string
[]
Location id
[]
Example: 3005619945158043247856
tax_registration_id string
[]
Tax registration id
[]
Example: 213213
contract_seq string
[]
Subscription contract number
[]
Example: 3005619945158043247856
created_at string
[]
Order creation time , system record ( format see ISO 8601 )
[]
Example: 2021-08-16T08:27:57+00:00
credit_limitobject
[]
credit payment
credit_limit_currency string
[]
Currency of the credit limit, currently in store currency
[]
Example: USD
is_credit_limit boolean
[]
Whether the order used credit payment true: Used false: Not used
[]
Example: true
outstanding_credit_limit string
[]
Total credit limit occupied by the order
[]
Example: 1.00
total_credit_limit string
[]
Total credit limit used for the order
[]
Example: 1.00
currency string
[]
Transaction currency
[]
Example: "USD"
current_subtotal_price string
[]
Current Product total ( store currency amount ) , Product total
[]
Example: "78.0"
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: 8.00
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side currency
amount string
[]
Amount
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
current_total_discounts string
[]
Discount total ( store currency amount ) , accuracy 2 , marketing Discount + manual discount
[]
Example: "0.0"
current_total_discounts_setobject
presentment_moneyobject
[]
Currency information
amount string
[]
Amount
[]
Example: 8.00
currency_code string
[]
Currency information
[]
Example: USD
shop_moneyobject
[]
Sell side amount
amount string
[]
Amount, Precision 2
[]
Example: 8.00
currency_code string
[]
Currency code
[]
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 ( store currency amount ) , value logic : Product total-Discount total + shipping + tax
[]
Example: “60.0”
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: 8.00
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side amount
amount string
[]
Amount
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
current_total_tax string
[]
Total tax ( store currency amount ) , product tax + shipping tax
[]
Example: "0.0"
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
[]
Buy side currency
amount string
[]
Amount
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side currency
amount string
[]
Amount
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
customerobject
[]
Buyer information
addressesobject
[]
Buyer address information
address1 string
[]
Detailed address 1
[]
Example: Wanda
address2 string
[]
Detailed address 2, optional
[]
Example: 65788
city string
[]
City
[]
Example: Yangquan City
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
name string
[]
Full name
[]
Example: D203
phone string
[]
Phone
[]
Example: 13100000000
province string
[]
Province
[]
Example: Shanxi Province
province_code string
[]
Province code
[]
Example: asd
zip string
[]
Postal code
[]
Example: 521000
area_code string
[]
Phone area code
[]
Example: +86
created_at string
[]
Buyer creation time ( format see ISO 8601 )
[]
Example: 2022-11-04T10:18:46+00:00
currency string
[]
Currency
[]
Example: USD
email string
[]
User mailbox
[]
Example: Washingtontest@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
updated_at string
[]
Buyer update time
[]
Example: 2022-11-04T10:18:46+00:00
customer_locale string
[]
Buyer country, language code + country name abbreviation
[]
Example: "enCN"
deduct_member_point_amount string
[]
Current order membership credit amount ( store currency amount )
[]
Example: 8.00
deduct_member_point_amount_setobject
[]
Current order membership credit to the amount , multi-currency amount information
presentment_moneyobject
[]
Current order membership credit to the amount , market amount information
amount string
[]
Current order membership credit to the marketplace amount
[]
Example: 8.00
currency_code string
[]
Market currency
[]
Example: CNY
shop_moneyobject
[]
Current order membership credit amount , store amount information
amount string
[]
Current order membership credit to the store amount
[]
Example: 1.00
currency_code string
[]
Store currency
[]
Example: USD
discount_applicationsobject[]
[]
discount information
allocation_method string
[]
The scope of distribution authorization 1) across (the value is distributed among all authorization rows) 2) each (the value applies to each authorization row) allocation_method
[]
Example: across
code string
[]
discount code
[]
Example: 82UD6BTPX9L2
description string
[]
Custom discount description
[]
Example: Custom discount description
target_selection string
[]

explicit (discount is assigned to explicitly selected rows) 2) all (discount is assigned to all rows) 3) ENTITLED (discount is assigned only to rows for which it has permission)

[]
Example: explicit
target_type string
[]

line_item, shipping_line

[]
Example: line_item
title string
[]
Automatic discount title
[]
Example: Automatic discount title
type string
[]
Discount type, 1) manual 2) automatic 3) discount_code
[]
Example: manual
value string
[]
The specific value of the discount (it can be N discount, or it can be a specific amount value, store currency amount)
[]
Example: 2.01
value_type string
[]
Explain the type of value
[]
Example: fixed_amount
discount_codesobject[]
[]
Promo code information
amount string
[]
Discount amount ( store currency amount ) , accuracy 2
[]
Example: 8.00
amount_setobject
[]
Discount marketplace amount information
presentment_moneyobject
[]
Marketplace amount information
amount string
[]
Discount amount , market amount
[]
Example: 70.00
currency_code string
[]
Market currency
[]
Example: CNY
shop_moneyobject
[]
Store amount information
amount string
[]
Discount amount
[]
Example: 10.00
currency_code string
[]
Store currency
[]
Example: USD
code string
[]
Promo code
[]
Example: KIN4GNAB2FRH
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: Reduction amount
email string
[]
Buyer's mailbox, there must be one of the two
[]
Example: hok@shoplineapp.com
financial_status string
[]
Payment status, unpaid, authorized, pending, partially_paid, paid, partially_refunded, refunded
[]
Example: "paid"
fulfillment_status string
[]
Shipping status, fulfilled-shipped; partial-partially shipped; null-unshipped; Note: the returned enum value is different from the query enumeration value of the input parameter
[]
Example: "fulfilled"
fulfillmentsobject[]
[]
Package information
created_at string
[]
Create time ( format see ISO 8601 )
[]
Example: 2022-11-04T10:18:46+00:00
id string
[]
Package number
[]
Example: 22046737798141702810214336
line_itemsobject[]
[]
Product list
attribute string
[]
Product attributes : name-attribute value multiple comma " , " division like : color-red , size-x
[]
Example: red
fulfillable_quantity integer
[]
Available quantity
[]
Example: 1
fulfillment_quantity integer
[]
The number of shipments
[]
Example: 1
fulfillment_service string
[]
Logistics company name
[]
Example: SF Express
fulfillment_status string
[]
The shipping status of the product, shipping status, fulfilled-shipped; partial-partially shipped; null-unshipped;
[]
Example: Not shipped
grams double
[]
Weight ( grams )
[]
Example: 100
id string
[]
The ID of the product snapshot table, generated by the system, uniquely confirms a product with the order number
[]
Example: 100
image_url string
[]
product picture
[]
Example: https://d2n979dmt31clo.cloudfront.net/image/store/4211449909/1667384795847/63928f08a7174ab2958c6a969
location_id string
[]
Unique code of pickup location
[]
Example: 5445886274929439997
name string
[]
SKU title, same as title
[]
Example: Product name
price string
[]
Commodity price, precision 2
[]
Example: 10.00
price_setobject
[]
Product selling price , multi-currency amount information
presentment_moneyobject
[]
Marketplace amount information
amount string
[]
Product selling price , market currency price
[]
Example: 70.0
currency_code string
[]
Market currency
[]
Example: CNY
shop_moneyobject
[]
Store amount information
amount string
[]
Product selling price , store currency price
[]
Example: 10.00
currency_code string
[]
Currency
[]
Example: USD
product_id string
[]
SPU serial number
[]
Example: 16056761559984840457934011
quantity integer
[]
Quantity of items in the order
[]
Example: 1
requires_shipping boolean
[]
Shipping or not
[]
Example: true
sku string
[]
Product code, barCode
[]
Example: test-002
tax_linesobject[]
[]
Tax information
price string
[]
Tax, precision 2
[]
Example: 8.00
price_setobject
[]
Multi-currency information of tax
presentment_moneyobject
[]
Currency information
amount string
[]
Description amount
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side amount information
amount string
[]
Amount
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
rate double
[]
Tax rate
[]
Example: 1
title string
[]
Tax name
[]
Example: taxes
taxable boolean
[]
Tax or not？
title string
[]
Product title
[]
Example: Useful product
variant_id string
[]
Product SKU serial number
[]
Example: 18056761559987524812644011
variant_title string
[]
Commodity attribute value, multiple divided by " / ", such as: "155 / red / large"
[]
Example: big
vendor string
[]
Supplier
[]
Example: Supplier
name string
[]
Invoice short number
[]
Example: 1032-F2
order_id string
[]
Order number
[]
Example: 21056577640603870897253153
shipment_status string
[]
Package tracking
[]
Example: fulfilled
status string
[]
Logistics delivery status, success-shipped; cancelled-cancelled;
[]
Example: cancelled
tracking_company string
[]
Logistics company name
[]
Example: SF International
tracking_number string
[]
Third party tracking number
[]
Example: yun0001
tracking_url string
[]
Logistics company URL
[]
Example: https://www.sf-international.com/
updated_at string
[]
Update time ( format see ISO 8601 )
[]
Example: 2022-11-04T10:18:46+00:00
hidden_order boolean
[]
Whether it is an archived order, true=archived order, false=unarchived order
id string
[]
Order number, system-defined number
[]
Example: 21050224312121887324667162
landing_site string
[]
Link to record complete suffix information
[]
Example: https://www.url.com
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
customized_attributesobject[]
[]
Product custom attributes
key string
[]
Custom attribute name key
[]
Example: "businessType"
value string
[]
Product custom attributes value , such as : when key is businessType , value is 3 ( for gifts )
[]
Example: "3"
discount_allocationsobject[]
[]
Marketing discount details in multiple currencies
amount string
[]
Discount detailed amount (store currency amount)
[]
Example: 8.00
amount_setobject
[]
Discount details in multiple currencies
presentment_moneyobject
[]
Payment currency
amount string
[]
Amount, Precision 2
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Store currency
amount string
[]
Amount, Precision 2
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
discount_application_index integer
[]
Indicate the position in the discount details
[]
Example: 1
dutiesobject[]
[]
Duty information
country_code_of_origin string
[]
Country code of origin/shipping point
[]
Example: USD
harmonized_system_code string
[]
Customs code
[]
Example: A0023
id string
[]
Tariff number
[]
Example: H2325
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: 1
rate_percentage double
[]
Tax rate (percentage value, i.e. rate * 100)
[]
Example: 100
title string
[]
Tax title
[]
Example: Tax title
fulfillable_quantity integer
[]
Available quantity
[]
Example: 1
fulfillment_service string
[]
Logistics company name
[]
Example: SF International
fulfillment_status string
[]
The shipping status of the product, shipping status, fulfilled-shipped; partial-partially shipped; null-unshipped;
[]
Example: fulfilled
gift_card boolean
[]
Is it a gift card product?
[]
Example: true
grams double
[]
Weight ( grams )
[]
Example: 100
harmonized_system_code string
[]
harmonized system code
[]
Example: harmonized system code
id string
[]
The ID of the product snapshot table, generated by the system, uniquely confirms a product with the order number
[]
Example: 417
image_url string
[]
product picture
[]
Example: https://d2n979dmt31clo.cloudfront.net/image/store/4211449909/1667384795847/63928f08a7174ab2958c6a969
location_id string
[]
Unique code of pickup location
[]
Example: 5327026538935748524
name string
[]
SKU title, same as title
[]
Example: Product title
price string
[]
Product selling price ( store currency amount ) , accuracy 2
[]
Example: 8.00
price_setobject
[]
Commodity price, precision 2
presentment_moneyobject
[]
Product selling price , market currency
amount string
[]
Product selling price , market currency amount
[]
Example: 80.00
currency_code string
[]
Market currency
[]
Example: CNY
shop_moneyobject
[]
Product selling price , store currency
amount string
[]
Product selling price , store currency
[]
Example: 10
currency_code string
[]
Market currency
[]
Example: USD
product_id string
[]
SPU serial number
[]
Example: 16056761559984840457934011
propertiesobject[]
[]
Product customization information
additional string
[]
Customized product additional fields
[]
Example: Additional fields
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 array
[]
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
price string
[]
Tax ( store currency amount ) , accuracy 2
[]
Example: 8.00
price_setobject
[]
Multi-currency information of tax
presentment_moneyobject
[]
Buy side currency
amount string
[]
Amount
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side currency
amount string
[]
Amount
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
rate double
[]
Tax rate
[]
Example: 1
title string
[]
Tax name
[]
Example: taxes
type string
[]
Tax fee type, used to distinguish between commodity tax and freight tax. The enumeration value is as follows product_tax: commodity tax shipping_tax: freight tax
[]
Example: shipping_tax
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: big
vendor string
[]
Supplier
[]
Example: Supplier
locationsobject[]
[]
Pick-up location address
address string
[]
Detailed address 1
[]
Example: Address 1
address_add string
[]
Detailed address 2
[]
Example: Address 22
city string
[]
City
[]
Example: Guangzhou
country string
[]
Country
[]
Example: China
country_code string
[]
Country code
[]
Example: CN
district string
[]
District/County
[]
Example: Panyu District
location_id string
[]
Unique code of pickup location
[]
Example: 5327026538935748524
name string
[]
Address name
[]
Example: Wanda square
phone string
[]
Phone number such as (555) 555-5555
[]
Example: 13100000000
province string
[]
Province
[]
Example: Guangdong Province
town string
[]
Township/Town
[]
Example: town
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
zip string
[]
Postal code
[]
Example: 521000
name string
[]
Store custom order number, starting from 1001, you can set a prefix
[]
Example: test1001
note string
[]
Merchant notes
[]
Example: Notes
note_attributesobject[]
[]
Merchant note log, date content
create_time string
[]
Note creation time ( format see ISO 8601 )
[]
Example: 2022-11-04T10:18:46+00:00
name string
[]
Remark source (seller ID)
[]
Example: Note source
value string
[]
Notes
[]
Example: Notes
order_at string
[]
Order is single time ( format see ISO 8601 )
[]
Example: 2021-08-16T08:27:57+00:00
order_source string
[]
The order source channel. Currently, this field only has a value for the POS channel, and the value is empty for other 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
create_time string
[]
Payment slip creation time
[]
Example: 2021-08-16T08:27:57+00:00
gateway string
[]
Payment method name
[]
Example: Mypay
pay_amount double
[]
Payment amount ( store currency amount )
[]
Example: 8
pay_channel string
[]
Payment channels
[]
Example: Paypal
pay_channel_deal_id string
[]
External channel payment serial number
[]
Example: pi_3MI897Hezv8FxjBO1uGxMPhX
pay_merchant_email string
[]
Pay Merchant Email Account
[]
Example: Washingtontest@gmail.com
pay_merchant_id string
[]
Payment merchants ID
[]
Example: 4201057379
pay_merchant_order_id string
[]
Payment merchant order number
[]
Example: 233445354566
pay_seq string
[]
Payment slip number
[]
Example: 23057287797738260472676128
pay_status string
[]
Payment order status, unpaid-unpaid; pending-paying; risking-risk control; paid-paid; paid_overtime-payment failed; paid_failed-payment failed;
[]
Example: unpaid
processed_at string
[]
Processed_at payment creation time , format : 2023-04-12T22 : 59 : 52+08 : 00
[]
Example: 2023-04-12T22:59:52+08:00
settle_currency string
[]
Settlement currency
[]
Example: USD
settle_pay_amount double
[]
Payment amount ( settlement currency amount )
[]
Example: 8
status_code string
[]
Payment status code
[]
Example: RISK_PENDING
status_msg string
[]
Payment order status code description
[]
Example: PENDING_REVIEW
payment_gateway_names array
[]
Payment method list, payment method list used for this order, SLpayments
[]
Example: Paypal
payment_termsobject
[]
Payment terms
created_at string
[]
Create time
[]
Example: 2024-06-05 08:00:00
due_in_days integer
[]
When the terms type is NET, the payment is due after how many days if the payment is not made
[]
Example: 2
id string
[]
The unique identifier (ID) that identifies this payment term
[]
Example: 6497210673894431747
overdue boolean
[]
Is the payment term overdue: true/false
[]
Example: true
payment_schedulesobject[]
[]
A set of schedules associated with the payment terms
completed_at string
[]
Payment completion date
[]
Example: 2024-06-05 08:00:00
due_at string
[]
Expected payment date
[]
Example: 2024-06-05 08:00:00
issued_at string
[]
The time when the payment terms are triggered. When the type is FIXED, it is the saved time (if the draft order becomes an order, the order inherits the draft order time); when the type is FULFILLMENT/RECEIPT, it is the effective time of the condition; when the type is NET, it is the saved time (if the draft order becomes an order, the order inherits the draft order time).
[]
Example: 2024-06-05 08:00:00
payment_terms_name string
[]
The name of the payment terms template used to create the payment terms.
[]
Example: Due on receipt
payment_terms_type string
[]
The type of payment terms template used to create the payment terms: FIXED: Merchant specified date FULFILLMENT: Fulfillment (Shipment) completion date NET: Fixed condition date RECEIPT: Billing sent date UNKNOWN: Unknown type
[]
Example: RECEIPT
updated_at string
[]
Update time
[]
Example: 2024-06-05 08:00:00
phone string
[]
Buyer contact information, there must be one of the two
[]
Example: 18978789878
po_number string
[]
Purchase order number recorded on the order in B2B scenarios
pos_location_id string
[]
Location ID
[]
Example: 5327026538935748524
presentment_currency string
[]
Buy side currency, same as sell 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
processed_user_id string
[]
Order creator
[]
Example: 4201057495
referring_site string
[]
External link
[]
Example: https://www.referringSite.com
refundsobject[]
[]
Refund list
created_at string
[]
Refund order creation time ( format see ISO 8601 )
[]
Example: 2021-08-16T08:27:57+00:00
id string
[]
Refund ID
[]
Example: 2605659027312156877634
note string
[]
Refund Notes
[]
Example: Refund Notes
order_adjustmentsobject[]
[]
Adjustment order information is used to record two types of information: 1) Refund information related to shipping costs (type is shipping_refund) 2) The difference between the automatically calculated refund amount and the actual refund amount (type is refund_discrepancy)
amount string
[]
Adjust the single amount ( store currency amount )
[]
Example: 8.00
amount_setobject
[]
Adjust the single amount
presentment_moneyobject
[]
Display amount of store adjustment order
amount double
[]
Store adjustment of display
[]
Example: 8
currency_code string
[]
Store adjustment of display amount currency
[]
Example: USD
shop_moneyobject
[]
Store adjustment amount
amount double
[]
Store adjustment amount
[]
Example: 8
currency_code string
[]
Store adjust the amount currency
[]
Example: USD
id string
[]
Refund adjustment single id
[]
Example: RAP5570565996182771228
kind string
[]
Adjustment order type: refund_discrepancy, shipping_refund
[]
Example: refund_discrepancy
order_id string
[]
Order number
[]
Example: 21056577640603870897253153
reason string
[]
Reason for adjustment: Refund discrepancy, shipping_refund
[]
Example: Refund discrepancy
refund_id string
[]
Refund single id
[]
Example: 2605659027312156877634
tax_amount string
[]
Adjust the single tax amount ( store currency amount )
[]
Example: 8.00
tax_amount_setobject
[]
Adjust single tax amount (multi-currency amount)
presentment_moneyobject
[]
Store adjustment single display tax amount
amount double
[]
Store adjustment single display tax amount
[]
Example: 8
currency_code string
[]
Store adjustment single display tax currency
[]
Example: USD
shop_moneyobject
[]
Store adjusts the amount of single tax
amount double
[]
Store adjusts the amount of single tax
[]
Example: 8
currency_code string
[]
Store adjustment of single tax currency
[]
Example: USD
order_id string
[]
Order number
[]
Example: 21056577640603870897253153
processed_at string
[]
Update time ( format see ISO 8601 )
[]
Example: 2021-08-16T08:27:57+00:00
refund_line_itemsobject[]
[]
Refund Details
id string
[]
Refund order number
[]
Example: 2605659027312156877634
line_itemobject
[]
Description
attribute string
[]
Product attributes : name-attribute value multiple comma " , " division like : color-red , size-x
[]
Example: red
fulfillable_quantity integer
[]
Available quantity
[]
Example: 1
fulfillment_service string
[]
Logistics company name
[]
Example: SF International
fulfillment_status string
[]
The shipping status of the product, shipping status, fulfilled-shipped; partial-partially shipped; null-unshipped;
[]
Example: fulfilled
grams double
[]
Weight ( grams )
[]
Example: 1
id string
[]
The ID of the product snapshot table, generated by the system, uniquely confirms a product with the order number
[]
Example: 403
name string
[]
SKU title, same as title
[]
Example: 18056761559987524812644011
price string
[]
Product selling price ( store currency amount ) , the amount of precision 2 string
[]
Example: 8.00
price_setobject
[]
Product selling price , market currency information
presentment_moneyobject
[]
Product selling price , market currency information
amount string
[]
Product selling price , market currency amount
[]
Example: 10.00
currency_code string
[]
Market currency
[]
Example: USD
shop_moneyobject
[]
Current order membership points to deduct the amount , store currency information
amount string
[]
Product selling price , store currency amount
[]
Example: 70.00
currency_code string
[]
Store currency
[]
Example: CNY
product_id string
[]
SPU serial number
[]
Example: 16056761559984840457934011
quantity integer
[]
Quantity of items in the order
[]
Example: 1
requires_shipping boolean
[]
Shipping or not
[]
Example: true
sku string
[]
Product code, barCode
[]
Example: sku name
tax_linesobject[]
[]
Tax information
price string
[]
Tax ( store currency amount ) , accuracy 2
[]
Example: 8.00
price_setobject
[]
Multi-currency information of tax
presentment_moneyobject
[]
Buy side currency
amount string
[]
Amount, Precision 2
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side amount information
amount string
[]
Amount
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
rate double
[]
Tax rate
[]
Example: 1
title string
[]
Headline
[]
Example: Headline
taxable boolean
[]
Tax or not？
[]
Example: true
title string
[]
Product title
[]
Example: Product title
variant_id string
[]
Product SKU serial number
[]
Example: 18056761559987524812644011
variant_title string
[]
Commodity attribute value, multiple divided by " / ", such as: "155 / red / large"
[]
Example: big
vendor string
[]
Supplier
[]
Example: Supplier
line_item_id string
[]
The ID of the product snapshot table, generated by the system, uniquely confirms a product with the order number
[]
Example: 406
quantity integer
[]
Quantity, quantity of goods
[]
Example: 1
restock_type string
[]
Inventory return type, no_restock - not returned, cancel - canceled, return - returned
[]
Example: cancel
subtotal double
[]
Total refund amount ( store currency amount ) , accuracy 2
[]
Example: 8
subtotal_setobject
[]
Total refund amount, multi-currency information, same on seller and buyer side
presentment_moneyobject
[]
Buy side currency
amount string
[]
Amount
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side amount information
amount string
[]
Amount, Precision 2
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
total_tax double
[]
Tax amount for refund Product ( store currency amount ) , accuracy 2
[]
Example: 8
total_tax_setobject
[]
Total tax amount, multi-currency information
presentment_moneyobject
[]
Buy side currency
amount string
[]
Amount
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side currency
amount string
[]
Amount
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
transactionsobject[]
[]
Refund transaction information
amount string
[]
Refund amount , accuracy 2
[]
Example: 8.00
created_at string
[]
Creation time
[]
Example: 2021-08-16T08:27:57+00:00
currency string
[]
Currency
[]
Example: USD
id string
[]
Refund ID
[]
Example: 2605659027312156877634
kind string
[]
Transaction type (authorization, capture, sale, void, refund)
[]
Example: void
order_id string
[]
Order number
[]
Example: 21056577640603870897253153
processed_at string
[]
Refund order update time
[]
Example: 2021-08-16T08:27:57+00:00
settle_amount string
[]
Refund amount ( settlement currency ) , accuracy 2
[]
Example: 8.00
settle_currency string
[]
Settlement currency
[]
Example: USD
status string
[]
Handling status, pending, failure, success, and error
[]
Example: success
user_id string
[]
Buyer ID
[]
Example: 4201057495
user_id string
[]
User ID
[]
Example: 4201057495
service string
[]
Shipping method type, pickUp means pick up in store.
[]
Example: pickUp
shipping_addressobject
[]
Shipping address
address1 string
[]
address1
[]
Example: Address 1
address2 string
[]
Detailed address 2, optional
[]
Example: Address 2
city string
[]
City
[]
Example: City
company string
[]
Company Name
[]
Example: Company Name
country string
[]
Country
[]
Example: China
country_code string
[]
Country code
[]
Example: CN
delivery_store_code string
[]
Store ID
[]
Example: 1001
delivery_store_name string
[]
Store name
[]
Example: Store name
district string
[]
District
[]
Example: Panyu District
district_code string
[]
District code
[]
Example: 521000
first_name string
[]
Last name
[]
Example: Tom
last_name string
[]
First name
[]
Example: Washington
latitude string
[]
latitude
[]
Example: 15
longitude string
[]
longitude
[]
Example: 41
name string
[]
Full name
[]
Example: Tom.Washington
phone string
[]
Phone
[]
Example: 13100000000
province string
[]
Province
[]
Example: Guangdong Province
province_code string
[]
Province code
[]
Example: 510000
zip string
[]
Postal code
[]
Example: 521000
shipping_linesobject[]
[]
Logistics information
code string
[]
Logistics number
[]
Example: SF
discount_allocationsobject[]
[]
Discount details
amount string
[]
Discount amount ( store currency amount ) , accuracy 2
[]
Example: 8.00
amount_setobject
[]
Discount multi-currency amounts
presentment_moneyobject
[]
Buyer side amount information
amount string
[]
Amount, Precision 2
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Store side amount information
amount string
[]
Amount, Precision 2
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
discount_application_index integer
[]
position in discount details
[]
Example: 1
discounted_price string
[]
Discount amount ( store currency amount ) , accuracy 2
[]
Example: 8.00
discounted_price_setobject
[]
Discount multi-currency amounts
presentment_moneyobject
[]
Buyer side amount information
amount string
[]
Amount, Precision 2
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Store side amount information
amount string
[]
Amount, Precision 2
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
phone string
[]
Phone
[]
Example: 13100000000
price string
[]
Logistics shipping fee ( store currency amount ) , accuracy 2
[]
Example: 8.00
price_setobject
[]
Logistics freight multi-resource information
presentment_moneyobject
[]
Buyer side amount information
amount string
[]
Amount, Precision 2
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Store side amount information
amount string
[]
Amount, Precision 2
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
requested_fulfillment_service_id string
[]
Transportation service code
[]
Example: -
shipping_price string
[]
Original freight amount (non-discount amount, store currency amount)
[]
Example: 8.00
shipping_price_setobject
[]
Original shipping value ( non-discounted amount ) , multi-currency amount information
presentment_moneyobject
[]
Buyer side amount information
amount string
[]
Amount , accuracy 2
[]
Example: 8.00
currency_code string
[]
Market currency
[]
Example: CNY
shop_moneyobject
[]
Store side amount information
amount string
[]
Amount , accuracy 2
[]
Example: 1.00
currency_code string
[]
Store currency
[]
Example: USD
source string
[]
Freight source
[]
Example: source
tax_linesobject[]
[]
Logistics tax list
price string
[]
Tax ( store currency amount )
[]
Example: 8.00
price_setobject
[]
Multi-currency information of tax
presentment_moneyobject
[]
Buyer side amount information
amount string
[]
Amount
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side amount information
amount string
[]
Amount, Precision 2
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
rate double
[]
Tax rate
[]
Example: 1
title string
[]
Tax name
[]
Example: Tax name
title string
[]
Logistics name
[]
Example: SF International
source_identifier string
[]
ID used to identify business processing
[]
Example: -
source_name string
[]
Type filtering to identify business processes
[]
Example: -
source_url string
[]
The HTML format information of the link to jump to the store
[]
Example: -
status string
[]
Order status open=processing, canceled-cancelled
[]
Example: open
store_id string
[]
store ID
[]
Example: 1644828244663
subtotal_price string
[]
Product discount price total ( store currency amount ) , Product total price-marketing Discount-artificial discount
[]
Example: 8.00
subtotal_price_setobject
[]
Multi-currency information of total product price after discount
presentment_moneyobject
[]
Buyer side amount information
amount string
[]
Amount, Precision 2
[]
Example: 1.00
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side amount information
amount string
[]
Amount, Precision 2
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
tags string
[]
order label
[]
Example: Label
tax_linesobject[]
[]
Tax information
name string
[]
Tax name
[]
Example: Tax name
price string
[]
Tax ( store currency amount ) , accuracy 2
[]
Example: 8.00
price_setobject
[]
Multi-currency information of tax
presentment_moneyobject
[]
Buyer side amount information
amount string
[]
Amount, Precision 2
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side amount information
amount string
[]
Amount, Precision 2
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
rate double
[]
Tax rate
[]
Example: 1
title string
[]
Tax name
[]
Example: Tax name
tax_number string
[]
TIN
[]
Example: -
tax_type string
[]
Types of tax ID
[]
Example: -
taxes_included boolean
[]
Does the total include tax?
[]
Example: true
total_discounts string
[]
Discount total ( store currency amount ) , marketing Discount + manual discount
[]
Example: 8.00
total_discounts_setobject
[]
Multi-currency information of discount total
presentment_moneyobject
[]
Buyer side amount information
amount string
[]
Amount, Precision 2
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side amount information
amount string
[]
Amount, Precision 2
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
total_line_items_price string
[]
Product total price of original ( store currency amount ) , accuracy 2
[]
Example: 8.00
total_line_items_price_setobject
[]
Sum of original price of goods, multi-currency information
presentment_moneyobject
[]
Buyer side amount information
amount string
[]
Amount, Precision 2
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side amount information
amount string
[]
Amount, Precision 2
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
total_outstanding string
[]
The total amount of payment is total ( store currency amount ) , accuracy 2
[]
Example: 8.00
total_shipping_price_setobject
[]
Order shipping sum, multi-currency information
presentment_moneyobject
[]
Buyer side amount information
amount string
[]
Amount, Precision 2
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side amount information
amount string
[]
Amount, Precision 2
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
total_tax string
[]
Total tax ( store currency amount ) , accuracy 2 , product tax + shipping tax
[]
Example: 8.00
total_tax_setobject
[]
Total taxes and fees, multi-currency information
presentment_moneyobject
[]
Buyer side amount information
amount string
[]
Amount, Precision 2
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side amount information
amount string
[]
Amount, Precision 2
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
total_tip_received string
[]
Tip ( store currency amount ) , accuracy 2
[]
Example: 8.00
total_tip_received_setobject
[]
Current order membership credit to the amount , multi-currency amount information
presentment_moneyobject
[]
Current order membership points to deduct the amount , market currency information
amount string
[]
Current order membership points to deduct the amount , market currency
[]
Example: 10.00
currency_code string
[]
Market currency
[]
Example: USD
shop_moneyobject
[]
Current order membership points to deduct the amount , store currency information
amount string
[]
Current order membership credit amount , store currency amount
[]
Example: 70.00
currency_code string
[]
Store currency
[]
Example: CNY
total_weight double
[]
Total product weight ( g )
[]
Example: 1
updated_at string
[]
Order update time , ( format see ISO 8601 )
[]
Example: 2021-08-16T08:27:57+00:00
user_id string
[]
Buyer ID
[]
Example: 4201057495
utm_parameters string
[]
Ad business-specific parameters used for ad attribution calculation
[]
Example: -

API Explorer

Debugger

Base URL

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

ParamOptions

Authorization — header required

buyer_id — query

contract_ids — query

created_at_max — query

created_at_min — query

email — query

fields — query

financial_status — query

fulfillment_status — query

hidden_order — query

ids — query

limit — query

location — query

name — query

page_info — query

search_content — query

since_id — query

sort_condition — query

status — query

updated_at_max — query

updated_at_min — query

Language

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

Error loading component.