Query orders

Requires read_orders access scope.

For more info , refer to:

[]

access permission

GET 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 .

[]

Query the orders' information according to the request parameters.

Query Parameters

buyer_id string
[]
The unique identifier of the buyer.
contract_ids string
[]
The unique identifier of the contract that separated with comma, the maximum sized supported is 50.
created_at_max string
[]
The start of the creation time in ISO 8601 format.
created_at_min string
[]
The start of the creation time in ISO 8601 format.
email string
[]
The email of the buyer.
fields string
[]
The fields to be queried which are separated with a comma, empty value for querying all fields.
financial_status string
[]
The payment status: unpaid: for unpaid staus pending：during the payment partially_paid: for partially paid status paid: for paid status partially_refunded: for partially refund status refunded: for refunded status
fulfillment_status string
[]
The shipping status: unshipped: for unshipped status partial: for partially shipped status shipped: for complete shipping status
hidden_order boolean
[]
Whether the order is archived. true: the order has been archived. false: the order has not been archived
ids string
[]
The unique identifiers separated with a comma and the maximum size supported is 100.
limit integer
[]
The limitation of the query size, default as 50, maximum is 100.
location string
[]
The delivery place of the products in the order, support multiple values that separated with the comma.
name string
[]
The custom unique identifier of the order.
page_info string
[]
The encrypted value of the request's parameters, it can be decrypted for requesting the previous or next page.
search_content string
[]
The searching content, supporting: the order unique identifier, the payment unique identifier, the shipping unique identifier, the product name, the product SKU code, the order amount.
since_id string
[]
The order unique identifier where the query need to start with.
sort_condition string
[]
The sort condition that supported multiple values with the comma: order_at
,id:asc: sort by order creation time in descending order and then sort by order unique identifier in ascending order.
status string
[]
The order status: open: for processing status cancelled: for cancelled status any: any other status including archived status
updated_at_max string
[]
The start of the updating time in ISO 8601 format.
updated_at_min string
[]
The end of the updating time in ISO 8601 format.

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
[]
The URL link that provides the pagination data. For example, you can obtain page_info from this parameter value for use in the next pagination request.

This parameter is returned when the requested page has a previous or next page available.

For more information on how to use pagination, refer to Paging Mechanism.

Example: <https://{handle}.myshopline.com/admin/openapi/{version}/products/products.json?limit=1&page_info=eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9>; rel="next"
traceId
[]
traceId

Response Body

ordersobject[]
[]
List of order details.
adjust_price string
[]
The amount discrepancy due to rounding adjustments in POS transactions, expressed in the store's currency.
adjust_price_setobject
[]
The amount discrepancy due to rounding adjustments in POS transactions, displayed in both the buyer's order currency and the store currency.
presentment_moneyobject
[]
The order price information presented to the buyer.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
shop_moneyobject
[]
The order price information recorded by the merchant.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For 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.
address2 string
[]
The second line of the address. This typically includes information such as apartment, suite, or unit number.
city string
[]
The city in the address.
company string
[]
The company name of the billing recipient.
country string
[]
The country or region in the address.
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.
first_name string
[]
The first name of the billing recipient.
last_name string
[]
The last name of the billing recipient.
name string
[]
The full name of the billing recipient.
phone string
[]
The phone number of the billing recipient.
province string
[]
The province in the address.
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.
zip string
[]
The postal code information of the address.
browser_ip string
[]
The IP address of the customer's browser used during order placement.
buyer_note string
[]
Buyer's message.
cancel_reason string
[]
Merchant's reason for cancellation.
cancelled_at string
[]
The date and time when the order is canceled. Format: ISO 8601.

Example: 2024-08-31T02:20:26+08:00
cart_token string
[]
The unique identifier for shopping cart data.
checkout_id string
[]
Abandoned order ID.
checkout_token string
[]
The unique identifier for abandoned order data. After a customer initiates the checkout process, an abandoned order is generated.
client_detailsobject
[]
Client details.
browser_ip string
[]
The customer’s browser IP address when placing an order.
session_hash string
[]
Member session encryption information.
user_agent string
[]
Client proxy.
companyobject
[]
The buyer's company information at the time of placing the order.
id string
[]
Company ID.
location_id string
[]
Location ID.
tax_registration_id string
[]
Tax registration ID.
contract_seq string
[]
Subscription contract ID.
created_at string
[]
The date and time when the order is created. Format: ISO 8601.

