Skip to main content
Version: 202201

Order List

GET 
/openapi/2022-01/orders

Returns a paginated list of orders, with optional filters for status, date range, and other criteria.

Request​

Query Parameters

    ids string

    Order's IDs, please use comma as separator, for example: 183211-00000005,183211-00000006

    limit string

    Limit per page, maximum: 250

    Default value: 10
    page string

    Page number

    Default value: 1
    created_at_min string

    Filter orders created at or after date, for example: 2016-01-18T23:41:00Z

    created_at_max string

    Filter orders created at or before date, for example: 2016-01-18T23:41:00Z

    updated_at_min string

    Filter orders last updated at or after date, for example: 2016-01-18T23:41:00Z

    updated_at_max string

    Filter orders last updated at or before date, for example: 2016-01-18T23:41:00Z

    placed_at_min string

    Filter orders placed at or after date, for example: 2016-01-18T23:41:00Z

    placed_at_max string

    Filter orders placed at or before date, for example: 2016-01-18T23:41:00Z

    status string

    Filter orders by status: opened, placed, finished, cancelled

    fulfillment_status string

    Filter orders by fulfillment status: initialled, waiting, partially_shipped, shipped, partially_finished, finished, cancelled, returning, returned, partially_returned

    financial_status string

    Filter orders by financial status: waiting, paying, paid, cancelled, failed, refunding, refund_failed, refunded, partially_refunded

    recovery_status string

    Filter orders by recovery status: waiting, sending, recalling, failed, success

    location_id string

    If the current store is associated with a physical outlet, then by passing the location ID through it , you can retrieve the list of offline orders specific to that outlet. If no location_id is provided, it will query all orders for the current store, including both online and offline orders

    keyword string

    Search keyword, takes effect when keyword_scope_fields has a value.

    keyword_scope_fields string

    Attribute range of keyword action, optional: name, number, tag_list, id, sku, spu, product_tags, product_title, credit_card_number, browser_ip, source, source_name, shipping_email, shipping_phone, tracking_number, shipping_line_name, line_item_vendor, discount_code, shipping_address_extra_info, transaction_id, last_landing_url, last_referrer_show, country. eg: name,shipping_phone

    sort_by string

    you can sort the result of order list by created_at or placed_at or updated_at

    Default value: created_at
    sort_direction string

    Sorting method, which value only desc or asc , "desc" for descending order, "asc" for ascending order.

    Default value: desc
    page_token string

    Page cursor, listing the data after the cursor. When both page_token and page exist, the page_token is preferred. This parameter is obtained from the next_token of the response.
    Note: With page_token, the count in the response represents the number of orders that were responded to for this request, not the number of eligible orders

    customer_id string

    Filter orders by customer‘s id

Responses​

200

