Query specify customer order

Requires read_customers access scope.
For more info, refer to:
access permission.
GET https://{handle}.myshopline.com/admin/openapi/v20260301/customers/:id/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 .
Path Parameters
  • id string required
    Customer id
    Example: 2002697754
Query Parameters
  • fields string
    The fields to be queried, separated by commas, do not pass all field information, currently all fields are returned
    Example: id
  • limit integer
    Query of query quantity , default 50 , can not exceed 100
    Example: 10
  • page_info string
    The unique identifier for pagination queries, used to locate a specific page.
    This parameter value is obtained from the link value in the response header of this API after you have queried the pagination information.
    For example, if the link value you obtained is <https://{handle}.myshopline.com/admin/openapi/{version}/customers/:id/orders.json?limit=1&page_info=eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9>; rel="next" , the value of page_info is eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9 . For more information on how to use pagination, refer to Paging Mechanism.
    Example: eyJxdWVyeVBhcmFtU3RyaW5nIjoie1wic2l6ZVwiOjEsXCJzb3J0XCI6W1widWlkOmRlc2NcIl0sXCJzdG9yZUlkXCI6XCIxNjM5NjQwNTgxMzQ2XCIsXCJ1aWRcIjpcIjBcIixcImNyZWF0ZVRpbWVcIjpcIjw9MTY0OTg1NTYwMDAwMFwiLFwidXBkYXRlVGltZVwiOlwiXCJ9Iiwic2luY2VJZExpc3QiOlsiNDIwMTY4MDE5NSJdLCJwYWdlIjoyLCJzaXplIjoxLCJpbml0U29ydCI6WyJ1aWQ6ZGVzYyJdLCJzb3J0IjpbInVpZDpkZXNjIl0sImRpcmVjdGlvbiI6Im5leHQifQ
  • since_id string
    The starting position of the order number ID of the data to be queried
    Example: 21050224312121887324667162
  • status string required
    Order status , open- processing , cancelled- cancelled , any-contains any state , contains filed
    Example: any
Request Headers
  • Content-Type string required
    The field must be set to the fixed value application/json; charset=utf-8.
  • Authorization string required
    The access token for the API resource. Refer to App authorization to obtain the access token, and then pass the obtained token in the Bearer format.
    Example:
    Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw
Status Codes
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 obtain page_info from 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
  • listobject[]
    Order information list
  • adjust_price string
    Adjust the amount
    Example: 34
  • browser_ip string
    Client IP
    Example: 157.119.232.35
  • buyer_note string
    Buyer messaging
    Example: is good
  • phone string
    Telephone number
    Example: (555)555-5555
  • service string
    Shipping method type, pickUp means pick up in store.
    Example: pickUp
  • presentment_currency string
    Buy side currency, same as sell side currency
    Example: USD
  • updated_at string
    Order update time, (see IOS8601 for the format)
    Example: 2012-05-01T14:22:25-04:00
  • adjust_price_setobject
    Adjust the amount
  • presentment_moneyobject
    Currency information
  • currency_code string
    Currency information
    Example: CNY
  • amount string
    Amount, Precision 2
    Example: 45
  • shop_moneyobject
    Sell side amount
  • amount string
    Amount, Precision 2
    Example: 45
  • currency_code string
    Currency information
    Example: CNY
  • total_discounts string
    Total discount, marketing discount + artificial discount
    Example: 34
  • customer_locale string
    Buyer country, language code + country name abbreviation
    Example: enCN
  • refundsobject[]
    Refund list
  • created_at string
    Refund form creation time (see IOS8601 for the format)
    Example: 2021-08-16T08:27:57+00:00
  • refund_line_itemsobject[]
    Refund Details
  • line_itemobject
    Description
  • variant_id string
    Product SKU serial number
    Example: 23424235235
  • gift_card boolean
    Wei or not for gift cards
  • name string
    SKU title, same as title
    Example: good
  • requires_shipping boolean
    Shipping or not
    Example: true
  • fulfillment_service string
    Logistics company name
    Example: EMS
  • price string
    Commodity price, precision 2
    Example: 23
  • sku string
    Product code, barCode
    Example: 32424324
  • attribute string
    Product attributes : name-attribute value multiple comma " , " division like : color-red , size-x
    Example: red
  • product_id string
    SPU serial number
    Example: 42342352435325
  • image_url string
    Product image
    Example: https://dsfaf.com
  • title string
    title
    Example: the air
  • fulfillment_status string
    The shipping status of the product, shipping status, fulfilled-shipped; partial-partially shipped; null-unshipped;
    Example: fully filled
  • quantity integer
    Quantity of items in the order
    Example: 2
  • propertiesobject[]
    Product customization information
  • name string
    Custom attribute name
    Example: size
  • type string
    Attribute type, text-character, the display format is name: value; picture-picture, the display type is name: get the rendered thumbnail through URLs; link-hyperlink, the display type is name: value, supports clicking on the link to jump to urls First
    Example: picture
  • urls array
    URL resource list
    Example: ["https://asdfasfsaf.com"]
  • value string
    Custom attribute values
    Example: big size
  • fulfillable_quantity integer
    Available quantity
    Example: 3
  • tags string
    Product tag ( multiple comma separated )
  • tax_linesobject[]
    Tax information
  • price_setobject
    Multi-currency information of tax
  • presentment_moneyobject
    Buy side currency
  • currency_code string
    Currency
    Example: CNY
  • amount string
    Amount
    Example: 4234
  • shop_moneyobject
    Sell side currency
  • amount string
    Amount
    Example: 3546
  • currency_code string
    Currency
    Example: CNy
  • rate double
    Tax rate
    Example: 4
  • title string
    Tax name
    Example: googs
  • price string
    Tax, precision 2
    Example: 8
  • taxable boolean
    Tax or not？
    Example: true
  • vendor string
    Supplier
    Example: alibaba
  • id string
    The ID of the product snapshot table, generated by the system, uniquely confirms a product with the order number
    Example: 432434325
  • variant_title string
    Commodity attribute value, multiple divided by " / ", such as: "155 / red / large"
    Example: red
  • grams double
    Weight ( grams )
    Example: 33
  • subtotal double
    Total refund amount, precision 2
    Example: 23
  • total_tax double
    Tax amount of refunded goods, precision 2
    Example: 33
  • subtotal_setobject
    Total refund amount, multi-currency information, same on seller and buyer side
  • presentment_moneyobject
    Buy side currency
  • amount string
    Amount, Precision 2
    Example: 34
  • currency_code string
    Currency
    Example: CNY
  • shop_moneyobject
    Sell side amount information
  • amount string
    Amount, Precision 2
    Example: 544
  • currency_code string
    Currency
    Example: CNY
  • total_tax_setobject
    Total tax amount, multi-currency information
  • presentment_moneyobject
    Buy side currency
  • amount string
    Amount, Precision 2
    Example: 43
  • currency_code string
    Currency
    Example: CNY
  • shop_moneyobject
    Sell side amount information
  • amount string
    Amount, Precision 2
    Example: 243
  • currency_code string
    Currency
    Example: CNY
  • id string
    Refund order number
    Example: 42323524353
  • line_item_id string
    The ID of the product snapshot table, generated by the system, uniquely confirms a product with the order number
    Example: 2343535325
  • quantity integer
    Quantity, quantity of goods
    Example: 2
  • restock_type string
    Inventory return type, no_restock-not returned, cancel-cancelled, return-returned only not returned
    Example: cancel
  • transactionsobject[]
    Refund transaction information
  • amount string
    Refund amount , accuracy 2
    Example: 34
  • created_at string
    Creation time
    Example: 2021-08-16T08:27:57+00:00
  • currency string
    Currency
    Example: CNy
  • id string
    Refund ID
    Example: 123424252435
  • kind string
    Transaction type (authorization, capture, sale, void, refund)
    Example: sale
  • order_id string
    Order number
    Example: 234535235325
  • status string
    Handling status, pending, failure, success, and error
    Example: success
  • processed_at string
    Update time
    Example: 2021-08-16T08:27:57+00:00
  • user_id string
    User ID
    Example: 22032949
  • user_id string
    User ID
    Example: 22034092
  • note string
    Refund Notes
    Example: none
  • order_id string
    Order number
    Example: 54325235235442354
  • processed_at string
    Update time (see IOS8601 for the format)
    Example: 2021-08-16T08:27:57+00:00
  • order_adjustmentsobject[]
    Adjust the order information
  • kind string
    Adjust single type
    Example: none
  • tax_amount_setobject
    Adjust the single tax amount
  • presentment_moneyobject
    Store adjustment single display tax amount
  • amount double
    Store adjustment single display tax amount
    Example: 43
  • currency_code string
    Store adjustment single display tax amount
    Example: CNY
  • shop_moneyobject
    Store adjusts the amount of single tax
  • currency_code string
    Store adjustment of single tax currency
    Example: CNy
  • amount double
    Store adjusts the amount of single tax
    Example: 434
  • amount_setobject
    Adjust the single amount
  • shop_moneyobject
    Store adjustment amount
  • amount double
    Store adjustment amount
    Example: 34
  • currency_code string
    Store adjust the amount currency
    Example: CNY
  • presentment_moneyobject
    Store adjustment of display
  • amount double
    Store adjustment of display
    Example: 44
  • currency_code string
    Store adjustment of display amount currency
    Example: CNY
  • id string
    Refund adjustment single id
    Example: werwqrwqrqwr
  • order_id string
    Order number
    Example: 423343254235
  • tax_amount string
    Adjust the single tax amount
    Example: 44
  • reason string
    Adjust the reason
    Example: no reason
  • refund_id string
    Refund single id
    Example: 43254325325325
  • amount string
    Adjust the single amount
    Example: 34
  • id string
    Refund ID
    Example: 2342353425235
  • current_total_discounts_setobject
    Discount total multi-currency information , no multi-currency , so the currency and amount of the transaction house are the same
  • presentment_moneyobject
    Currency information
  • amount string
    Amount, Precision 2
    Example: 43
  • currency_code string
    Currency information
    Example: CNY
  • shop_moneyobject
    Sell side amount
  • amount string
    Amount, Precision 2
    Example: 565435
  • currency_code string
    Currency information
    Example: CNY
  • current_total_tax_setobject
    Multi-currency information of the sum of taxes, the currency and amount of buyers and sellers are the same
  • presentment_moneyobject
    Currency information
  • amount string
    Amount, Precision 2
    Example: 453424
  • currency_code string
    Currency information
    Example: CNY
  • shop_moneyobject
    Sell side amount
  • currency_code string
    Currency information
    Example: CNY
  • amount string
    Amount, Precision 2
    Example: 4353
  • cancel_reason string
    Seller's reason for cancellation
    Example: no reason
  • total_weight double
    Total product weight ( g )
    Example: 45
  • subtotal_price string
    Total product price after discount, total product price - marketing discount - artificial discount
    Example: 43
  • currency string
    Transaction currency
    Example: CNY
  • total_outstanding string
    Sum of unpaid amount, precision 2
    Example: 3422
  • taxes_included boolean
    Does the total include tax?
  • fulfillmentsobject[]
    Package information
  • order_id string
    Order number
    Example: 543543654654657
  • tracking_number string
    Third party tracking number
    Example: 43324523532535
  • tracking_url string
    Logistics company URL
    Example: https//ems.hsh.com
  • updated_at string
    Update time
    Example: 2021-08-16T08:27:57+00:00
  • id string
    Package number
    Example: 4323245325235435
  • shipment_status string
    Package tracking
    Example: sended
  • status string
    Logistics delivery status, success-shipped; cancelled-cancelled;
    Example: success
  • tracking_company string
    Logistics company name
    Example: EMS
  • created_at string
    Creation time
    Example: 2021-08-16T08:27:57+00:00
  • line_itemsobject[]
    Product list
  • attribute string
    Product attributes : name-attribute value multiple comma " , " division like : color-red , size-x
    Example: big
  • image_url string
    Product image
    Example: https://imageaaa.com
  • title string
    Product title
    Example: good
  • variant_id string
    Product SKU serial number
    Example: dsfsfsdffsdf
  • fulfillment_status string
    The shipping status of the product, shipping status, fulfilled-shipped; partial-partially shipped; null-unshipped;
    Example: fulfilled
  • variant_title string
    Commodity attribute value, multiple divided by " / ", such as: "155 / red / large"
    Example: red
  • fulfillment_service string
    Logistics company name
    Example: EMS
  • grams double
    Weight ( grams )
    Example: 23
  • price string
    Commodity price, precision 2
    Example: 43
  • id string
    The ID of the product snapshot table, generated by the system, uniquely confirms a product with the order number
    Example: 4322424124214
  • fulfillable_quantity integer
    Available quantity
    Example: 3
  • name string
    SKU title, same as title
    Example: the air
  • taxable boolean
    Tax or not？
  • vendor string
    Supplier
    Example: alibaba
  • quantity integer
    Quantity of items in the order
    Example: 2
  • requires_shipping boolean
    Shipping or not
    Example: true
  • tax_linesobject[]
    Tax information
  • rate double
    Tax rate
  • title string
    Tax name
    Example: gateway
  • price string
    Tax, precision 2
    Example: 33
  • price_setobject
    Multi-currency information of tax
  • presentment_moneyobject
    Currency information
  • amount string
    Amount
    Example: 34
  • currency_code string
    Currency
    Example: CNY
  • shop_moneyobject
    Sell side amount information
  • currency_code string
    Currency
    Example: CNY
  • amount string
    Amount
    Example: 533
  • sku string
    Product code, barCode
    Example: e2erwrwrwr
  • gift_card boolean
    Gift card information
  • product_id string
    SPU serial number
    Example: 23424242143214
  • line_itemsobject[]
    Order product snapshot information
  • fulfillment_status string
    The shipping status of the product, shipping status, fulfilled-shipped; partial-partially shipped; null-unshipped;
    Example: fulfilled
  • grams double
    Weight ( grams )
    Example: 324
  • id string
    The ID of the product snapshot table, generated by the system, uniquely confirms a product with the order number
    Example: 4324234535
  • tax_linesobject[]
    Tax information
  • price string
    Tax, precision 2
    Example: 0
  • price_setobject
    Multi-currency information of tax
  • shop_moneyobject
    Sell side currency
  • currency_code string
    Currency
    Example: CNY
  • amount string
    Amount
    Example: 34534
  • presentment_moneyobject
    Sell side currency
  • amount string
    Amount
    Example: 43
  • currency_code string
    Currency
    Example: CNY
  • rate double
    Tax rate
  • title string
    Tax name
    Example: goods
  • attribute string
    Product attributes : name-attribute value multiple comma " , " division like : color-red , size-x
    Example: red
  • fulfillment_service string
    Logistics company name
    Example: EMS
  • sku string
    Product code, barCode
    Example: 4324325325345
  • taxable boolean
    Tax or not？
  • propertiesobject[]
    Product customization information
  • urls array
    URL resource list
    Example: ["https://dsadasd.com"]
  • value string
    Custom attribute values
    Example: big
  • name string
    Custom attribute name
    Example: size
  • type string
    Attribute type, text-character, the display format is name: value; picture-picture, the display type is name: get the rendered thumbnail through URLs; link-hyperlink, the display type is name: value, supports clicking on the link to jump to urls First
    Example: picture
  • variant_title string
    Commodity attribute value, multiple divided by " / ", such as: "155 / red / large"
    Example: red
  • vendor string
    Supplier
    Example: alibaba
  • fulfillable_quantity integer
    Available quantity
    Example: 2
  • image_url string
    Product image
    Example: https://aaa.com
  • name string
    SKU title, same as title
    Example: good
  • variant_id string
    Product SKU serial number
    Example: 432424324
  • quantity integer
    Quantity of items in the order
    Example: 3
  • product_id string
    SPU serial number
    Example: 24344523543254325
  • title string
    Product title
    Example: the air
  • price string
    Commodity price, precision 2
    Example: 32
  • tags string
    Product tag ( multiple comma separated )
    Example: good
  • requires_shipping boolean
    Shipping or not
  • gift_card boolean
    Wei or not for gift cards
  • user_id string
    Buyer ID
    Example: 2002697754
  • tags string
    Order tag
    Example: return
  • note string
    Merchant notes
    Example: good customer
  • hidden_order boolean
    Is filing order , true = filed order , false= does not file order
    Example: true
  • payment_gateway_names array
    List of payment methods, list of payment methods used for this order, SLpayments, Paypal (PayPal payment), Oceanpay (Oceanpayment), TwoCheckout, AsiaBill, Stripe, Pacypay, WorldPay, COD (cash on delivery), CUSTOM (custom), adjustPay (funding adjustment), Xendit (xendit credit card), XenditOther
    Example: ["Paypal"]
  • total_shipping_price_setobject
    Order shipping sum, multi-currency information
  • presentment_moneyobject
    Buyer side amount information
  • amount string
    Amount, Precision 2
    Example: 234
  • currency_code string
    Currency
    Example: CNY
  • shop_moneyobject
    Sell side amount information
  • amount string
    Amount, Precision 2
    Example: 2342
  • currency_code string
    Currency
    Example: CNY
  • subtotal_price_setobject
    Multi-currency information of total product price after discount
  • presentment_moneyobject
    Buyer side amount information
  • amount string
    Amount, Precision 2
    Example: 34
  • currency_code string
    Currency
    Example: CNY
  • shop_moneyobject
    Store side amount information
  • amount string
    Amount, Precision 2
    Example: 23
  • currency_code string
    Currency
    Example: CNY
  • shipping_linesobject[]
    Logistics information
  • price string
    Logistics freight, precision 2
    Example: 2
  • price_setobject
    Logistics shipping multi-currency information
  • shop_moneyobject
    Store side amount information
  • amount string
    Amount, Precision 2
    Example: 34
  • currency_code string
    Currency
    Example: CNY
  • presentment_moneyobject
    Buyer side amount information
  • amount string
    Amount, Precision 2
    Example: 34
  • currency_code string
    Currency
    Example: CNY
  • requested_fulfillment_service_id string
    Transportation service code
    Example: 324242424
  • tax_linesobject[]
    Logistics tax list
  • price string
    Tax
    Example: 44
  • price_setobject
    Multi-currency information of tax
  • presentment_moneyobject
    Buyer side amount information
  • amount string
    Amount, Precision 2
    Example: 54
  • currency_code string
    Currency
    Example: CNY
  • shop_moneyobject
    Store side amount information
  • amount string
    Amount, Precision 2
    Example: 65
  • currency_code string
    Currency
    Example: CNY
  • rate double
    Tax rate
  • title string
    Tax name
    Example: goods
  • title string
    Logistics name
    Example: EMS
  • code string
    Logistics number
    Example: e2342542354325
  • discounted_price string
    Discount amount, precision 2
    Example: 2
  • phone string
    Phone
    Example: 00861897657463
  • created_at string
    Order creation time (see IOS8601 for the format)
    Example: 2021-08-16T08:27:57+00:00
  • total_tax string
    Sum of taxes, precision 2, commodity tax + shipping tax
    Example: 234
  • note_attributesobject[]
    Merchant note log, date content
  • create_time string
    Remark creation time (see IOS8601 for the format)
    Example: 2021-08-16T08:27:57+00:00
  • name string
    Remark source (seller ID)
    Example: none
  • value string
    Notes
    Example: hello
  • status string
    Order status, open-processing, canceled-cancelled, any-including any status, including archived;
    Example: open
  • order_from string
    Order source
    Example: admin
  • fulfillment_status string
    Shipping status, unshipped-unshipped; partial-partially shipped; shipped-shipped;
    Example: unshipped
  • shipping_addressobject
    Shipping address
  • city string
    City
    Example: guangzhoushi
  • address2 string
    Detailed address 2, optional
    Example: department2
  • province string
    Province
    Example: guangdong
  • country string
    Country
    Example: china
  • district_code string
    District code
    Example: 440372
  • zip string
    Postal code
    Example: 423443
  • country_code string
    Country code
    Example: CN
  • delivery_store_code string
    Store ID
    Example: 341e32
  • last_name string
    Last name
    Example: James
  • province_code string
    Province code
    Example: 440000
  • first_name string
    First name
    Example: Bob
  • phone string
    Phone number
    Example: 008615098987462
  • delivery_store_name string
    Store name
    Example: hello
  • name string
    Full name
    Example: Bob James
  • city_code string
    City code
    Example: 440100
  • address1 string
    Detailed address 1
    Example: department1
  • district string
    District
    Example: panyuqu
  • company string
    Company name
    Example: Joy
  • id string
    System order number
    Example: 21050224312121887324667162
  • token_infoobject
    Shopping cart or settlement page token information associated with order
  • cart_token string
    Shopping cart token
    Example: 423e23e2323e
  • checkout_token string
    Settlement page token
    Example: e3e232e32e
  • tax_type string
    Types of tax ID
    Example: 1
  • name string
    Custom order number
    Example: 1037
  • current_total_price string
    Current order total, value logic: total product - total discount + shipping + tax
    Example: 60.0
  • locationsobject[]
    Pick-up location address
  • country_code string
    Country code
    Example: CN
  • district string
    District/County
    Example: panyu
  • location_seq string
    Address serial number
    Example: 234423424234
  • town string
    Country / town
    Example: dashi
  • address string
    Detailed address 1
    Example: department1
  • address_add string
    Detailed address 2
    Example: department2
  • name string
    Address name
    Example: wandaguangchang
  • city string
    City
    Example: guangzhoushi
  • province string
    Province
    Example: guangdong
  • zip_code string
    Postal code
    Example: 430302
  • phone string
    Phone
    Example: 008615089765743
  • country string
    Country
    Example: china
  • total_line_items_price string
    Sum of original prices of goods, precision 2
    Example: 3432532532
  • order_status_url string
    Order status page URL
    Example: https//hhdghs.com
  • current_subtotal_price string
    Sum of current products, total price of products * quantity
    Example: 78.0
  • tax_linesobject[]
    Tax information
  • price string
    Tax
    Example: 34
  • price_setobject
    Multi-currency information of tax
  • shop_moneyobject
    Sell side amount information
  • amount string
    Amount, Precision 2
    Example: 56
  • currency_code string
    Currency
    Example: CNY
  • presentment_moneyobject
    Buyer side amount information
  • amount string
    Amount, Precision 2
    Example: 45
  • currency_code string
    Currency
    Example: CNY
  • rate double
    Tax rate
    Example: 9
  • title string
    Tax name
    Example: goods
  • current_subtotal_price_setobject
    Multi-currency information of the current commodity sum, the buyer's and seller's currency and the amount are the same
  • presentment_moneyobject
    Currency information
  • currency_code string
    Currency information
    Example: CNY
  • amount string
    Amount, Precision 2
    Example: 43
  • shop_moneyobject
    Sell side amount
  • amount string
    Amount, Precision 2
    Example: 543
  • currency_code string
    Currency information
    Example: CNY
  • client_detailsobject
    Client Details
  • session_hash string
    sessionId
    Example: 42343243253543
  • user_agent string
    Client Proxy
    Example: 157.119.232.35
  • browser_ip string
    Ip address
    Example: 157.119.232.35
  • total_line_items_price_setobject
    Sum of original price of goods, multi-currency information
  • shop_moneyobject
    Sell side amount information
  • currency_code string
    Currency
    Example: CNY
  • amount string
    Amount, Precision 2
    Example: 12
  • presentment_moneyobject
    Buyer side amount information
  • amount string
    Amount, Precision 2
    Example: 44
  • currency_code string
    Currency
    Example: CNY
  • tax_number string
    TIN
    Example: 12342421412
  • cancelled_at string
    Order cancellation time ( end ) ( format see IOS8601 )
    Example: 2012-05-01T14:22:25-04:00
  • discount_codesobject[]
    Promo code information
  • amount string
    Discount amount, precision 2
    Example: 32
  • code string
    Promo code
    Example: 43563
  • type string
    Type of discount, reduced amount; discount; free shipping; fixed price; the lowest price item is free; package price; the Nth item is discounted;
    Example: 1
  • current_total_price_setobject
    Multi-currency information of the current order total, the buyer's and seller‘s currency and the amount are the same
  • presentment_moneyobject
    Currency information
  • amount string
    Amount, Precision 2
    Example: 443
  • currency_code string
    Currency information
    Example: CNY
  • shop_moneyobject
    Sell side amount
  • amount string
    Amount, Precision 2
    Example: 644
  • currency_code string
    Currency information
    Example: CNY
  • current_total_discounts string
    Sum of discounts, precision 2, marketing offers + artificial discounts
    Example: 0.0
  • billing_addressobject
    Billing address information
  • company string
    Company name
    Example: Joy
  • first_name string
    First name
    Example: Bob
  • last_name string
    Last name
    Example: James
  • name string
    Full name
    Example: Bob James
  • phone string
    Phone number
    Example: 008613987675643
  • zip string
    Postal code
    Example: 539002
  • country_code string
    Country code
    Example: CN
  • address2 string
    Detailed address 2, optional
    Example: department2
  • city_code string
    City code
    Example: 414000
  • country string
    Country
    Example: china
  • province string
    Province
    Example: guangdong
  • province_code string
    Province code
    Example: 440000
  • address1 string
    Detailed address 1
    Example: department1
  • city string
    City
    Example: guangzhoushi
  • current_total_tax string
    Total tax, product tax + shipping tax
    Example: 0.0
  • email string
    Buyer mailbox
    Example: hok@shoplineapp.com
  • financial_status string
    Payment status , un pad , authorized , pending , partially_paid , pad , partially_refunded , refunded
    Example: paid
  • customerobject
    Buyer information
  • addressesobject
    Buyer address information
  • country_code string
    Country code
    Example: CN
  • last_name string
    Last name
    Example: James
  • name string
    Full name
    Example: Bob James
  • phone string
    Phone
    Example: 008613877763452
  • address1 string
    Detailed address 1
    Example: department1
  • address2 string
    Detailed address 2, optional
    Example: department2
  • province string
    Province
    Example: guangdong
  • province_code string
    Province code
    Example: 440000
  • country string
    Country
    Example: china
  • first_name string
    First name
    Example: Bob
  • city string
    City
    Example: guangzhoushi
  • zip string
    Postal code
    Example: 523424
  • city_code string
    City code
    Example: 440113
  • area_code string
    Phone area code
    Example: 0086
  • id string
    User ID
    Example: 223234928
  • phone string
    User mobile phone number
    Example: 008615087675643
  • currency string
    Currency
    Example: CNY
  • email string
    User mailbox
    Example: 267347264@163.com
  • last_name string
    Last name
    Example: James
  • updated_at string
    Buyer update time
    Example: 2021-08-16T08:27:57+00:00
  • created_at string
    Buyer creation time
    Example: 2021-08-16T08:27:57+00:00
  • first_name string
    First name
    Example: Bob
  • total_discounts_setobject
    Multi-currency information of discount total
  • presentment_moneyobject
    Buyer side discount information
  • amount string
    Amount, Precision 2
    Example: 45
  • currency_code string
    Currency
    Example: CNY
  • shop_moneyobject
    Seller side discount information
  • amount string
    Amount, Precision 2
    Example: 4353245
  • currency_code string
    Currency
    Example: CNY
  • total_tax_setobject
    Total tax , multi-currency information
  • presentment_moneyobject
    Buyer side amount information
  • amount string
    Amount, Precision 2
    Example: 67
  • currency_code string
    Currency
    Example: CNY
  • shop_moneyobject
    Sell side amount information
  • currency_code string
    Currency
    Example: CNY
  • amount string
    Amount, Precision 2
    Example: 75
  • payment_detailsobject[]
    Payment slip information
  • pay_amount double
    Payment amount
    Example: 45
  • pay_channel_deal_id string
    External channel payment serial number
    Example: 2344325435235235
  • pay_seq string
    Payment slip number
    Example: 56464645466
  • pay_status string
    Payment slip status , unpaid- not paid ; pending- paying ; risking- wind control ; paid-paid ; paid_overtime- payment failed ; paid_failed- payment failure ;
    Example: paid
  • payment_channel string
    Payment channels
    Example: online
  • payment_merchant_id string
    Payment merchants ID
    Example: 4234242e32e
  • payment_merchant_order_id string
    Payment merchant order number
    Example: 42323432424
  • create_time string
    Payment slip creation time
    Example: 2021-08-16T08:27:57+00:00
  • total_tip_received string
    Tip, precision 2
    Example: 234
API Explorer
https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301

ParamOptions

— path required
— query required
— header required
— query
— query
— query
— query

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/customers/id/orders.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'
Examples
Query specify first 10 order id for users
Response
{
  "list": [
    {
      "id": "21054485723742024581438604"
    },
    {
      "id": "21054485773911604675007002"
    },
    {
      "id": "21054562249123682151450631"
    },
    {
      "id": "21054586782497473894518921"
    },
    {
      "id": "21054586794579250452648526"
    },
    {
      "id": "21054586810181222471890723"
    },
    {
      "id": "21054587223532901572056435"
    },
    {
      "id": "21054587498469361000661031"
    },
    {
      "id": "21055067816380286986546716"
    },
    {
      "id": "21055067904840674929322306"
    }
  ]
}
Was this article helpful to you?
SHOPLINE
SHOPLINE
SHOPLINE Enterprise
Legal
Privacy
Terms
Developer Agreement
LinkedInEmail
LinkedInEmail
© Copyright 2013-2025 SHOPLINE Limited.