Example: 2021-08-16T08:27:57+00:00
credit_limitobject
[]
Credit payment information.
credit_limit_currency string
[]
The currency of the credit payment, same as the store currency. The value of this parameter is a three-letter currency code that follows the ISO 4217 standard. For example, USD.
is_credit_limit boolean
[]
Indicates whether the order used credit payment.

true: used

false: not used

outstanding_credit_limit string
[]
The total occupied credit amount. Initially equal to the total_credit_limit, it decreases accordingly if there are subsequent actions such as repayments.
total_credit_limit string
[]
The total credit amount used, indicating how much credit was utilized to pay for this order.
currency string
[]
Transaction currency. A three-letter currency code that follows the ISO 4217 standard. For 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.
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 value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
shop_moneyobject
[]
The order price information recorded by the merchant.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For 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, displayed in the store currency.
current_total_discounts_setobject
[]
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, displayed in both the buyer currency and the store currency.
presentment_moneyobject
[]
The order price information presented to the buyer.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
shop_moneyobject
[]
The order price information recorded by the merchant.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For 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 order price information presented to the buyer.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
shop_moneyobject
[]
The order price information recorded by the merchant.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
current_total_price string
[]
The total order amount, displayed in the store currency.
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 value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
shop_moneyobject
[]
The order price information recorded by the merchant.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
current_total_tax string
[]
The total tax amount, displayed in the store currency.
current_total_tax_setobject
[]
The total tax amount, displayed in both the buyer currency and the store currency.
presentment_moneyobject
[]
The order price information presented to the buyer.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
shop_moneyobject
[]
The order price information presented to the buyer.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
customerobject
[]
Buyer information.
addressesobject
[]
Buyer's address information.
address1 string
[]
The first line of the address. This typically includes information such as the street address or a post office box number.
address2 string
[]
The second line of the address. This typically includes information such as apartment, suite, or unit number.
city string
[]
The city in the address.
country string
[]
The country or region in the address.
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.
first_name string
[]
The first name of the recipient.
last_name string
[]
The last name of the recipient.
name string
[]
The full name of the recipient.
phone string
[]
The phone number of the buyer.
province string
[]
The province in the address.
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.
zip string
[]
The postal code information of the address.
area_code string
[]
The code for the district or county in the address.
created_at string
[]
The date and time when the buyer information is created that follows the ISO 8601 standard.

Example: 2021-08-31T02:20:26+08:00
currency string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
email string
[]
The email of the buyer.
first_name string
[]
The first name of the buyer.
id string
[]
Buyer's ID.
last_name string
[]
The last name of the buyer.
phone string
[]
The phone number of the buyer.
updated_at string
[]
Buyer update time. Format：ISO 8601.

Example：2021-08-31T02:20:26+08:00
customer_locale string
[]
Buyer's country, language code + country name abbreviation.

Example: enCA
deduct_member_point_amount string
[]
Current order membership credit amount (store currency amount). The value is rounded to two decimal places.
deduct_member_point_amount_setobject
[]
The order amount deducted using membership points，displayed in both the buyer currency and the store currency.
presentment_moneyobject
[]
The order price information presented to the buyer.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
Market currency. A three-letter currency code that follows the ISO 4217 standard. For example, USD.
shop_moneyobject
[]
The order price information recorded by the merchant.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
Shop's currency. A three-letter currency code that follows the ISO 4217 standard. For example, USD.
discount_applicationsobject[]
[]
Discount information.
allocation_method string
[]
Discount range.

across: discount based on total purchase quantity

each: discount on each item individually

Example: For a purchase of 3 identical items with a discount of 10 units. across means the 10 units are applied to the total of all 3 items together. each means 10 units are applied to each individual item.
code string
[]
Discount code.
description string
[]
Custom discount description.
target_selection string
[]
Discount distribution method for line items.

explicit : discount is assigned to explicitly selected line items

all: discount is assigned to all line items

entitled: discount is assigned only to line items for which it has permission

target_type string
[]
Discount type.

