List post-sale orders

GET 
/openapi/2025-06/orders/post_sales

Retrieves a list of after-sales records (e.g., returns or exchanges) associated with orders.

Request

Query Parameters

cursor string

Cursor for pagination

page_size int32

A limit on the number of objects to return. (default is 20)

created_at_min string

Filter to include records created on or after this time (e.g., 2018-11-02T12:30:10Z)

created_at_max string

Filter to include records created on or before this time (e.g., 2018-11-02T12:30:10Z)

status string
Post-sale status:
• pending: pending
• processing: processing
• finished: completed

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object

orders object[]

List of orders

Array [

created_atstring

The date/time the after-sales record was created

credit_card_numberstring

The last few digits of the credit card used

currency_codestring

The currency code (e.g., "CNY", "USD")

customer_namestring

The customer’s name

discount_codestring

Discount code

financial_statusstring

Payment status of the order:

• waiting: pending payment
• paying: payment under review
• authorized: authorized
• partially_paid: partially paid
• paid: paid
• cancelled: cancelled
• failed: payment failed
• refunding: refund in progress
• refund_failed: refund failed
• refunded: fully refunded
• partially_refunded: partially refunded

fulfillment_statusstring

Order fulfillment status:

• initialled: initial
• waiting: waiting to ship
• partially_shipped: partially shipped
• shipped: fully shipped
• partially_finished: partially received
• finished: fully received
• cancelled: cancelled
• returning: return in progress
• partially_returned: partially returned
• returned: fully returned

fulfillments object[]

List of fulfillments

Array [

tracking_numberstring

Tracking number

created_atstring

Time when the fulfillment was created (e.g., 2018-11-02T12:30:10Z)

tracking_companystring

Tracking company

]

idstring

This after-sales record ID

line_items object[]

A list of line items associated with this after-sales record

Array [

compare_at_pricestring

Original price before discount

fulfillment_statusstring

Line item fulfillment status:

• waiting: initial / waiting to ship
• shipped: fully shipped
• finished: fully received
• returning: return in progress
• returned: returned
• partially_shipped: partially shipped
• partially_finished: partially received
• partially_returned: partially returned

idstring

This line item ID

image object

Image

srcstring

Image source URL

widthint32

Width dimension

heightint32

Height dimension

altstring

Alt text for image

notestring

Any note associated with this line item

options object[]

Array of option objects, typically describing variant attributes (e.g., size)

Array [

namestring

Option name

valuestring

Option value

]

pricestring

Unit price for this item

product_handlestring

The handle/slug for the product

product_idstring

The ID of the product

product_tagsstring[]

Array of tags associated with this product

product_titlestring

The product title

propertiesstring

Any custom properties in string or JSON format

quantityint32

Number of units purchased (and reflected in the after-sales request)

refund_discountstring

Discount portion of the refund

refund_pricestring

Price portion of the refund

refund_quantityint32

Number of units refunded for this line item

refund_taxstring

Tax portion of the refund

refund_totalstring

Total refunded amount (including price, tax, discount) for this line item

requires_shippingboolean

Indicates if this item requires shipping

skustring

Stock Keeping Unit for the variant

spustring

Stock Product Unit or a general product code

taxableboolean

Indicates if the item is taxable

totalstring

Total cost for this line item (price * quantity)

variant_idstring

The variant’s unique ID

variant_titlestring

The title describing the variant attributes

vendorstring

The vendor or brand for this item

weightstring

The unit weight of this item

weight_unitstring

Unit of weight measurement (e.g., "kg", "lb")

vendor_urlstring

A URL pointing to the vendor site

oversold_quantityint32

Quantity sold beyond available inventory (if overselling is allowed)

main_currency_prices object

Main currency prices

compare_at_pricestring

The compare-at price in the main/store currency

pricestring

The unit price in the main currency

total_pricestring

The total price (main_currency_prices.price * quantity)

actual_ratestring

The actual exchange rate used for conversion

fulfillments object[]

List of fulfillments

Array [

tracking_numberstring

Tracking number

created_atstring

Time when the fulfillment was created (e.g., 2018-11-02T12:30:10Z)

tracking_companystring

Tracking company

]

]

numberstring

The post-sales document number (often the original order number plus a suffix)

order_numberstring

The original order number

order_totalstring

The total price of the original order

payment_methodstring

The payment method used for the original order

recipient_namestring

The name of the recipient in shipping details

sales_platformstring

The platform on which the sale took place (e.g., "shoplazza")

shipping_countrystring

The country of the shipping address

shipping_emailstring

The email used for shipping notifications

shipping_line object

Information about the shipping plan selected for the order

idstring

Shipping ID

namestring

Name

descstring

Description

delivery_methodint32

Delivery method

shipping_phonestring

The phone number for the shipping address

sourcestring

First visited page

source_namestring

First touchpoint

placed_atstring

The date/time the original order was placed

refund_amountstring

The total amount refunded for this after-sales request

post_sale_notestring

Any note regarding this after-sales request

last_referrer_showstring

Last touchpoint

last_landing_urlstring

Last visited page

payment_lines object[]

List of payment lines

Array [

idstring

Payment line ID

payment_namestring

The name of the payment channel for display purposes (e.g., PayPal, Credit Card)

payment_channelstring

The payment channel used for the transaction (e.g., PayPal, Stripe, Bank Transfer)

payment_methodstring

The specific method of payment used within the channel (e.g., Visa, MasterCard,online(e.g. paypal))

credit_card_numberstring

The last few digits of the credit card used

trans_channelstring

Transaction channel

trans_methodstring

Transaction method

transaction_nostring

The unique transaction number associated with this payment

merchant_emailstring

Merchant email address

]

main_currency_prices object

Main currency prices

compare_at_pricestring

The compare-at price in the main/store currency

pricestring

The unit price in the main currency

total_pricestring

The total price (main_currency_prices.price * quantity)

actual_ratestring

The actual exchange rate used for conversion

delivery_methodint32

Delivery method identifier

shipping_tax_totalstring

Total shipping tax for the original order

shipping_tax_typeint32

Type of shipping tax

all_tax_totalstring

The total tax on the order

shop_namestring

The shop name associated with the order

staff_contactstring

Contact info for any staff associated with this after-sales record

statusstring

Post-sale request status:

• pending: pending
• processing: processing
• finished: completed

]

