AfterShip Shipping Common Scenario
This document will describe several common usage scenarios for AfterShip Shipping, provided for your reference.
Please be sure to reach out to the AfterShip support team or contact your customer success manager to activate your store ID for AfterShip Shipping usage.
Creating Shipping Label
The first step is to import your order into AfterShip system, you can import the your order with order endpoints.
Minimum Required Fields
| Field | Description | Sample |
|---|---|---|
| source_id | The unique identifier of the order. For most of the case it should be the same as the order ID of your system. | CM1011 |
| number | The order name | CM1011 |
| currency | The curreny of the order | USD |
| status | The status of the order | open |
| financial_status | The status of payments associated with the order | paid |
| fulfillment_status | The status of fulfillment associated with the order | unfulfilled |
| order_total | The total price of the order | 9.5 |
| items | Items of order | - |
| items.*.source_id | A unique identifier for the line item in your system | 9716591689898 |
| items.*.title | The title of the product variant | Mobile Phone Case |
| items.*.quantity | The number of items that have been purchased | 1 |
| items.*.fulfillable_quantity | Total items available to fulfill | 1 |
| items.*.origin_country_region | The origin country of this product | HKG |
| items.*.unit_price | fieldThe price of the item before discounts and taxes applies | 5 |
| items.*.unit_weight | The item's weight | - |
| items.*.unit_weight.unit | The weight unit | lb |
| items.*.unit_weight.value | The weight value | 10 |
| customer | Customer information object | - |
| customer.first_name | The customer's first name | John |
| customer.last_name | The customer's last name | Doe |
| customer.emails | The customer's email array | ["[email protected]"] |
| source_created_at | The date and time (ISO 8601 format) when an order was created | 2023-02-16T01:00:10Z |
| source_updated_at | The date and time (ISO 8601 format) when an order was updated. | 2023-02-16T01:00:10Z |
| shipping_address | Shipping address object | - |
| shipping_address.first_name | The customer’s first name | John |
| shipping_address.last_name | The customer’s last name | Doe |
| shipping_address.address_line_1 | The customer's mailing address | 28292 Daugherty Orchard |
| shipping_address.city | The customer’s city, town, or village | acramento |
| shipping_address.state | The customer’s region name. Typically a province, a state, or a prefecture | CA |
| shipping_address.country_region | The customer's country or region | USA |
| shipping_address.postal_code | The customer’s postal code, also known as zip, postcode, Eircode, etc | 94209 |
| shipping_address.email | The unique email address of the customer | [email protected] |
| shipping_address.type | The type of address | business |
Here is a sample request for creating orders, along with the payload required to use AfterShip Shipping:
After successfully importing the orders as detailed in the previous example, you can proceed to manage the imported orders and create labels in the AfterShip Shipping. Please be aware that some carriers might demand additional fields to generate labels. If you encounter issues creating labels for imported orders, do not hesitate to contact us for support.