manual: manual discount

automatic: automatic discount

discount_code: discount applied through a discount code

title string
[]
Automatic discount title.
type string
[]
Discount type.

manual: manual discount

automatic: automatic discount

discount_code: discount applied through a discount code

value string
[]
The specific value of the discount (it can be N discount, or it can be a specific amount value, store currency amount).
value_type string
[]
The type of value.

fix_amount: fixed amount discount

percentage: percentage discount
discount_codesobject[]
[]
Promo code information.
amount string
[]
Discount amount (store currency amount). The value is rounded to two decimal places.
amount_setobject
[]
The discount amount, displayed in both the buyer currency and the store currency.
presentment_moneyobject
[]
The order price information presented to the buyer.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
shop_moneyobject
[]
Shop's currency. The order price information recorded by the merchant.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
code string
[]
Promo code.
type string
[]
Type of discount.

AMOUNT_DISCOUNT

PERCENTAGE_DISCOUNT

FREE_SHIPPING

MARKUP_DISCOUNT

ANY_ N_ITEMS_DISCOUNT

BUNDLE_DISCOUNT

GIFT

FIX_AMOUNT_DISCOUNT

LOWEST_PRICED_ITEM_FREE

BUNDLE_PRICE

NTH_ITEM_DISCOUNT

BUY_X_GET_Y

CUSTOMER_DISCOUNT
email string
[]
Buyer's email.
financial_status string
[]
Order payment status.

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
fulfillment_status string
[]
Shipping status.

fulfilled: order shipped

partial
partially shipped

null: order not shipped

Note: the returned enum value is different from the query enumeration value of the input parameter.
fulfillmentsobject[]
[]
Package information.
created_at string
[]
The date and time when the package information is created. Format: ISO 8601.

Example: 2021-08-16T08:27:57+00:00
id string
[]
Package number.
line_itemsobject[]
[]
Product list.
attribute string
[]
Product attributes. Format: name - attribute. If there are multiple attributes, separate them with commas ,. For example: color - red , size - X.
fulfillable_quantity integer
[]
Available quantity.
fulfillment_quantity integer
[]
The number of shipments.
fulfillment_service string
[]
Logistics company name.
fulfillment_status string
[]
The shipping status of the product.

fulfilled: products shipped

partial: products partially shipped

null: products not shipped

grams double
[]
Weight, unit: g.
id string
[]
The ID of the product snapshot table, generated by the system, uniquely confirms a product with the order number.
image_url string
[]
Product picture.
location_id string
[]
Unique code of pickup location.
name string
[]
SKU title, same as title.
price string
[]
Commodity price, precision 2.
price_setobject
[]
The product price, displayed in both the store currency and the buyer currency.
presentment_moneyobject
[]
The order price information presented to the buyer.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
shop_moneyobject
[]
The order price information recorded by the merchant.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
product_id string
[]
SPU serial number.
quantity integer
[]
Quantity of items in the order.
requires_shipping boolean
[]
Shipping or not.
sku string
[]
Product code, barCode.
tax_linesobject[]
[]
Tax information.
price string
[]
Tax (store currency amount) , accuracy 2.
price_setobject
[]
Multi-currency information of tax.
presentment_moneyobject
[]
The order price information presented to the buyer.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
shop_moneyobject
[]
The order price information recorded by the merchant.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
rate double
[]
Tax rate.
title string
[]
The tax description title.
taxable boolean
[]
Tax or not.
title string
[]
Product title.
variant_id string
[]
Product SKU serial number.
variant_title string
[]
Commodity attribute value, multiple divided by /, such as: 155 / red / large.
vendor string
[]
Supplier.
name string
[]
Invoice short number.
order_id string
[]
Order number.
shipment_status string
[]
Logistics delivery status.

success: shipment successful

cancelled: shipment has been canceled

status string
[]
Logistics delivery status.

success: shipped

cancelled: cancelled

tracking_company string
[]
Logistics company name.
tracking_number string
[]
Third party tracking number.
tracking_url string
[]
Logistics company URL.
updated_at string
[]
Update time. Format: ISO 8601.

Example：2021-08-31T02:20:26+08:00
hidden_order boolean
[]
Indicates whether it is an archived order.

true：archived order

