跳到主要内容
版本:202201

查询订单列表

GET 

/openapi/2022-01/orders

分页返回订单列表,支持按状态、日期范围等条件筛选。

请求

Query参数

    ids string

    ID 列表。

    limit string

    Limit per page, maximum: 250

    默认值: 10
    page string

    Page number

    默认值: 1
    created_at_min string

    最早创建时间。

    created_at_max string

    最晚创建时间。

    updated_at_min string

    最早更新时间。

    updated_at_max string

    最晚更新时间。

    placed_at_min string

    最早下单时间。

    placed_at_max string

    最晚下单时间。

    status string

    按订单状态过滤。

    • opened: 待支付。
    • cancelled: 已取消。
    • placed: 进行中。
    • finished: 已完成。
    fulfillment_status string

    按订单物流状态过滤。

    • initialled: 初始。
    • waiting: 待发货。
    • partially_shipped: 部分发货。
    • shipped: 全部发货。
    • partially_finished: 部分收货。
    • finished: 全部收货。
    • cancelled: 已取消。
    • returning: 退货中。
    • partially_returned: 部分退货。
    • returned: 全部退货。
    financial_status string

    按支付状态过滤。

    • waiting: 待支付。
    • paying: 支付审核中。
    • authorized: 已授权。
    • partially_paid: 部分支付。
    • paid: 已支付。
    • cancelled: 已取消。
    • failed: 支付失败。
    • refunding: 退款中。
    • refund_failed: 退款失败。
    • refunded: 已全退。
    • partially_refunded: 部分退。
    recovery_status string

    召回状态。

    location_id string

    位置 ID。

    keyword string

    搜索关键词。

    keyword_scope_fields string

    关键词搜索范围字段。

    sort_by string

    排序字段。

    默认值: created_at
    sort_direction string

    排序方向。

    默认值: 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

    顾客 ID。

响应

200