cursorstring

Cursor for pagination

has_moreboolean

Whether there are more records

Example

{
  "code": "string",
  "message": "string",
  "data": {
    "orders": [
      {
        "created_at": "string",
        "credit_card_number": "string",
        "currency_code": "string",
        "customer_name": "string",
        "discount_code": "string",
        "financial_status": "string",
        "fulfillment_status": "string",
        "fulfillments": [
          {
            "tracking_number": "string",
            "created_at": "string",
            "tracking_company": "string"
          }
        ],
        "id": "string",
        "line_items": [
          {
            "compare_at_price": "string",
            "fulfillment_status": "string",
            "id": "string",
            "image": {
              "src": "string",
              "width": 0,
              "height": 0,
              "alt": "string"
            },
            "note": "string",
            "options": [
              {
                "name": "string",
                "value": "string"
              }
            ],
            "price": "string",
            "product_handle": "string",
            "product_id": "string",
            "product_tags": [
              "string"
            ],
            "product_title": "string",
            "properties": "string",
            "quantity": 0,
            "refund_discount": "string",
            "refund_price": "string",
            "refund_quantity": 0,
            "refund_tax": "string",
            "refund_total": "string",
            "requires_shipping": true,
            "sku": "string",
            "spu": "string",
            "taxable": true,
            "total": "string",
            "variant_id": "string",
            "variant_title": "string",
            "vendor": "string",
            "weight": "string",
            "weight_unit": "string",
            "vendor_url": "string",
            "oversold_quantity": 0,
            "main_currency_prices": {
              "compare_at_price": "string",
              "price": "string",
              "total_price": "string",
              "actual_rate": "string"
            },
            "fulfillments": [
              {
                "tracking_number": "string",
                "created_at": "string",
                "tracking_company": "string"
              }
            ]
          }
        ],
        "number": "string",
        "order_number": "string",
        "order_total": "string",
        "payment_method": "string",
        "recipient_name": "string",
        "sales_platform": "string",
        "shipping_country": "string",
        "shipping_email": "string",
        "shipping_line": {
          "id": "string",
          "name": "string",
          "desc": "string",
          "delivery_method": 0
        },
        "shipping_phone": "string",
        "source": "string",
        "source_name": "string",
        "placed_at": "string",
        "refund_amount": "string",
        "post_sale_note": "string",
        "last_referrer_show": "string",
        "last_landing_url": "string",
        "payment_lines": [
          {
            "id": "string",
            "payment_name": "string",
            "payment_channel": "string",
            "payment_method": "string",
            "credit_card_number": "string",
            "trans_channel": "string",
            "trans_method": "string",
            "transaction_no": "string",
            "merchant_email": "string"
          }
        ],
        "main_currency_prices": {
          "compare_at_price": "string",
          "price": "string",
          "total_price": "string",
          "actual_rate": "string"
        },
        "delivery_method": 0,
        "shipping_tax_total": "string",
        "shipping_tax_type": 0,
        "all_tax_total": "string",
        "shop_name": "string",
        "staff_contact": "string",
        "status": "string"
      }
    ],
    "cursor": "string",
    "has_more": true
  }
}