false：unarchived order
id string
[]
Order number, system-defined number.
landing_site string
[]
Link to record complete suffix information.
line_itemsobject[]
[]
Order product snapshot information.
attribute string
[]
Product attributes. Format: name - attribute. If there are multiple attributes, separate them with commas ,. For example: color - red , size - X.
country_code_of_origin string
[]
Country code of origin or shipping point that follows the ISO 3166-1 standard, used to identify a specific country or region in the address. For example, US.
customized_attributesobject[]
[]
Product custom attributes.
key string
[]
Custom attribute name. Imported from external sources, but only when the key is businessType, it is automatically generated by the system when placing an order.
value string
[]
Product custom attribute value. For example, when the key is businessType, only data with a value of 3 (it indicates gifts) will be displayed.
discount_allocationsobject[]
[]
The discount details amount，displayed in both the buyer currency and the store currency.
amount string
[]
The value is rounded to two decimal places.
amount_setobject
[]
Discount details in multiple currencies.
presentment_moneyobject
[]
The order price information presented to the buyer.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
shop_moneyobject
[]
The order price information recorded by the merchant.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
discount_application_index integer
[]
Indicates the position in the discount details.
dutiesobject[]
[]
Duty information.
country_code_of_origin string
[]
Country code of origin or shipping point that follows the ISO 3166-1 standard, used to identify a specific country or region in the address. Example: US.
harmonized_system_code string
[]
Customs code.
id string
[]
Tariff number.
priceobject
[]
The duty amount，displayed in both the buyer currency and the store currency.
presentment_moneyobject
[]
The order price information presented to the buyer.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
shop_moneyobject
[]
The order price information recorded by the merchant.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
tax_linesobject[]
[]
Tax details list.
price_setobject
[]
The tax amount，displayed in both the buyer currency and the store currency.
presentment_moneyobject
[]
The order price information presented to the buyer.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
shop_moneyobject
[]
The order price information recorded by the merchant.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
rate double
[]
Tax rate.
rate_percentage double
[]
Tax rate (percentage value, i.e. rate * 100).
title string
[]
The tax description title.
fulfillable_quantity integer
[]
Available quantity.
fulfillment_service string
[]
Logistics company name.
fulfillment_status string
[]
The shipping status of the product.

fulfilled：products shipped

partial：products partially shipped

null：products not shipped

gift_card boolean
[]
Is it a gift card product.
grams double
[]
Weight, unit: g.
harmonized_system_code string
[]
Harmonized system code.
id string
[]
The ID of the product snapshot table, generated by the system, uniquely confirms a product with the order number.
image_url string
[]
Product picture.
location_id string
[]
Unique code of pickup location.
name string
[]
SKU title, same as title.
price string
[]
Product selling price (store currency amount), accuracy 2.
price_setobject
[]
The product price, rounded to two decimal places, is displayed in both the buyer currency and the store currency.
presentment_moneyobject
[]
The order price information presented to the buyer.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
Market currency. A three-letter currency code that follows the ISO 4217 standard. For example, USD.
shop_moneyobject
[]
The order price information recorded by the merchant.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
product_id string
[]
Product ID（SPU serial number).
propertiesobject[]
[]
Product customization information.
additional string
[]
Customize additional fields for products. For example, when name is text, additional can include attributes like font size, font style, color, etc.
name string
[]
Custom attribute name.
role_visibility string
[]
Custom information visibility roles: ● customer: Visible to buyers only ● merchant: Visible to merchants only ● all: Visible to both buyers and merchants ● none: Hidden from both buyers and merchants
show boolean
[]
Whether the customized information is visible.
type string
[]
Attribute type.

text：character,the display format is name: value

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

urls array
[]
URL resource list.
[]
Example: ``
value string
[]
Custom attribute values.
quantity integer
[]
Quantity of items in the order.
requires_shipping boolean
[]
Shipping or not.
sku string
[]
Product code, barCode.
tags string
[]
Product tags, if there are multiple ones separated by commas ,.
tax_linesobject[]
[]
Tax information.
price string
[]
Tax (store currency amount) , accuracy 2.
price_setobject
[]
The tax amount，displayed in both the buyer currency and the store currency.
presentment_moneyobject
[]
The order price information presented to the buyer.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
shop_moneyobject
[]
The order price information recorded by the merchant.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
rate double
[]
Tax rate.
title string
[]
The tax description title.
type string
[]
Tax fee type, used to distinguish between commodity tax and freight tax.

