Get an order by ID.
The ID of the order.
This value equals to store.id of Store Resource. You can obtain this id by making a GET /stores call to get existing stores or a POST /stores to create a new store.
The Meta model holds the metadata of the API response, including relevant error details for debugging purposes.Show all...
Error code in integer format. For detailed information, please refer to the Request Error introduction page.
Response type string for the reference. For detailed information, please refer to the Request Error introduction page.
Human-readable response message. For detailed information, please refer to the Request Error introduction page.
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...
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...
The unique identifier of the order. If a custom ID was provided in the request, that value is used; otherwise, a system-generated UUID is assigned. You can use this ID to manage this resource in related API calls.
Indicate which store the order belongs to.
The order name. Default is the same value as number.
The order number.
Specifies the currency for the order, adhering to the ISO 4217 Currency Codes standard.
The status of the order.
The status of payments associated with the order.
The fulfillment status associated with the order. If not provided, this value is determined automatically. Since fulfillment has not been created at the time of order creation, it defaults to unfulfilled.Show all...
The total price of the order.Final amount paid by the customer, including of charges.
Formula:
order_total = subtotal + shipping_total + tax_total
The total shipping fee applied to the price of the order.
The sum of all the taxes applied to the order.
The total discounts applied to the order. The value should be equal to the sum of all item discounts.
Total after discounts, excluding taxes and shipping.
Formula:
subtotal = sum of all items' price
1 item price = items.*.unit_price * items.*.quantity - items.*.discount
Purchased items of the order.
A note that the shop owner can optionally attach to the order.
The date and time, formatted in ISO 8601, indicating when the order was created in your e-commerce system.
The date and time, formatted in ISO 8601, indicating when the order was updated in your e-commerce system.
The date and time, formatted in ISO 8601, indicating when the order was created in AfterShip system.
The date and time, formatted in ISO 8601, indicating when the order was created in AfterShip system.
Customer information of the order.
Shipping address of the order.
Billing address of the order.
Tags attached to the order.
The name of the shipping method.
Delivery method of the order.Show all...
To indicate the pickup location of the order when the delivery method of the order is pickup.Show all...
To indicate the detailed pickup instruction of the order when the delivery method of the order is pickup.Show all...
This object tracks the timestamps for each status change.Show all...
Custom fields that accept an object with string field. In order to protect the privacy of your customers, do not include any personal data in custom fields.Show all...
{ "meta": { "code": 20000, "type": "OK", "message": "The request was successfully processed by AfterShip." }, "data": { "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": [ { "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", "product_id": "8021450916083", "product_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": { "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" } } }