Schema
    orders object[]
  • Array [
    • idstring
    Example: 633130-00000007
    note
    numberstring
    Example: 00000007
    financial_statusstring
    Example: paid
    statusstring
    Example: placed
    cancel_reason
    payment_methodstring
    Example: bogus_gateway
    fulfillment_statusstring
    Example: waiting
    discount_codestring
    Example: HZV85Q4K
    discount_applicationsstring
    Example: [{"type":"discount_code","subtype":"discount_code","title":"test","code":"HZV85Q4K","discount_amount":8.1,"message":"The HZV85Q4K has been applied","discount_message":"1.11914036755885642000","status":"success","discount_id":"eedfd5d8-0fbd-4ec6-9055-a43ea68dbec8","value_type":"percentage","target_type":"line_item","apply_method":"","target_selection":"all","discount_type":"percentage","entitled_product_list":[],"properties":"","discount_text":"Discount Code","is_free_gift":false}]
    customer_notestring
    Example:
    sales_platformstring
    Example: shoplazza
    landing_sitestring
    Example: https://test-shoplazza.stg.myshoplaza.com/checkout/633130-00000001?key=e281e6f81c335487dd91cf3df34a8e
    buyer_accepts_marketingboolean
    Default value: true
    Example: true
    currencystring
    Example: CNY
    total_pricestring
    Example: 109.90
    total_discountstring
    Example: 8.10
    total_taxstring
    Example: 0.00
    total_shippingstring
    Example: 37.00
    sub_totalstring
    Example: 81.00
    code_discount_totalstring
    Example: 8.10
    line_item_discount_totalstring
    Example: 0.00
    tagsstring
    Example: recovered
    created_atstring
    Example: 2024-04-19T09:51:30Z
    updated_atstring
    Example: 2024-04-19T09:54:02Z
    canceled_at
    customer_deleted_at
    deleted_at
    placed_atstring
    Example: 2024-04-19T09:54:02Z
    total_refund_pricestring
    Example: 0.00
    total_refund_taxstring
    Example: 0.00
    total_refund_discountstring
    Example: 0.00
    refund_status
    total_tip_receivedstring
    Example: 0.00
    browser_ipstring
    Example: 183.15.177.205
    sourcestring
    Example: https://test-shoplazza.stg.myshoplaza.com/checkout/633130-00000001?key=e281e6f81c335487dd91cf3df34a8e
    last_landing_urlstring
    Example:
    email_statusstring
    Example: send
    recovery_statusstring
    Example: success
    total_paidstring
    Example: 109.90
    source_name object
    datastring
    Example:
    created_atstring
    Example:
    last_referrer_show object
    datastring
    Example:
    created_atstring
    Example:
    shipping_line object
    namestring
    Example: test
    customer object
    idstring
    Example: f6de152d-ec40-4734-81e5-62db979da04e
    emailstring
    Example: [email protected]
    first_namestring
    Example: zhang
    last_namestring
    Example: senjun
    phonestring
    Example: +8615014471143
    created_atstring
    Example: 2024-04-17T08:43:37Z
    updated_atstring
    Example: 2024-04-19T09:51:54Z
    orders_countinteger
    Default value: 0
    Example: 2
    total_spentstring
    Example: 30.28
    shipping_address object
    first_namestring
    Example: test
    last_namestring
    Example: test
    address1string
    Example: 6 三聖街
    address2string
    Example: 1111
    phonestring
    Example: +8615014471143
    citystring
    Example: 北京
    zipstring
    Example: 100000
    provincestring
    Example: Beijing
    countrystring
    Example: China mainland
    companystring
    Example:
    latitude
    longitude
    namestring
    Example: test test
    country_codestring
    Example: CN
    province_codestring
    Example: CN-BJ
    phone_area_codestring
    Example: CN_86
    emailstring
    Example: [email protected]
    areastring
    Example:
    extra_info
    billing_address object
    first_namestring
    Example: test
    last_namestring
    Example: test
    address1string
    Example: 6 三聖街
    address2string
    Example: 1111
    citystring
    Example: 北京
    zipstring
    Example: 100000
    provincestring
    Example: Beijing
    countrystring
    Example: China mainland
    companystring
    Example:
    latitude
    longitude
    namestring
    Example: test test
    country_codestring
    Example: CN
    province_codestring
    Example: CN-BJ
    emailstring
    Example: [email protected]
    areastring
    Example:
    phonestring
    Example: +8615014471143
    payment_line object
    payment_channelstring
    Example: bogus
    payment_methodstring
    Example: bogus_gateway
    transaction_nostring
    Example: test_633130-00000007
    merchant_idstring
    Example:
    merchant_emailstring
    Example:
    payment_namestring
    Example: Onerway(Direct)
    payment_lines object[]
  • Array [
    • payment_channelstring
    Example: bogus
    payment_methodstring
    Example: bogus_gateway
    transaction_nostring
    Example: test_633130-00000007
    merchant_idstring
    Example:
    merchant_emailstring
    Example:
    paid_totalstring
    Example: 109.90
    payment_namestring
    Example: Onerway(Direct)
  • ]
    • line_items object[]
  • Array [
    • idstring
    Example: ed8af005-1f4e-42d1-859d-99b0fd420781
    product_idstring
    Example: a1a88be0-a1d4-47e4-a2f2-ba6e131cf447
    variant_idstring
    Example: a7175820-36b3-4fc6-9baf-51e3035242ba
    variant_titlestring
    Example: L-blue-T
    product_titlestring
    Example: shirt
    product_handlestring
    Example: shirt
    quantityinteger
    Default value: 0
    Example: 1
    notestring
    Example:
    fulfillment_statusstring
    Example: waiting
    skustring
    Example: T-M-L-blue-T-A001008
    weight_unitstring
    Example: kg
    vendorstring
    Example: shoplazza
    product_urlstring
    Example: /products/shirt
    compare_at_pricestring
    Example: 97.00
    imagestring
    Example: //cdn.shoplazza.com/ccf0794c594bad32a320eea0d6bfe40c.jpeg
    pricestring
    Example: 81.00
    totalstring
    Example: 81.00
    weightstring
    Example: 1.10
    properties object[]
  • Array [
    • namestring
    Example: size
    valuestring
    Example: L
  • ]
    • custom_properties
    refund_quantityinteger
    Default value: 0
    Example: 0
    refund_totalstring
    Example: 0.00
    base_pricestring
    Example: 0.00
    discount_applicationsstring
    Example: [{"type":"discount_code","subtype":"discount_code","discount_id":"eedfd5d8-0fbd-4ec6-9055-a43ea68dbec8","code":"HZV85Q4K","title":"test","value":"10","discount_type":"percentage","value_type":"percentage","allocation_method":"","target_selection":"all","target_type":"line_item","total_discount_amount":"8.1","discount_amount":"8.1","is_free_gift":false,"discount_quantity":1,"is_need_split":false,"discount_text":"Discount Code"}]
    duty_pricestring
    Example: 0.00
    tax_pricestring
    Example: 0.00
  • ]
    • fulfillments object[]
  • Array [
    • object
  • ]
    • gift_card_totalstring
    Example: 0.00
    shipping_tax_totalstring
    Example: 0.00
    product_tax_includedboolean
    Default value: true
    Example: true
    refer_infostring
    Example: {"$latest_referrer":"https://myaccount.stg.shoplazza.com/","$latest_referrer_host":"myaccount.stg.shoplazza.com","$latest_search_keyword":"未取到值","$latest_traffic_source_type":"引荐流量","address_check":true,"client_id":"1703040491710183","country":"CN","customer_session":"e198c29a-70bb-4f9d-9d43-b1ab12b557fb","domain":"test-shoplazza.stg.myshoplaza.com","fbc":"","fbp":"fb.1.1701051195560.2038310036","inventory_deduction":"order_created","ip":"183.15.177.205","session_id":"1713520243158272","source":"buy_now","user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36"}
    additional_totalstring
    Example: 0.00
    additional_prices object[]
  • Array [
    • namestring
    Example: test
    pricestring
    Example: 0.00
    fee_titlestring
    Example: xxx
  • ]
    • logistics_codestring
    Example:
    config object
    page_typestring
    Example: three_step
    requires_shippingboolean
    Default value: true
    Example: true
    checkout_business_typeinteger
    Default value: 0
    Example: 0
    product_tax_includedboolean
    Default value: true
    Example: true
    checkout_template_typeinteger
    Default value: 0
    Example: 0
    market_setting object
    primary_market_langstring
    Example: en-US
    market_langstring
    Example: en-US
    market_idstring
    Example: 370871064999238186
    market_currencystring
    Example: CNY
    market_currency_symbol object
    codestring
    Example: CNY
    valstring
    Example: ¥
    leftstring
    Example: ¥
    rightstring
    Example:
    market_base_idstring
    Example:
    market_base_currencystring
    Example: CNY
    market_base_currency_symbol object
    codestring
    Example: CNY
    valstring
    Example: ¥
    leftstring
    Example: ¥
    rightstring
    Example:
    primary_market_idstring
    Example: 311711862569844266
    primary_market_currencystring
    Example: USD
    primary_market_currency_symbol object
    codestring
    Example: USD
    valstring
    Example: $
    leftstring
    Example: $
    rightstring
    Example:
    market_price_setting object
    local_currency_enabledboolean
    Default value: true
    Example: false
    custom_rate_enabledboolean
    Default value: true
    Example: false
    custom_rateinteger
    Default value: 0
    Example: 0
    ratenumber
    Default value: 0
    Example: 7.237698
    back_ratenumber
    Default value: 0
    Example: 0.138165
    actual_ratenumber
    Default value: 0
    Example: 7.237698
    base_to_localinteger
    Default value: 0
    Example: 0
    local_to_baseinteger
    Default value: 0
    Example: 0
    adjustinteger
    Default value: 0
    Example: 10
    price_round_enabledboolean
    Default value: true
    Example: true
    market_countrystring
    Example: CN
    checkout_urlstring
    Example: /checkout/1179396-00000010?key=eca1d627f5a38ed33189e6172e2a60
    duty_totalstring
    Example: 0.00
  • ]
    • countinteger
    Default value: 0
    Example: 3
    next_tokenstring
    Example: Y3JlYXRlZF9hdCMyMDIzLTExLTA3VDEwOjA1OjA2LjExNTU5N1ojZGVzYyMxMTc5Mzk2LTAwMDAwMDAy