Get orders
GET https://{handle}.myshopline.com/admin/openapi/v20261201/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 .Get order details in bulk based on specified request information. For example, you can get orders by the order creation time or update time, or specify an order ID to get details for a single order.
Query Parameters
- financial_status stringThe payment status of the order. Valid values are:
unpaid: order not paidauthorized: order payment has been authorizedpending: order payment in progresspartially_paid: order partially paidpaid: order paidpartially_refunded: order partially refundedrefunded: order fully refunded
- name stringOrder number. Different from the order ID, this number can have a custom prefix set in the SHOPLINE Admin.Example:
D2034 - hidden_order stringWhether to query the archived orders or unarchived orders.
true: query archived ordersfalse: query unarchived order
Default value:false - search_content stringSearch content, such as order number, payment serial number, express delivery number, product name, product SKU number, and order amount.Example:
D203 - status stringOrder status. Valid values are:
open: order in processcancelled: order canceledany: contains many other statues, such as order archived
- updated_at_min stringSpecifies the start update date and time for orders to query. Orders updated on or after this date are returned. Format:ISO 8601.Example:
2021-08-04T23:59:59+08:00 - buyer_id stringThe ID of the buyer who placed the order.Example:
4201057495 - email stringEmail of the buyer who placed the order.Example:
Washingtontest@gmail.com - fields stringSpecify the fields to query, separated by commas. If not specified, all field information is returned.Example:
id,email,note - ids stringOrder IDs, separated by commas. Up to a maximum of 100 IDs.Example:
21050224312121887324667162, 21050224312121887324667164 - limit stringQuery quantity limit, the value must not exceed 100.Default value:
50 - sort_condition stringSpecify the sorting conditions for order results. You can sort by fields
order_at(order creating time) orid(order ID), and each field can be specified as eitherasc(ascending) ordesc(descending). Use commas to separate multiple sorting conditions.For example, if you specify the value of this field asorder_at:desc, id:asc, order results will first be sorted in descending order by order creation time, then in ascending order by order ID.Example:order_at:desc - updated_at_max stringSpecify the cutoff update date and time for orders to query. Orders updated on or before this date are returned. Format:ISO 8601.Example:
2021-08-18T23:59:59+08:00 - created_at_max stringSpecify the cutoff creation date and time for orders to query. Orders created on or before this date are returned. Format:ISO 8601.Example:
2021-08-18T23:59:59+08:00 - created_at_min stringSpecify the start creation date and time for orders to query. Orders created on or after this date are returned. Format:ISO 8601.Example:
2021-08-04T23:59:59+08:00 - fulfillment_status stringThe shipment status of the order. Valid values are:
unshipped: order not shippedpartial: order partially shippedshipped: order shipped
Default value:unshippedCaution: The accuracy of the inputted value will be strictly validated. If the value fails validation, the order query will fail and an errorfulfillment status value is illegalwill be triggered. - location stringThe ID of the location where the products in the order are fulfilled, or the POS transaction point ID. You can specify multiple location IDs by separating them with commas.Example:
5453386037065169090, 5564834083287605454 - page_info stringThe unique identifier for pagination queries, used to locate a specific page.This parameter value is obtained from the
linkvalue in the response header of this API after you have queried the pagination information.For example, if thelinkvalue you obtained is<https://{handle}.myshopline.com/admin/openapi/{version}/orders.json?limit=1&page_info=eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9>; rel="next", the value ofpage_infoiseyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9.For more information on how to use pagination, refer to Paging Mechanism. - since_id stringThe starting position of the order number ID of the data to be queried.Example:
21056199447626881527947685 - contract_ids stringSubscription contract IDs. You can specify multiple IDs by separating them with commas, up to a maximum of 50 IDs.Example:
3005619945158043247856
Request Headers
- Content-Type string requiredThe field must be set to the fixed value
application/json; charset=utf-8. - Authorization string requiredThe access token for the API resource. Refer to App authorization to obtain the access token, and then pass the obtained token in the Bearer format.Example:
Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA
Status Codes
- 200
- 401
- 429
For the complete list of codes and messages, see Http status code.
Response Headers
link
The URL link that provides the pagination data. You can obtainpage_infofrom this parameter for subsequent pagination requests.This parameter is returned when the requested page has a previous or next page.For more information on how to use pagination, refer to Paging Mechanism.traceId
A globally unique identifier for the request. It is used to track the request flow throughout the system, allowing for easy location and debugging when issues arise.
Response Body
ordersobject[]
List of order details.browser_ip stringThe IP address of the customer's browser used during order placement.Example:157.119.232.35cart_token stringThe unique identifier for shopping cart data.Example:c2c4a58186b9d96395d7e6b5c2969577deduct_member_point_amount stringThe amount deducted from the order using member points, expressed in the store currency and rounded to two decimal places.Example:8.00discount_codesobject[]
A list of promo code information.amount stringDiscount amount in the store currency. The value is rounded to two decimal places.Example:8.00amount_setobject
The discount amount, displayed in both the buyer currency and the store currency.shop_moneyobject
The discount amount information recorded by the merchant.amount stringThe discount amount. The value is rounded to two decimal places.Example:10.00presentment_moneyobject
The discount amount information presented to the buyer.amount stringThe discount amount. The value is rounded to two decimal places.Example:70.00code stringPromo code.Example:KIN4GNAB2FRHtype stringType of discount. Valid values are:减金额: amount reduction打折: offer a discount免运费: free shipping加价品: add-on purchase deal任意N件优惠价: discount for purchasing any N itemsA+B组合优惠价: discount for purchasing the product A and B combo赠品: free gift固定售价: fixed price最低价商品免费: lowest-priced product free打包价: package price第N件打折: discount on the Nth item买x送y: buy x and get y free自定义: custom discount
DEPRECATED:This parameter is deprecated from API version v20241201.payment_detailsobject[]
A list of order payment information.status_msg stringThe description ofstatus_code.Example:PENDING_REVIEWcreate_time stringThe date and time when the payment order was created. Format: ISO 8601.Example:2021-08-16T08:27:57+00:00pay_merchant_email stringThe email address of the payment service provider.Example:Washingtontest@gmail.compay_merchant_id stringPayment service provider ID.Example:4201057379settle_currency stringThe currency used by the customer to place the order. The value of this parameter is a three-letter currency code that follow the ISO 4217 standard.Example:USDgiftcard_presentment_moneyobject
The gift card amount information presented to the buyer.amount stringThe giftcard amount. The value is rounded to two decimal places.currency_code stringA three-letter currency code that follows the ISO 4217 standard.pay_seq stringPayment order number.Example:23057287797738260472676128gateway stringPayment method name.Example:Mypaypay_channel stringPayment channel.Example:Paypalpay_channel_deal_id stringPayment serial number from the external channel.Example:pi_3MI897Hezv8FxjBO1uGxMPhXpay_status stringPayment status. Valid values are:unpaid: unpaidpending: payment in processrisking: under risk controlpaid:paidpaid_overtime: payment timeoutpaid_failed: payment failed
payment_method stringPayment method.settle_pay_amount doublePayment amount insettle_currency. The value is rounded to two decimal places.Example:8pay_amount doublePayment amount in the store currency. The value is rounded to two decimal places.Example:8pay_merchant_order_id stringPayment service provider order number.Example:233445354566processed_at stringCustom time for the payment order. Format: ISO 8601.Example:2023-04-12T22:59:52+08:00status_code stringPayment gateway standard status code.Example:RISK_PENDINGtotal_discounts stringThe total order discount, calculated as the sum of marketing discounts and custom discounts. The amount is rounded to two decimal places and displayed in the store currency.DEPRECATED:This parameter is deprecated from API version v20210901.Example:3.25total_tax stringThe total tax amount in the store currency. The value is rounded to two decimal places.Example:8.00user_id stringBuyer ID.Example:4201057495current_total_tax_setobject
The total tax amount, displayed in both the buyer currency and the store currency.presentment_moneyobject
The tax information presented to the buyer.amount stringThe tax amount. The value is rounded to two decimal places.Example:8.00shop_moneyobject
The tax information recorded by the merchant.amount stringThe tax amount. The value is rounded to two decimal places.Example:8.00billing_addressobject
The address for sending billing invoices.country stringThe country or region in the address.Example:USAfirst_name stringThe first name of the billing recipient.Example:Tomlast_name stringThe last name of the billing recipient.Example:Washingtonname stringThe full name of the billing recipient.Example:test1001phone stringThe phone number of the billing recipient.Example:13100000000province stringThe province in the address.Example:Californiazip stringThe postal code information of the address.Example:92503address1 stringThe first line of the address. This typically includes information such as the street address or a post office box number.Example:Address 1address2 stringThe second line of the address. This typically includes information such as apartment, suite, or unit number.Example:Address 2company stringThe company name of the billing recipient.Example:New company namecountry_code stringA 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:USprovince_code stringThe code for the province in the billing address, which can be a custom code or a two-digit ISO 3166-2 international code.Example:4200006standard_province_code stringThe code for the province in the billing address, which is a two-digit ISO 3166-2 international code.This differs fromprovince_code- theprovince_coderesponse field uses a custom code.city stringThe city in the address.Example:New Yorkcreated_at stringThe date and time when the order was created. Format: ISO 8601.Example:2021-08-16T08:27:57+00:00credit_limitobject
Credit payment information.credit_limit_currency stringThe 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.Example:USDis_credit_limit booleanIndicates whether the order used credit payment.true: usedfalse: not used
outstanding_credit_limit stringThe current occupied credit amount, initially set tototal_credit_limit. This value decreases with actions like repayments.Example:1.00total_credit_limit stringThe total credit amount used to pay for this order.Example:1.00referring_site stringAttribution URL, used to record how the buyer was redirected to the online store.Example:https://www.referringSite.comtotal_tip_received_setobject
The tip amount, displayed in both the store currency and the buyer currency.presentment_moneyobject
The tip amount information presented to the buyer.amount stringThe tip amount. The value is rounded to two decimal places.Example:10.00shop_moneyobject
The tip amount information recorded by the merchant.amount stringThe tip amount. The value is rounded to two decimal places.Example:70.00cancel_reason stringMerchant's reason for cancellation.Example:I don't want to buy it.checkout_token stringThe unique identifier for abandoned order data. After a customer initiates the checkout process, an abandoned order is generated.Example:c2c4a58186b9d96395d7e6b5c2969577order_source stringThe order source channel handle. The handle is a semantic identifier.payment_gateway_names arrayPayment method list. Valid values are:SLpaymentsPaypalOceanpayTwoCheckoutAsiaBillStripePacypayWorldPayCODCUSTOMadjustPayXenditXenditOther
Example:["SLpayments"]processed_user_id stringThe ID of the order creator.Example:4201057495shipping_addressobject
The address used for receiving packages.company stringThe company name of the recipient.Example:Company Namedelivery_store_code stringStore code for the "Deliver to Store" delivery method in Taiwan.Example:1001district stringThe district in the address.Example:Panyu Districtfirst_name stringThe first name of the recipient.Example:Tomstandard_province_code stringThe code for the province in the shipping address, which is a two-digit ISO 3166-2 international code.This differs fromprovince_code- theprovince_coderesponse field uses a custom code.district_code stringThe district code in the address.Example:521000latitude stringThe latitude where the address is located.Example:15longitude stringThe longitude where the address is located.Example:41province stringThe province in the address.Example:Guangdong Provincecity stringThe city in the address.Example:Citycountry_code stringA 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:USdelivery_store_name stringStore name for the "Deliver to Store" delivery method in Taiwan.Example:Store namename stringThe full name of the recipient.Example:Tom.Washingtonaddress1 stringThe first line of the address. This typically includes information such as the street address or a post office box number.Example:Address 1address2 stringThe second line of the address. This typically includes information such as apartment, suite, or unit number.Example:Address 2country stringThe country or region in the address.Example:Chinalast_name stringThe last name of the recipient.Example:Washingtonphone stringThe phone number of the recipient.Example:13100000000province_code stringThe code for the province in the address, which can be a custom code or a two-digit ISO 3166-2 international code.Example:510000zip stringThe postal code information of the address.Example:521000current_total_discounts_setobject
The total discount amount displayed in both the buyer currency and the store currency. It is calculated by adding marketing discounts and custom discounts, with the resulting amount rounded to two decimal places.presentment_moneyobject
The total discount amount information presented to the buyer.amount stringThe total discount amount. The value is rounded to two decimal places.Example:8.00shop_moneyobject
The total discount amount information recorded by the merchant.amount stringThe total discount amount. The value is rounded to two decimal places.Example:8.00email stringBuyer's email.Example:hok@shoplineapp.comphone stringBuyer's mobile phone number.Example:18978789878total_tip_received stringThe tip amount in the store currency. The value is rounded to two decimal places.Example:8.00current_total_discounts stringThe total discount amount in the store currency. It is calculated by adding marketing discounts and custom discounts, with the resulting amount rounded to two decimal places.Example:1.00current_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 stringThe total order amount. The value is rounded to two decimal places.Example:8.00shop_moneyobject
The order price information recorded by the merchant.amount stringThe total order amount. The value is rounded to two decimal places.Example:8.00landing_site stringLink to record complete order attribution landing page information.Example:https://www.url.comnote stringMerchant notes.Example:Notesservice stringShipping method type. Valid values are:Pickup: pick up at the storenull: other shipping methods
status stringOrder status. Valid values are:open: The order is processing.canceled: The order is cancelled.
total_line_items_price_setobject
The total original price of the products, displayed in both the buyer currency and the store currency.presentment_moneyobject
The original price information presented to the buyer.amount stringThe original price. The value is rounded to two decimal places.Example:8.00shop_moneyobject
The original price information recorded by the merchant.amount stringThe original price. The value is rounded to two decimal places.Example:8.00currency stringTransaction currency. A three-letter currency code that follows the ISO 4217 standard.Example:USDcurrent_subtotal_price stringThe total amount of products, calculated by multiplying the unit price by the quantity and displayed in the store currency.Example:78.0discount_applicationsobject[]
A list of discount information.allocation_method stringThe discount scope. Valid values are:across: The discount is applied to the total product amount.each: The discount is applied to each product individually.
For example, for a purchase of three identical products with a discount amountvalueof 10 yuan. If theallocation_methodisacross, the total amount of the three products is reduced by 10 yuan. If theallocation_methodiseach, each product is individually reduced by 10 yuan.benefit_type integerThe type of discount applied to the product line:-1:No discount1:Amount reduction2:Discount3:Free shipping fee4:Marked-up item5:Preferential price for any N items6:Preferential price for the combination of A and B7:Gift8:Fixed selling price9:The lowest-priced item is free11:Discount for the Nth item12:Buy x and get y free13:Customized14:M (Monetary Unit) for N Items
code stringDiscount code.Example:82UD6BTPX9L2target_selection stringDiscount allocation method for line items. Valid values are:explicit: The discount is allocated only to the explicitly specified line items.all: The discount is allocated to all line items.entitled: The discount is allocated only to the line items that are entitled to use the discount.
target_type stringDiscount target type. Valid values are:line_item: discount applied to the productshipping_line: discount applied to the shipping fee
title stringAutomatic discount title.Example:Automatic discount titlevalue_type stringThe type of discount value. Valid values are:fix_amount: Fixed amount discount. For example, ifvalueis10in CNY, it means a discount of 10 yuan.percentage: Percentage-based discount. For example, ifvalueis10, it means 10% off of the order amount.
activity_type integerThe type of promotion applied to the product line:0: Flash Sale1: Time-Limited Promotion2: Bundle Offer3: Discount Code4: One-Page Store5: Free Gift6: Pre-Order7: Add-On Item8: Gift Box9: Product Upsell Campaign
description stringCustom discount description.Example:Custom discount descriptiontype stringDiscount type. Valid values are:manual: manual discountautomatic: automatic discountdiscount_code: discount applied through a discount code
value stringThe specific value of the discount, in the store currency.- When
value_typeisfix_amount, this field value represents a specific discount amount. For example, if the value is10and the store currency is CNY, it means a discount of 10 yuan. - When
value_typeispercentage, the value of this field value represents a specific discount percentage. For example,10means 10% off of the order amount.
Example:2.01line_itemsobject[]
A list of order product snapshot.harmonized_system_code stringHarmonized system code, used to categorize a product in international trade.Example:harmonized system codeid stringThe ID of the product snapshots table, generated by the system. Combined with theorder.id, it uniquely identifies a product.Example:417image_url stringThe URL address that stores the product image.Example:https://d2n979dmt31clo.cloudfront.net/image/store/4211449909/1667384795847/63928f08a7174ab2958c6a969product_id stringSPU serial number.Example:16056761559984840457934011customized_attributesobject[]
A list of product custom attributes.key stringProduct custom attribute name, imported from external sources.WhenkeyisbusinessType,valueis fixed to3, indicating a gift.value stringProduct custom attribute value.WhenkeyisbusinessType,valueis fixed to3, indicating a gift.fulfillment_service stringLogistics company name.Example:SF Internationalvendor stringSupplier.Example:Supplierfulfillment_status stringShipping status. Valid values are:fulfilled: order shippedpartial: order partially shippednull: order not shipped
tags stringProduct tags. Multiple tags are separated by commas.Example:watchdiscount_allocationsobject[]
The discount amount, displayed in both the buyer currency and the store currency.amount stringThe discount amount. The value is rounded to two decimal places.Example:8.00amount_setobject
Discount details in multiple currencies.presentment_moneyobject
The discount amount information presented to the buyer.amount stringThe discount amount. The value is rounded to two decimal places.Example:8.00shop_moneyobject
The discount amount information recorded by the merchant.amount stringThe discount amount. The value is rounded to two decimal places.Example:8.00discount_application_index integerThe position of the discount applied to the product within theorders.discount_applicationslist.Example:1dutiesobject[]
A list of duty information.country_code_of_origin stringCountry or region code indicating the place of origin or shipping origin. Format: ISO 3166-1.Example:USharmonized_system_code stringHarmonized system code, used to categorize a product in international trade.Example:A0023id stringTariff number.Example:H2325priceobject
The duty amount, displayed in both the buyer currency and the store currency.presentment_moneyobject
The duty amount information presented to the buyer.amount stringThe duty amount. The value is rounded to two decimal places.Example:8.88shop_moneyobject
The duty amount information recorded by the merchant.amount stringThe duty amount. The value is rounded to two decimal places.Example:8.88tax_linesobject[]
A list of tax information.price_setobject
The tax amount, displayed in both the buyer currency and the store currency.presentment_moneyobject
The tax amount information presented to the buyer.amount stringThe tax amount. The value is rounded to two decimal places.Example:8.88shop_moneyobject
The tax amount information recorded by the merchant.amount stringThe tax amount. The value is rounded to two decimal places.Example:8.88rate doubleThe tax rate as a decimal value, rounded to four decimal places. For example, a 2% tax rate is represented as0.0200. This field value is for display only.rate_percentage doubleThe tax rate as a percentage numerical value, rounded to two decimal places. For example, a 2% tax rate is represented as2.00. This field value is for display only.title stringThe title for the tax description, for display only.Example:Tax titlegift_card booleanWhether the product is a gift card.true: gift cardfalse: not a gift card
location_id stringLocal delivery location number or standard delivery location number.Example:5327026538935748524price_setobject
The product price, displayed in both the store currency and the buyer currency.presentment_moneyobject
The product price information presented to the buyer.amount stringThe product price. The value is rounded to two decimal places.Example:80.00shop_moneyobject
The product price information recorded by the merchant.amount stringThe product price. The value is rounded to two decimal places.Example:10fulfillable_quantity integerRemaining fulfillable quantity at product line level.Example:1name stringSKU title, same astitle.Example:Product titleattribute stringThe option information of the product variant, composed of the variant name and the option value.Example:color - redtax_linesobject[]
A list of tax information.type stringTax fee type, used to distinguish between commodity tax and freight tax.product_tax: commodity taxshipping_tax: freight tax
price stringTax in store currency. The value is rounded to two decimal places.Example:8.00price_setobject
The tax amount, displayed in both the buyer currency and the store currency.presentment_moneyobject
The tax amount information presented to the buyer.amount stringThe tax amount. The value is rounded to two decimal places.Example:8.00shop_moneyobject
The tax amount information recorded by the merchant.amount stringThe tax amount. The value is rounded to two decimal places.Example:8.00rate doubleThe tax rate as a decimal value, rounded to four decimal places. For example, a 2% tax rate is represented as0.0200. This field value is for display only.title stringThe title for the tax description, for display only.Example:taxesvariant_title stringProduct variant value. Multiple values are separated by/.Example:bigis_bundle booleanwhether the product is a bundle product.requires_shipping booleanIndicates whether the product is subject to shipping.true:Shipping is required.false:Shipping is not required.
taxable booleanWhether the product is subject to tax.true: Tax is required.false: No tax is required.
propertiesobject[]
A list of product customization information.additional stringAdditional custom fields for products. For example, ifnameistext,additionalcan include attributes such as font size, font style, and color.Example:Additional fieldsname stringCustom attribute name.Example:Attribute namerole_visibility stringCustom information visibility roles:customer: Visible to buyers onlymerchant: Visible to merchants onlyall:Visible to both buyers and merchantsnone: Hidden from both buyers and merchants
show booleanWhether the customized information is visible.type stringCustom information type. Valid values are:text: text typepicture: picture typelink: hyperlink type
urls arrayURL resource list.- If
typeispicture, thumbnails are rendered via theurlsvalues. - If
typeislink, the hyperlink is the first URL in theurlsvalues.
Example:["[\"https://www.url.com\"]"]value stringCustom attribute value.Example:attribute valuequantity integerQuantity of items in the order.Example:1sku stringProduct SKU serial number.Example:18056761559987524812644011country_code_of_origin stringCountry or region code indicating the place of origin or shipping origin. Format: ISO 3166-1.Example:USis_bundle_component booleanwhether the product is a bundle component product.price stringThe product price in store currency. The value is rounded to two decimal places.Example:8.00title stringProduct title.Example:beautiful skirtvariant_id stringA unique code assigned to a distinct product in inventory.Example:18056761559987524812644011bundle_parent_variant_id stringParent product variant ID associated with the bundle child product.grams doubleThe weight of the product in grams(g).Example:100presentment_currency stringBuyer currency, the same as the store currency. A three-letter currency code that follows the ISO 4217 standard.Example:USDtax_description stringThe description for the tax.client_detailsobject
Client details.browser_ip stringThe IP address of the customer's browser used during order placement.Example:157.119.232.35session_hash stringMember session encrypted information.Example:c2c4a58186b9d96395d7e6b5c2969577user_agent stringUser agent.Example:Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/106.0.0.0 Safulfillment_status stringShipping status. Valid values are:fulfilled: order shippedpartial: order partially shippednull: order not shipped
name stringStore custom order number, starting from 1001. You can set a prefix for this value, such astest1001.Example:test1001subtotal_price stringThe final price after discounts, calculated as the total product price minus any marketing discounts and custom discounts. The amount is displayed in the store currency.Example:8.00total_discounts_setobject
The total order discount, calculated as the sum of marketing discounts and custom discounts. This field contains amounts displayed in both the buyer and store currencies.DEPRECATED:This parameter is deprecated from API version v20210901.presentment_moneyobject
The discount amount information presented to the buyer.amount stringThe discount amount. The value is rounded to two decimal places.Example:8.00shop_moneyobject
The discount amount information recorded by the merchant.amount stringThe discount amount. The value is rounded to two decimal places.Example:8.00current_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.shop_moneyobject
The order price information recorded by the merchant.amount stringThe order amount. The value is rounded to two decimal places.Example:8.00presentment_moneyobject
The order price information presented to the buyer.amount stringThe order amount. The value is rounded to two decimal places.Example:8.00deduct_member_point_amount_setobject
The amount deducted from the order using member points, displayed in both the buyer currency and the store currency.presentment_moneyobject
The deduction amount information presented to the buyer.amount stringThe deduction amount. The value is rounded to two decimal places.Example:8.00shop_moneyobject
The deduction amount information recorded by the merchant.amount stringThe deduction amount. The value is rounded to two decimal places.Example:1.00id stringOrder ID, system-defined number.Example:21050224312121887324667162locationsobject[]
A list of product pickup location addresses.address stringThe first line of the address. This typically includes information such as the street address or a post office box number.Example:Address 1city stringThe city in the address.Example:Guangzhoucountry_code stringA 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:CNphone stringPhone number.Example:13100000000province stringThe province in the address.Example:Guangdong Provincezip stringThe postal code information of the address.Example:521000address_add stringThe second line of the address. This typically includes information such as apartment, suite, or unit number.Example:Address 22country stringThe country or region in the address.Example:Chinadistrict stringThe district or county in the address.Example:Panyu Districtlocation_id stringUnique code of the pickup location.Example:5327026538935748524name stringPickup location name.Example:Wanda squaretown stringThe village or town in the address.Example:towntype stringLocation types. Valid values are:posLocation: The store location where the order was placed using the POS channel. It is recommended to useposLocationId, becauseposLocationwill be deprecated soon.pickupLocation: The store location for customer pickup when the order's delivery method is self-pickup.productLocation: The inventory location of the products in the order. It is recommended to use thelocationinformation in the product line, becauseproductLocationwill be deprecated soon.
tax_linesobject[]
A list of tax information.name stringTax name.Example:Tax nameprice stringTax in store currency. The value is rounded to two decimal places.Example:8.00price_setobject
The tax amount, displayed in both the buyer currency and the store currency.presentment_moneyobject
The tax amount information presented to the buyer.amount stringThe tax amount. The value is rounded to two decimal places.Example:8.00shop_moneyobject
The tax amount information recorded by the merchant.amount stringThe tax amount. The value is rounded to two decimal places.Example:8.00rate doubleThe tax rate as a decimal value, rounded to four decimal places. For example, a 2% tax rate is represented as0.0200. This field value is for display only.title stringThe title for the tax description, for display only.Example:Tax namefinancial_status stringOrder payment status. Valid values are:unpaid: order not paidauthorized: order payment has been authorizedpending: order payment in progresspartially_paid: order partially paidpaid: order paidpartially_refunded: order partially refundrefunded: order refund
fulfillmentsobject[]
A list of fulfillment information.created_at stringThe date and time when the fulfillment was created. Format: ISO 8601.Example:2024-08-31T02:20:26+08:00name stringFulfillment code.Example:1032-F2order_id stringOrder number.Example:21056577640603870897253153status stringShipping status of the order package. Valid values are:success: shipment dispatchedcancelled: shipment has been canceled
tracking_company stringLogistics service provider.Example:SF Internationaltracking_info_listobject[]
If this parameter is specified, the individual parameterstracking_url,tracking_number, andtracking_companywill be ignored.Maximum of 10 tracking infos allowed.tracking_url stringThe tracking number.tracking_company stringThe URL for tracking the package.tracking_number stringThe logistics service provider.updated_at stringThe date and time when the fulfillment was updated. Format: ISO 8601.Example:2022-11-04T10:18:46+00:00id stringFulfillment ID.Example:22046737798141702810214336line_itemsobject[]
Product list.id stringThe ID of the product snapshots table, generated by the system. Combined with theorder.id, it uniquely identifies a product.Example:100is_bundle_component booleanwhether the product is a bundle component product.product_id stringSPU serial number.Example:16056761559984840457934011quantity integerQuantity of items in the order.Example:1title stringProduct title.Example:Useful productgrams doubleThe weight of the product in grams(g).Example:100image_url stringThe URL address that stores the product image.Example:https://d2n979dmt31clo.cloudfront.net/image/store/4211449909/1667384795847/63928f08a7174ab2958c6a969fulfillment_service stringLogistics company name.Example:SF Expressfulfillment_status stringShipping status. Valid values are:fulfilled: order shippedpartial: order partially shippednull: order not shipped
is_bundle booleanwhether the product is a bundle component product.location_id stringThe unique ID of the pickup location.Example:5445886274929439997price_setobject
The product price, displayed in both the store currency and the buyer currency.presentment_moneyobject
The product price information presented to the buyer.amount stringThe product price. The value is rounded to two decimal places.Example:70.0shop_moneyobject
The product price information recorded by the merchant.amount stringThe product price. The value is rounded to two decimal places.Example:10.00tax_linesobject[]
A list of tax information.rate doubleThe tax rate as a decimal value, rounded to four decimal places. For example, a 2% tax rate is represented as0.0200. This field value is for display only.title stringThe title for the tax description, for display only.Example:taxesprice stringTax in store currency. The value is rounded to two decimal places.Example:8.00price_setobject
The tax amount, displayed in both the buyer currency and the store currency.presentment_moneyobject
The tax amount information presented to the buyer.amount stringThe tax amount. The value is rounded to two decimal places.Example:8.00shop_moneyobject
The tax amount information recorded by the merchant.amount stringThe tax amount. The value is rounded to two decimal places.Example:8.00taxable booleanWhether the product is subject to tax.true: Tax is required.false: No tax is required.
fulfillable_quantity integerRemaining fulfillable quantity of products at the product line level.Example:1fulfillment_quantity integerThe quantity of products that are actually shipped.Example:1name stringSKU title, same astitle.Example:Product namerequires_shipping booleanIndicates whether the product is subject to shipping.true:Shipping is required.false:Shipping is not required.
sku stringProduct SKU serial number.Example:test-002variant_id stringA unique code assigned to a distinct product in inventory.Example:18056761559987524812644011variant_title stringProduct variant value. Multiple values are separated by/.Example:big/redvendor stringSupplier.Example:Supplierprice stringThe product price in store currency. The value is rounded to two decimal places.Example:10.00attribute stringThe option information of the product variant, composed of the variant name and the option value.Example:color - redbundle_parent_variant_id stringParent product variant ID associated with the bundle child product.shipment_status stringProduct delivery status. Valid values are:out_for_delivery: out for deliverydelivered: deliveredfaliure: delivery failedpicked_up: picked up
tracking_number stringThe delivery tracking number provided by the logistics service provider.Example:yun0001tracking_url stringThe domain name of the logistics company.Example:https://www.sf-international.com/store_id stringStore ID.Example:1644828244663total_line_items_price stringThe total original price of the products, rounded to two decimal places, displayed in the store currency.Example:8.00total_shipping_price_setobject
The total shipping fee for the order, displayed in both the buyer currency and the store currency.presentment_moneyobject
The shipping fee information presented to the buyer.amount stringThe shipping fee. The value is rounded to two decimal places.Example:8.00shop_moneyobject
The shipping fee information recorded by the merchant.amount stringThe shipping fee. The value is rounded to two decimal places.Example:8.00companyobject
The buyer's company information as recorded at the time the order was placed.id stringCompany ID.Example:1005619945158043247856location_id stringLocation ID.Example:3005619945158043247856tax_registration_id stringTax registration ID.Example:213213contract_seq stringSubscription contract ID.Example:3005619945158043247856current_total_tax stringThe total tax amount, displayed in the store currency.Example:1.00hidden_order booleanIndicates whether it is an archived order.true: specify archived ordersfalse: specify unarchived orders
tax_number stringTax ID.adjust_price stringThe amount discrepancy due to rounding adjustments in POS transactions, expressed in the store currency.Example:8.00buyer_note stringBuyer's message.Example:messagecheckout_id stringAbandoned order ID.Example:2404785166526352972864current_total_duties_setobject
The total customs duties for the products, displayed in both the buyer currency and the store currency.presentment_moneyobject
The total customs duties information for the products presented to the buyer.amount stringThe duty amount. The value is rounded to two decimal places.Example:8.88shop_moneyobject
The total customs duties information for the products recorded by the merchant.amount stringThe duty amount. The value is rounded to two decimal places.Example:8.88customerobject
Buyer information.phone stringThe phone number of the buyer.Example:13100000000id stringBuyer's ID.Example:4201057495last_name stringThe last name of the buyer.Example:Washingtonupdated_at stringThe date and time when the buyer's information was updated. Format:ISO 8601.Example:2022-11-04T10:18:46+00:00addressesobject
Buyer's address information.address2 stringThe second line of the address. This typically includes information such as apartment, suite, or unit number.Example:65788city stringThe city in the address.Example:Yangquan Citycountry_code stringA 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:USlast_name stringThe last name of the recipient.Example:Washingtonphone stringThe phone number of the buyer.Example:13100000000zip stringThe postal code information of the address.Example:521000country stringThe country or region in the address.Example:Chinafirst_name stringThe first name of the recipient.Example:Tomname stringThe full name of the recipient.Example:D203province stringThe province in the address.Example:Shanxi Provinceprovince_code stringThe code for the province in the billing address, which can be a custom code or a two-digit ISO 3166-2 international code.Example:ASDaddress1 stringThe first line of the address. This typically includes information such as the street address or a post office box number.Example:Wandaarea_code stringThe area or country code for the phone number.Example:+86created_at stringThe date and time when the buyer information was created. Format: ISO 8601.Example:2024-08-31T02:20:26+08:00email stringThe email of the buyer.Example:Washingtontest@gmail.comfirst_name stringThe first name of the buyer.Example:Tomrefundsobject[]
Refund list.id stringRefund ID.Example:2605659027312156877634note stringRefund notes of merchant.Example:Refund notesorder_adjustmentsobject[]
A list of adjusted order information, used to record two types of information:- Refund information related to shipping costs (
kindisshipping_refund). - The difference between the automatically calculated refund amount and the actual refund amount (
kindisrefund_discrepancy).
amount_setobject
The adjustment order amount, displayed in both the buyer currency and the store currency.presentment_moneyobject
The adjustment order amount information presented to the buyer.amount doubleThe adjustment order amount. The value is rounded to two decimal places.Example:8shop_moneyobject
The adjustment order amount information recorded by the merchant.amount doubleThe adjustment order amount. The value is rounded to two decimal places.Example:8kind stringThe adjustment order type. Valid values are:refund_discrepancy: shipping amount adjustmentshipping_refund: payment order amount adjustment
reason stringReason for adjustment.Example:Refund discrepancyrefund_id stringThe refund order ID.Example:2605659027312156877634amount stringThe adjustment order amount. The value is rounded to two decimal places.Example:8.00id stringThe adjustment order ID.Example:RAP5570565996182771228order_id stringOrder number.Example:21056577640603870897253153tax_amount stringThe tax amount of the adjusted order in store currency. The value is rounded to two decimal places.Example:8.00tax_amount_setobject
The tax amount of the adjustment order, displayed in both the buyer currency and the store currency.presentment_moneyobject
The tax amount information presented to the buyer.amount doubleThe tax amount. The value is rounded to two decimal places.Example:8shop_moneyobject
The tax amount information recorded by the merchant.amount doubleThe tax amount. The value is rounded to two decimal places.Example:8order_id stringOrder number.Example:21056577640603870897253153user_id stringBuyer ID.Example:4201057495created_at stringThe date and time when the refund order was created. Format: ISO 8601.Example:2021-08-16T08:27:57+00:00refund_line_itemsobject[]
A list of refund details for each item line.id stringRefund order number.Example:2605659027312156877634line_itemobject
The product line information in the fulfillment order.attribute stringThe option information of the product variant, composed of the variant name and the option value.Example:color - redfulfillable_quantity integerRemaining fulfillable quantity at product line level.Example:1fulfillment_status stringShipping status. Valid values are:fulfilled: order shippedpartial: order partially shippednull: order not shipped
variant_id stringA unique code assigned to a distinct product in inventory.Example:18056761559987524812644011fulfillment_service stringLogistics company name.Example:SF Internationalname stringSKU title, same astitle.Example:18056761559987524812644011quantity integerQuantity of items in the order.Example:1sku stringProduct SKU serial number.Example:sku namevariant_title stringProduct variant value. Multiple values are separated by/.Example:big/redvendor stringSupplier.Example:Suppliergrams doubleThe weight of the product in grams(g).Example:1id stringThe ID of the product snapshots table, generated by the system. Combined with theorder.id, it uniquely identifies a product.Example:403product_id stringSPU serial number.Example:16056761559984840457934011requires_shipping booleanIndicates whether the product is subject to shipping.true:Shipping is required.false:Shipping is not required.
tax_linesobject[]
A list of tax information.price stringTax in store currency. The value is rounded to two decimal places.Example:8.00price_setobject
The tax amount, displayed in both the buyer currency and the store currency.presentment_moneyobject
The tax amount information presented to the buyer.amount stringThe tax amount. The value is rounded to two decimal places.Example:8.00shop_moneyobject
The tax amount information recorded by the merchant.amount stringThe tax amount. The value is rounded to two decimal places.Example:8.00rate doubleThe tax rate as a decimal value, rounded to four decimal places. For example, a 2% tax rate is represented as0.0200. This field value is for display only.title stringThe title for the tax description, for display only.Example:Headlinetaxable booleanWhether the product is subject to tax.true: Tax is required.false: No tax is required.
price stringThe product price in store currency. The value is rounded to two decimal places.Example:8.00price_setobject
The product price, displayed in both the store currency and the buyer currency.presentment_moneyobject
The product price information presented to the buyer.amount stringThe product price. The value is rounded to two decimal places.Example:10.00shop_moneyobject
The product price information recorded by the merchant.amount stringThe product price. The value is rounded to two decimal places.Example:70.00title stringProduct title.Example:Product titlequantity integerThe quantity of refunded products.Example:1restock_type stringInventory return type. Valid values are:no_restock: not returnedcancel: canceledreturn: returned
subtotal_setobject
The total amount of the refund displayed in both the buyer currency and the store currency. It is calculated as the product of the unit price and quantity.presentment_moneyobject
The refund amount information presented to the buyer.amount stringThe refund amount. The value is rounded to two decimal places.Example:8.00shop_moneyobject
The refund amount information recorded by the merchant.amount stringThe refund amount. The value is rounded to two decimal places.Example:8.00total_tax doubleThe tax amount of the refunded products, displayed in the store currency. The value is rounded to two decimal places.Example:8line_item_id stringThe ID of the product snapshots table, generated by the system. Combined with theorder.id, it uniquely identifies a product.Example:406subtotal doubleThe total amount of the refund in the store currency. It is calculated as the product of the unit price and quantity.Example:8total_tax_setobject
The tax amount of the refunded products, displayed in both the buyer currency and the store currency.presentment_moneyobject
The tax amount information presented to the buyer.amount stringThe tax amount. The value is rounded to two decimal places.Example:8.00shop_moneyobject
The tax amount information recorded by the merchant.amount stringThe tax amount. The value is rounded to two decimal places.Example:8.00transactionsobject[]
A list of refund transaction information.amount stringThe refund amount. The value is rounded to two decimal places.Example:8.00channel_refund_id stringA unique identifier for the refund order from the external channel or payment provider.created_at stringThe date and time when the refund transaction order was created. Format: ISO 8601.Example:2021-08-16T08:27:57+00:00order_id stringOrder number.Example:21056577640603870897253153settle_amount stringRefund amount in the settlement currency (settle_currency). The value is rounded to two decimal places.Example:8.00settle_currency stringRefund settlement currency. The value of this parameter is a three-letter currency code that follows the ISO 4217 standard.Example:USDgateway stringPayment channel code.Example:Mypayid stringRefund ID.Example:2605659027312156877634kind stringTransaction type. The value is fixed torefund.Example:refundstatus stringRefund status. Valid values are:pending: refund in progressfailure: refund failedsuccess: refund successfulerror: refund error
status_update_at stringUpdate time of the refund order status.user_id stringBuyer ID.Example:4201057495total_outstanding stringThe total unpaid amount in the store currency. The value is rounded to two decimal places.Example:8.00updated_at stringThe date and time when the order was updated. Format: ISO 8601.Example:2021-08-16T08:27:57+00:00current_total_price stringThe total order amount, displayed in the store currency.Example:60.0note_attributesobject[]
A list of merchant note logs.name stringMerchant ID, indicating the note source.Example:Note sourcevalue stringNote content.Example:Notessource_url stringAttribution URL, used to record how the buyer was redirected to the online store.taxes_included booleanIndicates whether this order includes taxes.true: including taxesfalse: excluding taxes
total_tax_setobject
The total tax amount, displayed in both the buyer currency and the store currency.presentment_moneyobject
The tax amount information presented to the buyer.amount stringThe tax amount. The value is rounded to two decimal places.Example:8.00shop_moneyobject
The tax amount information recorded by the merchant.amount stringThe tax amount. The value is rounded to two decimal places.Example:8.00total_weight doubleThe total weight of products in grams(g).Example:1utm_parameters stringParameters specifically designed for the advertising business, used for ad attribution calculation.cancelled_at stringThe date and time when the order was canceled. Format: ISO 8601.Example:2012-05-01T14:22:25-04:00po_number stringPurchase order number for a B2B order.pos_location_id stringPOS trading location ID.Example:5327026538935748524tax_type stringThe type of tax applicable to the order. Valid values are:product_tax: product taxshipping_tax: shipping tax
payment_termsobject
Information related to payment terms.updated_at stringThe date and time when the payment term was updated. Format: ISO 8601.Example:2024-06-05 08:00:00created_at stringThe date and time when payment terms were created. Format: ISO 8601.Example:2024-06-05 08:00:00due_in_days integerRemaining days until the payment is due. This field is returned when the value ofpayment_terms_typeisNET.Example:2id stringThe unique identifier (ID) that identifies this payment term.Example:6497210673894431747overdue booleanWhether the payment is overdue.true: overduefalse: not overdue
payment_schedulesobject[]
A set of schedules associated with the payment terms.issued_at stringPayment start time. Whenpayment_terms_typeisFIXEDorNET,issue_atindicates the save time of the draft order or the order itself. If the draft order is converted to an order, the order inherits the save time of the draft. Whenpayment_terms_typeisFULFILLMENTorRECEIPT, it refers to the payment start time. Format: ISO 8601.Example:2024-06-05 08:00:00payment_terms_name stringThe name of the payment terms template used to create the payment terms.Example:Due on receiptpayment_terms_type stringThe type of payment terms template used to create the payment terms. Valid values are:FIXED: Merchant specified dateFULFILLMENT: Fulfillment (Shipment) completion dateNET: Fixed condition dateRECEIPT: Billing sent dateUNKNOWN: Unknown type
subtotal_price_setobject
The final price after discounts, calculated as the total product price minus any marketing discounts and custom discounts. This field contains amounts displayed in both the buyer and store currencies.presentment_moneyobject
The final price information presented to the buyer.amount stringThe final price. The value is rounded to two decimal places.Example:1.00shop_moneyobject
The final price information recorded by the merchant.amount stringThe final price. The value is rounded to two decimal places.Example:8.00tags stringOrder tag.Example:Labeladjust_price_setobject
The amount discrepancy due to rounding adjustments in POS transactions, displayed in both the buyer currency and the store currency.presentment_moneyobject
The amount discrepancy information presented to the buyer.amount stringThe adjusted price amount. The value is rounded to two decimal places.Example:8.00shop_moneyobject
The amount discrepancy information recorded by the merchant.amount stringThe adjusted price amount. The value is rounded to two decimal places.Example:8.00customer_locale stringBuyer's language code + country or region code. The language code follows the ISO 639 standard. Country or region code follows the ISO 3166-1 standard.Example:enCAorder_status_url stringOrder status page URL.Example:https://shoptest.myshoplinestg.com/trade/thank_you?mainOrderMark=xxx&mainOrderSeq=200565776406008509shipping_linesobject[]
A list of shipping fee.title stringLogistics company name.Example:SF Internationalcode stringOnly local delivery shipping methods will return a value, displayed asLocal delivery.Example:Local deliverydiscount_allocationsobject[]
A list of discount details.amount stringThe discount amount in store currency. The value is rounded to two decimal places.Example:8.00amount_setobject
The discount amount, displayed in both the buyer currency and the store currency.presentment_moneyobject
The discount amount information presented to the buyer.amount stringThe discount amount. The value is rounded to two decimal places.Example:8.00shop_moneyobject
The discount amount information recorded by the merchant.amount stringThe discount amount. The value is rounded to two decimal places.Example:8.00discount_application_index integerThe position of the discount applied to the product within theorders.discount_applicationslist.Example:1discounted_price_setobject
The discount amount, displayed in both the buyer currency and the store currency.presentment_moneyobject
The discount amount information presented to the buyer.amount stringThe discount amount. The value is rounded to two decimal places.Example:8.00shop_moneyobject
The discount amount information recorded by the merchant.amount stringThe discount amount. The value is rounded to two decimal places.Example:8.00phone stringBuyer's phone.Example:13100000000price stringThe shipping fee amount in store currency. The value is rounded to two decimal places.Example:8.00shipping_strategy_name stringThe name of the shipping strategy. It has a corresponding value only when the shipping method isSHIPPINGorLOCAL_DELIVERY.discounted_price stringDiscount amount. The value is rounded to two decimal places, is displayed in the store currencyExample:8.00price_setobject
The shipping fee amount, displayed in both the buyer currency and the store currency.presentment_moneyobject
The shipping fee information presented to the buyer.amount stringThe shipping fee. The value is rounded to two decimal places.Example:8.00shop_moneyobject
The shipping fee information recorded by the merchant.amount stringThe shipping fee. The value is rounded to two decimal places.Example:8.00requested_fulfillment_service_id stringTransportation service code.shipping_price stringThe original shipping fee in store currency, excluding the amount after discount. The value is rounded to two decimal places.Example:8.00shipping_price_setobject
The original shipping fee, excluding the amount after discount, displayed in both the buyer currency and the store currency.presentment_moneyobject
The shipping fee information presented to the buyer.amount stringThe shipping fee. The value is rounded to two decimal places.Example:8.00shop_moneyobject
The shipping fee information recorded by the merchant.amount stringThe shipping fee. The value is rounded to two decimal places.Example:1.00source stringLogistics carrier type. Valid values are:Shipper: Shipper logisticsOneship: Oneship logisticsApi: logistics carriers added via open API capabilitiesnull: system logistics or custom logistics
tax_linesobject[]
A list of logistics tax information.price stringTax in store currency. The value is rounded to two decimal places.Example:8.00price_setobject
The tax amount, displayed in both the buyer currency and the store currency.shop_moneyobject
The tax amount information recorded by the merchant.amount stringThe tax amount. The value is rounded to two decimal places.Example:8.00presentment_moneyobject
The tax amount information presented to the buyer.amount stringThe tax amount. The value is rounded to two decimal places.Example:8.00rate doubleThe tax rate as a decimal value, rounded to four decimal places. For example, a 2% tax rate is represented as0.0200. This field value is for display only.title stringThe title for the tax description, for display only.Example:Tax namesource_identifier stringThe marketing referral code carried by the store link through which the customer accesses the store. The field value is extracted from the URL parameterref,resource, orr. For example, if the customer visits the URLmyshopline.com/products/slide?ref=22dd9dctg, then the value of this field is22dd9dctg.source_name stringIndicates the category of the app that initiated this API. Valid values are:sales_plugin_of: The distribution app in the marketing systemmember_plugin_referral: The referral app in the membership system
API Explorer
Debugger
Examples
Was this article helpful to you?