product_tax: commodity tax

shipping_tax: freight tax

taxable boolean
[]
Indicates whether tax is levied or not.
title string
[]
Product title.
variant_id string
[]
Product SKU serial number.
variant_title string
[]
Commodity attribute value, multiple divided by /, such as: 155 / red / large.
vendor string
[]
Supplier.
locationsobject[]
[]
Pick-up location address.
address string
[]
The first line of the address. This typically includes information such as the street address or a post office box number.
address_add string
[]
The second line of the address. This typically includes information such as apartment, suite, or unit number.
city string
[]
The city in the address.
country string
[]
The country or region in the address.
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 or county in the address.
location_id string
[]
Unique code of pickup location.
name string
[]
Address name.
phone string
[]
Phone number such as (555) 555-5555.
province string
[]
The province in the address.
town string
[]
The township or town in the address.
type string
[]
Location types.

posLocation: the store location where the order was created through the POS channel (it is recommended to use posLocationId, as it will replace this in the future).

pickupLocation: the store location for 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, as it will be deprecated in the future).

zip string
[]
The postal code information of the address.
name string
[]
Store custom order number, starting from 1001, you can set a prefix.
note string
[]
Merchant notes.
note_attributesobject[]
[]
Merchant note log, date content.
create_time string
[]
Note creation time. Format: ISO 8601.

Example：2021-08-31T02:20:26+08:00
name string
[]
Remark source (seller ID).
value string
[]
Notes.
order_at string
[]
Order is single time. Format: ISO 8601.

Example：2021-08-31T02:20:26+08:00
order_source string
[]
The order source channel.
order_status_url string
[]
Order status page URL.
payment_detailsobject[]
[]
Payment slip information.
create_time string
[]
Payment slip creation time. Format: ISO 8601.

Example：2021-08-31T02:20:26+08:00
gateway string
[]
Payment method name.
pay_amount double
[]
Payment amount (store currency amount). The value is rounded to two decimal places.
pay_channel string
[]
Payment channels.
pay_channel_deal_id string
[]
External channel payment serial number.
pay_merchant_email string
[]
Pay merchant email account.
pay_merchant_id string
[]
Payment merchants ID.
pay_merchant_order_id string
[]
Payment merchant order number.
pay_seq string
[]
Payment slip number.
pay_status string
[]
Payment order status.

unpaid: payment order unpaid

pending: payment order in process

risking: payment order under risk control

paid：payment order paid

paid_overtime: payment order payment timeout

paid_failed: payment order failed

processed_at string
[]
Payment creation time. Format: ISO 8601.

Example：2021-08-31T02:20:26+08:00
settle_currency string
[]
Settlement currency.The value of this parameter is a three-letter currency code that follows the ISO 4217 standard. For example, USD.
settle_pay_amount double
[]
Payment amount (settlement currency amount). The value is rounded to two decimal places.
status_code string
[]
Payment status code.
status_msg string
[]
Payment order status code description.
payment_gateway_names array
[]
Payment method list, the payment methods used for this order may include:

SLpayments

Paypal

Oceanpay

TwoCheckout

AsiaBill

Stripe

Pacypay

WorldPay

COD

CUSTOM

adjustPay

Xendit

XenditOther

[]
Example: ``
payment_termsobject
[]
Payment terms.
created_at string
[]
The date and time when the it is created. Format: ISO 8601.

Example: 2021-08-31T02:20:26+08: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.
id string
[]
The unique identifier (ID) that identifies this payment term.
overdue boolean
[]
Is the payment term overdue: true or false.
payment_schedulesobject[]
[]
A set of schedules associated with the payment terms.
completed_at string
[]
Payment completion date. Format: ISO 8601.

Example：2021-08-31T02:20:26+08:00
due_at string
[]
Expected payment date. Format: ISO 8601.

