Each element should be less than 32 characters. Count of the elements should be less than 50. Every source_id should be used as an independent query param, as the following url example shows: /orders?source_ids[]=5247009653041&source_ids[]=5081836323059

limit

integer

The maximum number of results to show on a page. Default is 10.

>= 1<= 50

page

integer

Current page of the collection. Default is 1.

>= 1<= 200

sort

string

Sort the results list by the given value. Default is '-source_created_at' .

Allowed values:

-source_created_at+source_created_at-source_updated_at+source_updated_at

Example:

-source_created_at

Headers

as-store-id

string

required

The unique store identifier is generated by AfterShip. You can obtain this id by making a GET /stores call to get existing stores or a POST /stores to create a new store.

Responses

200 Body

Meta

The Meta model holds the metadata of the API response, including relevant error details for debugging purposes.Show all...

Example:

{"code":20000,"type":"OK","message":"The request was successfully processed by AfterShip."}

code

number

required

Error code in integer format. For detailed information, please refer to the Request Error introduction page.

Default:

20000

Example:

20000

type

string

required

Response type string for the reference. For detailed information, please refer to the Request Error introduction page.

>= 1 characters

Example:

message

string

required

Human-readable response message. For detailed information, please refer to the Request Error introduction page.

>= 1 characters

Example:

The request was successfully processed by AfterShip.

errors

array[Error]

Error detail object. Each error object contains a "path" key and an "info" key. The "path" is the JSON path of the request object to indicate the error location. The "info" is a human-readable description of the error.Show all...

data

object

orders

array[Order]

The Order model represents a customer's order object of your store. It includes details such as the order ID of your store, customer information, products, quantities, pricing, order status, and so on. This model is essential for managing and tracking orders through the API.Show all...

>= 0 items<= 50 items

pagination

Pagination

The Pagination holds the information for the pagination when the response contains multiple objects.

Example:

{"page":1,"limit":10,"has_next_page":false}

parameter_string

string

A string that includes the request parameters.

Example:

limit=10&page=1

Auth

Parameters

Response Example

{
  "meta": {
    "code": 20000,
    "type": "OK",
    "message": "The request was successfully processed by AfterShip."
  },
  "data": {
    "orders": [
      {
        "id": "0ecb8ff7efa84d7d8f763ed7b89851c8",
        "source_id": "5187092316403",
        "store": {
          "id": "0ecb8ff7efa84d7d8f763ed7b21851d1"
        },
        "name": "#1086",
        "number": "1086",
        "currency": "HKD",
        "status": "open",
        "financial_status": "unpaid",
        "fulfillment_status": "unfulfilled",
        "order_total": "97",
        "shipping_total": "5",
        "tax_total": "10",
        "discount_total": "1",
        "subtotal": "90",
        "items": [
          {
            "source_id": "13097711141107",
            "sku": "SKU001",
            "quantity": 1,
            "unit_weight": {
              "unit": "kg",
              "value": 10
            },
            "unit_price": {
              "currency": "USD",
              "amount": "10"
            },
            "product_title": "Power Mobile Phone",
            "product_variant_title": "Power Mobile Phone Pro",
            "discount": "10",
            "tax": "10",
            "fulfillable_quantity": 1,
            "source_product_id": "8021450916083",
            "source_variant_id": "43768285298931",
            "hs_code": "554521",
            "origin_country_region": "USA",
            "image_urls": [
              "https://www.example.com/product/phone/image.jpg"
            ],
            "product_tags": [
              "mobile-phone"
            ],
            "product_categories": [
              "mobile-phone"
            ],
            "returnable_quantity": 1
          }
        ],
        "note": "Created by AfterShip",
        "source_created_at": "2021-04-15T20:02:09Z",
        "source_updated_at": "2021-04-16T20:02:09Z",
        "created_at": "2021-04-15T20:02:09Z",
        "updated_at": "2021-04-16T20:02:09Z",
        "customer": {
          "source_id": "5127837778090",
          "first_name": "John",
          "last_name": "Doe",
          "emails": [
            "[email protected]"
          ],
          "locale": "en-US",
          "phones": [
            "+11234567890"
          ]
        },
        "shipping_address": {
          "type": "business",
          "street_1": "1234 Elm Street",
          "street_2": "Apt 5",
          "street_3": "",
          "city": "New York",
          "state": "NY",
          "postal_code": "10001",
          "country_region": "USA",
          "company": "My Company",
          "first_name": "John",
          "last_name": "Doe",
          "email": "[email protected]",
          "phone": "+11234567890"
        },
        "billing_address": {
          "type": "business",
          "street_1": "1234 Elm Street",
          "street_2": "Apt 5",
          "street_3": "",
          "city": "New York",
          "state": "NY",
          "postal_code": "10001",
          "country_region": "USA",
          "company": "My Company",
          "first_name": "John",
          "last_name": "Doe",
          "email": "[email protected]",
          "phone": "+11234567890"
        },
        "tags": [
          "mobile-phone"
        ],
        "shipping_method": "standard shipping",
        "delivery_method": "shipping",
        "pickup_location": {
          "location_id": "e9ec84ff351e45e089a7b75ae497e1ae",
          "address": {
            "type": "business",
            "street_1": "1234 Elm Street",
            "street_2": "Apt 5",
            "street_3": "",
            "city": "New York",
            "state": "NY",
            "postal_code": "10001",
            "country_region": "USA",
            "company": "My Company",
            "first_name": "John",
            "last_name": "Doe",
            "email": "[email protected]",
            "phone": "+11234567890",
            "coordinate": {
              "latitude": 43,
              "longitude": -75
            }
          },
          "opening_hours": {
            "sunday": {
              "open": true,
              "from": "10:30",
              "to": "20:30"
            },
            "monday": {
              "open": true,
              "from": "10:30",
              "to": "20:30"
            },
            "tuesday": {
              "open": true,
              "from": "10:30",
              "to": "20:30"
            },
            "wednesday": {
              "open": true,
              "from": "10:30",
              "to": "20:30"
            },
            "thursday": {
              "open": true,
              "from": "10:30",
              "to": "20:30"
            },
            "friday": {
              "open": true,
              "from": "10:30",
              "to": "20:30"
            },
            "saturday": {
              "open": true,
              "from": "10:30",
              "to": "20:30"
            }
          }
        },
        "pickup_info": {
          "instructions": "Shop open from Mon to Fri",
          "estimated_ready_for_pickup_at": {
            "min": "2021-04-15T20:02:09Z",
            "max": "2021-04-15T20:02:09Z"
          },
          "pickup_deadline_at": "2021-04-15T20:02:09Z"
        }
      }
    ],
    "pagination": {
      "page": 0,
      "limit": 0,
      "has_next_page": true
    },
    "parameter_string": "limit=10&page=1"
  }
}

Get orders

Request

Query Parameters

Headers

Responses

200

Body