数据结构
    orders object[]
  • Array [
  • idstring
    示例: 633130-00000007
    note
    numberstring
    示例: 00000007
    financial_statusstring
    示例: paid
    statusstring
    示例: placed
    cancel_reason
    payment_methodstring
    示例: bogus_gateway
    fulfillment_statusstring
    示例: waiting
    discount_codestring
    示例: HZV85Q4K
    discount_applicationsstring
    示例: [{"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
    示例:
    sales_platformstring
    示例: shoplazza
    landing_sitestring
    示例: https://test-shoplazza.stg.myshoplaza.com/checkout/633130-00000001?key=e281e6f81c335487dd91cf3df34a8e
    buyer_accepts_marketingboolean
    默认值: true
    示例: true
    currencystring
    示例: CNY
    total_pricestring
    示例: 109.90
    total_discountstring
    示例: 8.10
    total_taxstring
    示例: 0.00
    total_shippingstring
    示例: 37.00
    sub_totalstring
    示例: 81.00
    code_discount_totalstring
    示例: 8.10
    line_item_discount_totalstring
    示例: 0.00
    tagsstring
    示例: recovered
    created_atstring
    示例: 2024-04-19T09:51:30Z
    updated_atstring
    示例: 2024-04-19T09:54:02Z
    canceled_at
    customer_deleted_at
    deleted_at
    placed_atstring
    示例: 2024-04-19T09:54:02Z
    total_refund_pricestring
    示例: 0.00
    total_refund_taxstring
    示例: 0.00
    total_refund_discountstring
    示例: 0.00
    refund_status
    total_tip_receivedstring
    示例: 0.00
    browser_ipstring
    示例: 183.15.177.205
    sourcestring
    示例: https://test-shoplazza.stg.myshoplaza.com/checkout/633130-00000001?key=e281e6f81c335487dd91cf3df34a8e
    last_landing_urlstring
    示例:
    email_statusstring
    示例: send
    recovery_statusstring
    示例: success
    total_paidstring
    示例: 109.90
    source_name object
    datastring
    示例:
    created_atstring
    示例:
    last_referrer_show object
    datastring
    示例:
    created_atstring
    示例:
    shipping_line object
    namestring
    示例: test
    customer object
    idstring
    示例: f6de152d-ec40-4734-81e5-62db979da04e
    emailstring
    first_namestring
    示例: zhang
    last_namestring
    示例: senjun
    phonestring
    示例: +8615014471143
    created_atstring
    示例: 2024-04-17T08:43:37Z
    updated_atstring
    示例: 2024-04-19T09:51:54Z
    orders_countinteger
    默认值: 0
    示例: 2
    total_spentstring
    示例: 30.28
    shipping_address object
    first_namestring
    示例: test
    last_namestring
    示例: test
    address1string
    示例: 6 三聖街
    address2string
    示例: 1111
    phonestring
    示例: +8615014471143
    citystring
    示例: 北京
    zipstring
    示例: 100000
    provincestring
    示例: Beijing
    countrystring
    示例: China mainland
    companystring
    示例:
    latitude
    longitude
    namestring
    示例: test test
    country_codestring
    示例: CN
    province_codestring
    示例: CN-BJ
    phone_area_codestring
    示例: CN_86
    emailstring
    areastring
    示例:
    extra_info
    billing_address object
    first_namestring
    示例: test
    last_namestring
    示例: test
    address1string
    示例: 6 三聖街
    address2string
    示例: 1111
    citystring
    示例: 北京
    zipstring
    示例: 100000
    provincestring
    示例: Beijing
    countrystring
    示例: China mainland
    companystring
    示例:
    latitude
    longitude
    namestring
    示例: test test
    country_codestring
    示例: CN
    province_codestring
    示例: CN-BJ
    emailstring
    areastring
    示例:
    phonestring
    示例: +8615014471143
    payment_line object
    payment_channelstring
    示例: bogus
    payment_methodstring
    示例: bogus_gateway
    transaction_nostring
    示例: test_633130-00000007
    merchant_idstring
    示例:
    merchant_emailstring
    示例:
    payment_namestring
    示例: Onerway(Direct)
    payment_lines object[]
  • Array [
  • payment_channelstring
    示例: bogus
    payment_methodstring
    示例: bogus_gateway
    transaction_nostring
    示例: test_633130-00000007
    merchant_idstring
    示例:
    merchant_emailstring
    示例:
    paid_totalstring
    示例: 109.90
    payment_namestring
    示例: Onerway(Direct)
  • ]
  • line_items object[]
  • Array [
  • idstring
    示例: ed8af005-1f4e-42d1-859d-99b0fd420781
    product_idstring
    示例: a1a88be0-a1d4-47e4-a2f2-ba6e131cf447
    variant_idstring
    示例: a7175820-36b3-4fc6-9baf-51e3035242ba
    variant_titlestring
    示例: L-blue-T
    product_titlestring
    示例: shirt
    product_handlestring
    示例: shirt
    quantityinteger
    默认值: 0
    示例: 1
    notestring
    示例:
    fulfillment_statusstring
    示例: waiting
    skustring
    示例: T-M-L-blue-T-A001008
    weight_unitstring
    示例: kg
    vendorstring
    示例: shoplazza
    product_urlstring
    示例: /products/shirt
    compare_at_pricestring
    示例: 97.00
    imagestring
    示例: //cdn.shoplazza.com/ccf0794c594bad32a320eea0d6bfe40c.jpeg
    pricestring
    示例: 81.00
    totalstring
    示例: 81.00
    weightstring
    示例: 1.10
    properties object[]
  • Array [
  • namestring
    示例: size
    valuestring
    示例: L
  • ]
  • custom_properties
    refund_quantityinteger
    默认值: 0
    示例: 0
    refund_totalstring
    示例: 0.00
    base_pricestring
    示例: 0.00
    discount_applicationsstring
    示例: [{"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
    示例: 0.00
    tax_pricestring
    示例: 0.00
  • ]
  • fulfillments object[]
  • Array [
  • object
  • ]
  • gift_card_totalstring
    示例: 0.00
    shipping_tax_totalstring
    示例: 0.00
    product_tax_includedboolean
    默认值: true
    示例: true
    refer_infostring
    示例: {"$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
    示例: 0.00
    additional_prices object[]
  • Array [
  • namestring
    示例: test
    pricestring
    示例: 0.00
    fee_titlestring
    示例: xxx
  • ]
  • logistics_codestring
    示例:
    config object
    page_typestring
    示例: three_step
    requires_shippingboolean
    默认值: true
    示例: true
    checkout_business_typeinteger
    默认值: 0
    示例: 0
    product_tax_includedboolean
    默认值: true
    示例: true
    checkout_template_typeinteger
    默认值: 0
    示例: 0
    market_setting object
    primary_market_langstring
    示例: en-US
    market_langstring
    示例: en-US
    market_idstring
    示例: 370871064999238186
    market_currencystring
    示例: CNY
    market_currency_symbol object
    codestring
    示例: CNY
    valstring
    示例: ¥
    leftstring
    示例: ¥
    rightstring
    示例:
    market_base_idstring
    示例:
    market_base_currencystring
    示例: CNY
    market_base_currency_symbol object
    codestring
    示例: CNY
    valstring
    示例: ¥
    leftstring
    示例: ¥
    rightstring
    示例:
    primary_market_idstring
    示例: 311711862569844266
    primary_market_currencystring
    示例: USD
    primary_market_currency_symbol object
    codestring
    示例: USD
    valstring
    示例: $
    leftstring
    示例: $
    rightstring
    示例:
    market_price_setting object
    local_currency_enabledboolean
    默认值: true
    示例: false
    custom_rate_enabledboolean
    默认值: true
    示例: false
    custom_rateinteger
    默认值: 0
    示例: 0
    ratenumber
    默认值: 0
    示例: 7.237698
    back_ratenumber
    默认值: 0
    示例: 0.138165
    actual_ratenumber
    默认值: 0
    示例: 7.237698
    base_to_localinteger
    默认值: 0
    示例: 0
    local_to_baseinteger
    默认值: 0
    示例: 0
    adjustinteger
    默认值: 0
    示例: 10
    price_round_enabledboolean
    默认值: true
    示例: true
    market_countrystring
    示例: CN
    checkout_urlstring
    示例: /checkout/1179396-00000010?key=eca1d627f5a38ed33189e6172e2a60
    duty_totalstring
    示例: 0.00
  • ]
  • countinteger
    默认值: 0
    示例: 3
    next_tokenstring
    示例: Y3JlYXRlZF9hdCMyMDIzLTExLTA3VDEwOjA1OjA2LjExNTU5N1ojZGVzYyMxMTc5Mzk2LTAwMDAwMDAy