Example：2021-08-31T02:20:26+08:00
issued_at string
[]
The time when the payment terms are triggered. When payment_terms_type is FIXED or NET, it is the saved time (if the draft order becomes an order, the order inherits the draft order time); When payment_terms_type is FULFILLMENT or RECEIPT, it is the effective time of the condition.
payment_terms_name string
[]
The name of the payment terms template used to create the payment terms.
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

updated_at string
[]
Update time. Format: ISO 8601.

Example：2021-08-31T02:20:26+08:00
phone string
[]
Buyer contact information, there must be one of the two.
po_number string
[]
Purchase order number recorded on the order in B2B scenarios.
pos_location_id string
[]
Location ID.
presentment_currency string
[]
Buyer currency same as the store currency. A three-letter currency code that follows the ISO 4217 standard. For example, USD.
processed_at string
[]
Order completion time. Format: ISO 8601.

Example: 2021-08-31T02:20:26+08:00
processed_user_id string
[]
Order creator.
referring_site string
[]
Attribution URL, the customer clicks the link and jumps to the online store.
refundsobject[]
[]
Refund list.
created_at string
[]
The date and time when the refund order is created. Format: ISO 8601.

Example: 2021-08-16T08:27:57+00:00
id string
[]
Refund ID.
note string
[]
Refund notes.
order_adjustmentsobject[]
[]
Adjustment order information is used to record two types of information:

Refund information related to shipping costs (type is shipping_refund).

The difference between the automatically calculated refund amount and the actual refund amount (type is refund_discrepancy).

amount string
[]
The value is rounded to two decimal places.
amount_setobject
[]
Adjust the single amount.
presentment_moneyobject
[]
The order price information presented to the buyer.
amount double
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
shop_moneyobject
[]
The order price information recorded by the merchant.
amount double
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
id string
[]
Refund adjustment single ID.
kind string
[]
Adjustment order type.

refund_discrepancy: adjustment of freight

shipping_refund: adjustment of payment order amount

order_id string
[]
Order number.
reason string
[]
Reason for adjustment.
refund_id string
[]
Refund single ID.
tax_amount string
[]
Adjust the single tax amount (store currency amount). The value is rounded to two decimal places.
tax_amount_setobject
[]
Adjust single tax amount (multi-currency amount).The value is rounded to two decimal places.
presentment_moneyobject
[]
The order price information presented to the buyer.
amount double
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
shop_moneyobject
[]
The order price information recorded by the merchant.
amount double
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
order_id string
[]
Order number.
processed_at string
[]
Update time. Format: ISO 8601.

Example：2021-08-31T02:20:26+08:00
refund_line_itemsobject[]
[]
Refund details.
id string
[]
Refund order number.
line_itemobject
[]
Description.
attribute string
[]
Product attributes. Format: name - attribute. If there are multiple attributes, separate them with commas ,. For example: color - red , size - X.
fulfillable_quantity integer
[]
Available quantity.
fulfillment_service string
[]
Logistics company name.
fulfillment_status string
[]
Shipping status.

fulfilled: order shipped

partial: order partially shipped

null: order not shipped

grams double
[]
Weight, unit: g.
id string
[]
The ID of the product snapshot table, generated by the system, uniquely confirms a product with the order number.
name string
[]
SKU title, same as title.
price string
[]
Product selling price (store currency amount), the amount of precision 2 string.
price_setobject
[]
The product price, rounded to two decimal places, is displayed in both the buyer currency and the store currency.
presentment_moneyobject
[]
The order price information presented to the buyer.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
shop_moneyobject
[]
The order price information recorded by the merchant.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
product_id string
[]
SPU serial number.
quantity integer
[]
Quantity of items in the order.
requires_shipping boolean
[]
Shipping or not.
sku string
[]
Product code, barCode.
tax_linesobject[]
[]
Tax information.
price string
[]
Tax (store currency amount) , accuracy 2.
price_setobject
[]
Multi-currency information of tax.
presentment_moneyobject
[]
The order price information presented to the buyer.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
shop_moneyobject
[]
The order price information recorded by the merchant.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
rate double
[]
Tax rate.
title string
[]
The tax description title.
taxable boolean
[]
Tax or not.
title string
[]
Product title.
variant_id string
[]
Product SKU serial number.
variant_title string
[]
Commodity attribute value, multiple divided by /, such as: 155 / red / large.
vendor string
[]
Supplier.
line_item_id string
[]
The ID of the product snapshot table, generated by the system, uniquely confirms a product with the order number.
quantity integer
[]
Quantity, quantity of goods.
restock_type string
[]
Inventory return type.

