**Version: 202601**

# List post-sale orders

**GET** `/openapi/2026-01/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)
- `page` int32

  Page number (1-based). Mutually exclusive with cursor
- `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 | Example**

**Schema**

- `code` string

  error code
- `message` string

  error message
- `data` object

  - `orders` object[]

    List of orders

    *   Array \[

    - `created_at` string

      The date/time the after-sales record was created
    - `credit_card_number` string

      The last few digits of the credit card used
    - `currency_code` string

      The currency code (e.g., "CNY", "USD")
    - `customer_name` string

      The customer’s name
    - `discount_code` string

      Discount code
    - `financial_status` string

      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_status` string

      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_number` string

        Tracking number
      - `created_at` string

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

        Tracking company
      *   \]
    - `id` string

      This after-sales record ID
    - `line_items` object[]

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

      *   Array \[

      - `compare_at_price` string

        Original price before discount
      - `fulfillment_status` string

        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
      - `id` string

        This line item ID
      - `image` object

        Image

        - `src` string

          The source URL of the image
        - `width` int32

          The width of the image in pixels
        - `height` int32

          The height of the image in pixels
        - `alt` string

          Alt text for the image
      - `note` string

        Any note associated with this line item
      - `options` object[]

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

        *   Array \[

        - `name` string

          Option name
        - `value` string

          Option value
        *   \]
      - `price` string

        Unit price for this item
      - `product_handle` string

        The handle/slug for the product
      - `product_id` string

        The ID of the product
      - `product_tags` string[]

        Array of tags associated with this product
      - `product_title` string

        The product title
      - `properties` string

        Any custom properties in string or JSON format
      - `quantity` int32

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

        Discount portion of the refund
      - `refund_price` string

        Price portion of the refund
      - `refund_quantity` int32

        Number of units refunded for this line item
      - `refund_tax` string

        Tax portion of the refund
      - `refund_total` string

        Total refunded amount (including price, tax, discount) for this line item
      - `requires_shipping` boolean

        Indicates if this item requires shipping
      - `sku` string

        Stock Keeping Unit for the variant
      - `spu` string

        Stock Product Unit or a general product code
      - `taxable` boolean

        Indicates if the item is taxable
      - `total` string

        Total cost for this line item (price \* quantity)
      - `variant_id` string

        The variant’s unique ID
      - `variant_title` string

        The title describing the variant attributes
      - `vendor` string

        The vendor or brand for this item
      - `weight` string

        The unit weight of this item
      - `weight_unit` string

        Unit of weight measurement (e.g., "kg", "lb")
      - `vendor_url` string

        A URL pointing to the vendor site
      - `oversold_quantity` int32

        Quantity sold beyond available inventory (if overselling is allowed)
      - `main_currency_prices` object

        Main currency prices

        - `compare_at_price` string

          The compare-at price in the main/store currency
        - `price` string

          The unit price in the main currency
        - `total_price` string

          The total price (main\_currency\_prices.price \* quantity)
        - `actual_rate` string

          The actual exchange rate used for conversion
      - `fulfillments` object[]

        List of fulfillments

        *   Array \[

        - `tracking_number` string

          Tracking number
        - `created_at` string

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

          Tracking company
        *   \]
      *   \]
    - `number` string

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

      The original order number
    - `order_total` string

      The total price of the original order
    - `payment_method` string

      The payment method used for the original order
    - `recipient_name` string

      The name of the recipient in shipping details
    - `sales_platform` string

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

      The country of the shipping address
    - `shipping_email` string

      The email used for shipping notifications
    - `shipping_line` object

      Information about the shipping plan selected for the order

      - `id` string

        Shipping ID
      - `name` string

        Name
      - `desc` string

        Description
      - `delivery_method` int32

        Delivery method
    - `shipping_phone` string

      The phone number for the shipping address
    - `source` string

      First visited page
    - `source_name` string

      First touchpoint
    - `placed_at` string

      The date/time the original order was placed
    - `refund_amount` string

      The total amount refunded for this after-sales request
    - `post_sale_note` string

      Any note regarding this after-sales request
    - `last_referrer_show` string

      Last touchpoint
    - `last_landing_url` string

      Last visited page
    - `payment_lines` object[]

      List of payment lines

      *   Array \[

      - `id` string

        Payment line ID
      - `payment_name` string

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

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

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

        The last few digits of the credit card used
      - `trans_channel` string

        Transaction channel
      - `trans_method` string

        Transaction method
      - `transaction_no` string

        The unique transaction number associated with this payment
      - `merchant_email` string

        Merchant email address
      *   \]
    - `main_currency_prices` object

      Main currency prices

      - `compare_at_price` string

        The compare-at price in the main/store currency
      - `price` string

        The unit price in the main currency
      - `total_price` string

        The total price (main\_currency\_prices.price \* quantity)
      - `actual_rate` string

        The actual exchange rate used for conversion
    - `delivery_method` int32

      Delivery method identifier
    - `shipping_tax_total` string

      Total shipping tax for the original order
    - `shipping_tax_type` int32

      Type of shipping tax
    - `all_tax_total` string

      The total tax on the order
    - `shop_name` string

      The shop name associated with the order
    - `staff_contact` string

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

      Post-sale request status:

      *   `pending`: pending
      *   `processing`: processing
      *   `finished`: completed
    *   \]
  - `cursor` string

    Cursor for pagination
  - `has_more` boolean

    Whether there are more records

```json
{
  "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
  }
}
```