no_restock: not returned

cancel: canceled

return: returned

subtotal double
[]
Total refund amount (store currency amount), accuracy 2.
subtotal_setobject
[]
Total refund amount, multi-currency information, same on seller and buyer side.
presentment_moneyobject
[]
The order price information presented to the buyer.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
shop_moneyobject
[]
The order price information recorded by the merchant.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
total_tax double
[]
Tax amount for refund Product (store currency amount), accuracy 2.
total_tax_setobject
[]
Total tax amount, multi-currency information.
presentment_moneyobject
[]
The order price information presented to the buyer.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
shop_moneyobject
[]
The order price information recorded by the merchant.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
transactionsobject[]
[]
Refund transaction information.
amount string
[]
The value is rounded to two decimal places.
created_at string
[]
The date and time when the it is created. Format: ISO 8601.

Example: 2021-08-16T08:27:57+00:00
currency string
[]
Three-letter currency code that follows the ISO 4217 standard. For example, USD.
id string
[]
Refund ID.
kind string
[]
Transaction type, the return value is refund.
order_id string
[]
Order number.
processed_at string
[]
Refund order update time. Format: ISO 8601.

Example：2021-08-31T02:20:26+08:00
settle_amount string
[]
Refund amount (settlement currency).The value is rounded to two decimal places.
settle_currency string
[]
Settlement currency.The value of this parameter is a three-letter currency code that follows the ISO 4217 standard. For example, USD.
status string
[]
Handling status.

pending：refund in progress

failure：refund failed

success：refund successful

error：refund error

user_id string
[]
Buyer ID.
user_id string
[]
User ID.
service string
[]
Shipping method type, pickUp means pick up in store.
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.
address2 string
[]
The second line of the address. This typically includes information such as apartment, suite, or unit number.
city string
[]
The city in the address.
company string
[]
The company name of the recipient.
country string
[]
The country or region in the address.
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.
delivery_store_code string
[]
Store code for the "Deliver to Store" delivery method in Taiwan.
delivery_store_name string
[]
Store name for the "Deliver to Store" delivery method in Taiwan.
district string
[]
The district in the address.
district_code string
[]
The district code in the address.
first_name string
[]
The first name of the recipient.
last_name string
[]
The last name of the recipient.
latitude string
[]
The latitude where the address is located.
longitude string
[]
The longitude where the address is located.
name string
[]
The full name of the recipient.
phone string
[]
The phone number of the recipient.
province string
[]
The province in the address.
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.
zip string
[]
The postal code information of the address.
shipping_linesobject[]
[]
Logistics information.
code string
[]
Logistics number.
discount_allocationsobject[]
[]
Discount details.
amount string
[]
Discount amount (store currency amount). The value is rounded to two decimal places.
amount_setobject
[]
Discount multi-currency amounts.
presentment_moneyobject
[]
The order price information presented to the buyer.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
shop_moneyobject
[]
The order price information recorded by the merchant.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
discount_application_index integer
[]
Position in discount details.
discounted_price string
[]
Discount amount (store currency amount), accuracy 2.
discounted_price_setobject
[]
Discount multi-currency amounts.
presentment_moneyobject
[]
The order price information presented to the buyer.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
shop_moneyobject
[]
The order price information recorded by the merchant.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
phone string
[]
Phone.
price string
[]
Logistics shipping fee (store currency amount), accuracy 2.
price_setobject
[]
The shipping fee amount, displayed in both the buyer currency and the store currency.
presentment_moneyobject
[]
The order price information presented to the buyer.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
shop_moneyobject
[]
The order price information recorded by the merchant.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
requested_fulfillment_service_id string
[]
Transportation service code.
shipping_price string
[]
Original freight amount (non-discount amount, store currency amount).
shipping_price_setobject
[]
Original shipping value (non-discounted amount), multi-currency amount information.
presentment_moneyobject
[]
The order price information presented to the buyer.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
shop_moneyobject
[]
The order price information recorded by the merchant.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
source string
[]
Freight source.
tax_linesobject[]
[]
Logistics tax list.
price string
[]
Tax ( store currency amount ) , accuracy 2.
price_setobject
[]
Multi-currency information of tax.
presentment_moneyobject
[]
The order price information presented to the buyer.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
shop_moneyobject
[]
The order price information recorded by the merchant.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
rate double
[]
Tax rate.
title string
[]
The tax description title.
title string
[]
Logistics name.
source_identifier string
[]
ID used to identify business processing.
source_name string
[]
Marketing referral code when a customer clicks on a link to visit the store. The following URL parameters are supported: ref, resource, or r. For example, if the URL is myshopline.com/products/slide?ref=22dd9dctg, the value is 22dd9dctg.
source_url string
[]
Attribution URL, the customer clicks the link and jumps to the online store.
status string
[]
Order status.

open: The order is processing.

canceled: The order is cancelled.
store_id string
[]
Store ID.
subtotal_price string
[]
The total price after product discounts is calculated as the total product price minus discounts and custom discounts, displayed in the store currency.
subtotal_price_setobject
[]
The total price after product discounts is displayed in both the buyer currency and the store currency, calculated as the total product price minus discounts and custom discounts.
presentment_moneyobject
[]
The order price information presented to the buyer.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
shop_moneyobject
[]
The order price information recorded by the merchant.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
tags string
[]
Order label.
tax_description string
[]
The description for the tax.
tax_linesobject[]
[]
Tax information.
name string
[]
Tax name.
price string
[]
Tax ( store currency amount ) , accuracy 2.
price_setobject
[]
Multi-currency information of tax.
presentment_moneyobject
[]
The order price information presented to the buyer.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
shop_moneyobject
[]
The order price information recorded by the merchant.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
rate double
[]
Tax rate.
title string
[]
The tax description title.
tax_number string
[]
Tax ID.
tax_type string
[]
Types of tax ID.
taxes_included boolean
[]
Indicates whether this order include taxes.

true: including tax

false: excluding tax

Default value: false
total_discounts string
[]
The total order discount, calculated as the sum of marketing discounts and custom discounts, is rounded to two decimal places and displayed in the store currency.
total_discounts_setobject
[]
The total order discount, calculated as the sum of marketing discounts and custom discounts, is rounded to two decimal places and displayed in both the store currency and the buyer currency.
presentment_moneyobject
[]
The order price information presented to the buyer.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
shop_moneyobject
[]
The order price information recorded by the merchant.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
total_line_items_price string
[]
The total original price of the products，rounded to two decimal places, is displayed in the store currency.
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 order price information presented to the buyer.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
shop_moneyobject
[]
The order price information recorded by the merchant.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
total_outstanding string
[]
The total unpaid amount, rounded to two decimal places, is displayed in the store currency.
total_shipping_price_setobject
[]
The total shipping fee for the order，displayed in both the buyer currency and the store currency.
presentment_moneyobject
[]
The order price information presented to the buyer.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
shop_moneyobject
[]
The order price information recorded by the merchant.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
total_tax string
[]
The total tax amount，rounded to two decimal places, is displayed in the store currency.
total_tax_setobject
[]
The total tax amount，displayed in both the buyer currency and the store currency.
presentment_moneyobject
[]
The order price information presented to the buyer.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
shop_moneyobject
[]
The order price information recorded by the merchant.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
total_tip_received string
[]
The tip amount, rounded to two decimal places, is displayed in the store currency.
total_tip_received_setobject
[]
The tip amount, rounded to two decimal places, is displayed in both the store currency and the buyer currency.
presentment_moneyobject
[]
The order price information presented to the buyer.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
shop_moneyobject
[]
The order price information recorded by the merchant.
amount string
[]
The value is rounded to two decimal places.
currency_code string
[]
A three-letter currency code that follows the ISO 4217 standard. For example, USD.
total_weight double
[]
Total product weight, unit: g.
updated_at string
[]
Order update time. Format: ISO 8601.

Example：2021-08-31T02:20:26+08:00
user_id string
[]
Buyer ID.
utm_parameters string
[]
Ad business-specific parameters used for ad attribution calculation.

API Explorer

Debugger

Base URL

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

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/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