QUICKSTART
API Quick Start
Authentication
SignString
Versioning
Rate Limit
Body Envelope
Request Errors
Common Scenarios
Tracking
Sending Notifications
Estimated Delivery Date
Branded Tracking Page
Product Recommendation
Buy Online, Pickup In Store (BOPIS)
Next Couriers
Other Scenarios
Shipping
Returns
CHANGELOG
Changelog
Migration Guide
Past Changelog
REFERENCE
API Overview
Orders
Create an order
post
Get orders
get
Get order by ID
get
Update order by ID
patch
Products
Create a product
post
Get product by ID
get
Update product by ID
patch
Stores
Create a store
post
Get stores
get
Get store by ID
get
Update store by ID
patch
Fulfillments
Create a fulfillment
post
Get fulfillments
get
Get fulfillment by ID
get
Update fulfillment by ID
patch
Update fulfillment status
post
Ship fulfillment
post
Model
Envelope
Meta
v1
Error
v1
Pagination
v2
Primitive
Address
v1
AddressWithCoordinate
v1
Customer
v1
Location
v1
Money
v1
OpeningHours
v1
OpeningHourPeriod
v1
OrderItem
v1
Pickup
v1
PickupLocation
v1
Tracking
v1
Weight
v1
OrderCustomFields
v1
StatusTimestamps
v1
Resource
Order
v1
Product
v1
Fulfillment
v1
Store
v1
Support
Contact Support

Update order by ID

patch
/orders/{id}

Update an order by ID.

Request

Path Parameters

id
string
required

The ID of the order.

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.

Body

note
string

A note that the shop owner can optionally attach to the order.

<= 5000 characters
Example:
created by AfterShip
source_updated_at
string

The date and time, formatted in ISO 8601, indicating when the order was updated in your e-commerce system.

Example:
2021-04-16T20:02:09Z
customer
Customer

Customer information of the order.

Example:
{"source_id":"5127837778090","first_name":"John","last_name":"Doe","emails":["[email protected]"],"locale":"en-US","phones":["+13525554500"]}
source_id
string

A unique identifier for the customer of your store platform. It could be the customer ID of your system, or a URL friendly name or slug which is unique in your system.

<= 32 characters
Example:
5127837778090
first_name
string

The customer's first name.

<= 256 characters
Example:
John
last_name
string

The customer's last name.

<= 256 characters
Example:
Doe
emails
array[string]

The customer's email.

<= 100 items
phones
array[string]

The customer's phone number.

<= 100 items
locale
string

The language code of the customer, eg: en-US.

<= 128 characters
Example:
en-US
shipping_address
Address

Shipping address of the order.

Example:
{"type":"business","street_1":"1234 Elm Street","street_2":"Apt 5","street_3":null,"city":"New York","state":"NY","postal_code":"10001","country_region":"USA","company":"My Company","first_name":"John","last_name":"Doe","email":"[email protected]","phone":"+13525554500"}
type
string

The type of address.

Allowed values:
businessresidential
street_1
string
required

First line of the street address.

<= 256 characters
street_2
string or null

Second line of the street address.

<= 256 characters
street_3
string or null

Third line of the street address.

<= 256 characters
city
string

The location's city, town, or village.

<= 256 characters
state
string
required

The state or region of the location, such as a province, state, or prefecture.

<= 256 characters
postal_code
string

The postal code of the location (also known as zip code, postcode, Eircode, etc.).

<= 256 characters
country_region
string
required

The address country/region in ISO 3166-1 alpha-3 format. API will automatically convert input to uppercase.

Example:
USA
Match pattern:
^[A-Z]{3}$
company
string

The name of the company associated to the address.

<= 256 characters
first_name
string

The first name of the person associated to the address.

<= 256 characters
last_name
string

The last name of the person associated to the address.

<= 256 characters
email
string

The email address of the person associated to the address.

<= 256 characters
phone
string

The phone number of the person associated to the address.

<= 256 characters
billing_address
Address

Billing address of the order.

Example:
{"type":"business","street_1":"1234 Elm Street","street_2":"Apt 5","street_3":null,"city":"New York","state":"NY","postal_code":"10001","country_region":"USA","company":"My Company","first_name":"John","last_name":"Doe","email":"[email protected]","phone":"+13525554500"}
type
string

The type of address.

Allowed values:
businessresidential
street_1
string
required

First line of the street address.

<= 256 characters
street_2
string or null

Second line of the street address.

<= 256 characters
street_3
string or null

Third line of the street address.

<= 256 characters
city
string

The location's city, town, or village.

<= 256 characters
state
string
required

The state or region of the location, such as a province, state, or prefecture.

<= 256 characters
postal_code
string

The postal code of the location (also known as zip code, postcode, Eircode, etc.).

<= 256 characters
country_region
string
required

The address country/region in ISO 3166-1 alpha-3 format. API will automatically convert input to uppercase.

Example:
USA
Match pattern:
^[A-Z]{3}$
company
string

The name of the company associated to the address.

<= 256 characters
first_name
string

The first name of the person associated to the address.

<= 256 characters
last_name
string

The last name of the person associated to the address.

<= 256 characters
email
string

The email address of the person associated to the address.

<= 256 characters
phone
string

The phone number of the person associated to the address.

<= 256 characters
tags
array[string]

Tags attached to the order.

<= 100 items
status
string

The status of this order.

Allowed values:
openclosedcanceled
financial_status
string or null

The status of payments associated with the order.

Allowed values:
unpaidpartially_paidpaidpartially_refundedrefunded
fulfillment_status
string or null

The status of fulfillment associated with the order.

Allowed values:
unfulfilledpartially_fulfilledfulfilled
status_timestamps
StatusTimestamps

This object tracks the timestamps for each status change.Show all...

opened_at
string<date-time> or null

Datetime when the status was set to open.

canceled_at
string<date-time> or null

Datetime when the status was set to canceld.

closed_at
string<date-time> or null

Datetime when the status was set to closed.

custom_fields
OrderCustomFields

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...

Responses

200

Body

meta
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:
OK
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
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...

id
string

Unique identifier generated by AfterShip. Corresponds to fulfillment.order_id to link the order with its fulfillment details.

<= 32 characters
Example:
0ecb8ff7efa84d7d8f763ed7b89851c8
source_id
string
required

A unique identifier for the order in your system.

<= 32 characters
Example:
5187092316403
store
object

Indicate which store the order belongs to.

name
string

The order name. Default is the same value as number.

<= 256 characters
Example:
#1086
number
string
required

The order number.

<= 64 characters
Example:
1086
currency
string
required

Specifies the currency for the order, adhering to the ISO 4217 Currency Codes standard.

Example:
HKD
Match pattern:
^[A-Z]{3}$
status
string
required

The status of the order.

Allowed values:
openclosedcanceled
Example:
open
financial_status
string or null

The status of payments associated with the order.

Allowed values:
unpaidpartially_paidpaidpartially_refundedrefunded
Example:
unpaid
fulfillment_status
string

The status of fulfillment associated with the order.

Allowed values:
unfulfilledpartially_fulfilledfulfilled
Example:
unfulfilled
order_total
string
required

The total price of the order.

<= 100 characters
Example:
97
shipping_total
string

The total shipping fee applied to the price of the order.

<= 100 characters
Example:
5
tax_total
string

The sum of all the taxes applied to the order.

<= 100 characters
Example:
10
discount_total
string

The total discounts applied to the order. The value should be equal to the sum of all item discounts.

<= 100 characters
Example:
1
subtotal
string

The price of the order after discounts but before shipping and taxes.

<= 100 characters
Example:
90
items
array[OrderItem]

Purchased items of the order.

<= 100 items
note
string

A note that the shop owner can optionally attach to the order.

<= 5000 characters
Example:
Created by AfterShip
source_created_at
string

The date and time, formatted in ISO 8601, indicating when the order was created in your e-commerce system.

Example:
2021-04-15T20:02:09Z
source_updated_at
string

The date and time, formatted in ISO 8601, indicating when the order was updated in your e-commerce system.

Example:
2021-04-16T20:02:09Z
created_at
string

The date and time, formatted in ISO 8601, indicating when the order was created in AfterShip system.

Example:
2021-04-15T20:02:09Z
updated_at
string

The date and time, formatted in ISO 8601, indicating when the order was created in AfterShip system.

Example:
2021-04-16T20:02:09Z
customer
Customer

Customer information of the order.

Example:
{"source_id":"5127837778090","first_name":"John","last_name":"Doe","emails":["[email protected]"],"locale":"en-US","phones":["+13525554500"]}
shipping_address
Address

Shipping address of the order.

Example:
{"type":"business","street_1":"1234 Elm Street","street_2":"Apt 5","street_3":null,"city":"New York","state":"NY","postal_code":"10001","country_region":"USA","company":"My Company","first_name":"John","last_name":"Doe","email":"[email protected]","phone":"+13525554500"}
billing_address
Address

Billing address of the order.

Example:
{"type":"business","street_1":"1234 Elm Street","street_2":"Apt 5","street_3":null,"city":"New York","state":"NY","postal_code":"10001","country_region":"USA","company":"My Company","first_name":"John","last_name":"Doe","email":"[email protected]","phone":"+13525554500"}
tags
array[string]

Tags attached to the order.

<= 100 items
shipping_method
string

The name of the shipping method.

<= 256 characters
Example:
standard shipping
delivery_method
required

Delivery method of the order.Show all...

Allowed values:
shippingpickup
Example:
shipping
pickup_location
PickupLocation

To indicate the pickup location of the order when the delivery method of the order is pickup.Show all...

pickup_info
Pickup

To indicate the detailed pickup instruction of the order when the delivery method of the order is pickup.Show all...

status_timestamps
StatusTimestamps

This object tracks the timestamps for each status change.Show all...

custom_fields
OrderCustomFields

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...

Auth
:
Parameters
:
:
Body
{ "note": "created by AfterShip", "source_updated_at": "2021-04-16T20:02:09Z", "customer": { "source_id": "5127837778090", "first_name": "John", "last_name": "Doe", "emails": [ "[email protected]" ], "locale": "en-US", "phones": [ "+13525554500" ] }, "shipping_address": { "type": "business", "street_1": "1234 Elm Street", "street_2": "Apt 5", "street_3": null, "city": "New York", "state": "NY", "postal_code": "10001", "country_region": "USA", "company": "My Company", "first_name": "John", "last_name": "Doe", "email": "[email protected]", "phone": "+13525554500" }, "billing_address": { "type": "business", "street_1": "1234 Elm Street", "street_2": "Apt 5", "street_3": null, "city": "New York", "state": "NY", "postal_code": "10001", "country_region": "USA", "company": "My Company", "first_name": "John", "last_name": "Doe", "email": "[email protected]", "phone": "+13525554500" }, "tags": [ "this is a tag" ], "status": "open", "financial_status": "unpaid", "fulfillment_status": "unfulfilled", "status_timestamps": { "opened_at": "2019-08-24T14:15:22Z", "canceled_at": "2019-08-24T14:15:22Z", "closed_at": "2019-08-24T14:15:22Z" }, "custom_fields": { "property1": "string", "property2": "string" } }
Response Example
{
  "meta": {
    "code": 20000,
    "type": "OK",
    "message": "The request was successfully processed by Automizely."
  },
  "data": {
    "id": "9ce1a56071054b369b272713cc4a923e",
    "source_id": "3712367526058",
    "store": {
      "id": "0ecb8ff7efa84d7d8f763ed7b21851d1"
    },
    "number": "1002",
    "name": "#1002",
    "currency": "USD",
    "status": "closed",
    "delivery_method": "shipping",
    "financial_status": "paid",
    "fulfillment_status": "fulfilled",
    "shipping_method": "Free Shipping",
    "order_total": "9",
    "shipping_total": "0",
    "tax_total": "0",
    "discount_total": "1",
    "subtotal": "10",
    "items": [
      {
        "source_id": "9716591689898",
        "sku": "",
        "title": "iPhone pro max",
        "product_variant_title": "iPhone pro max Red",
        "quantity": 1,
        "unit_weight": {
          "unit": "g",
          "value": 1
        },
        "product_tags": [
          "Discounted"
        ],
        "product_categories": [
          "Pants"
        ],
        "image_urls": [
          "https://google.com/xxx.png"
        ],
        "unit_price": {
          "currency": "USD",
          "amount": "5"
        },
        "discount": "0.5",
        "tax": "0",
        "fulfillable_quantity": 0,
        "source_product_id": "6582419718314",
        "source_variant_id": "39468493078698",
        "hs_code": "1",
        "origin_country_region": "USA"
      }
    ],
    "note": "test",
    "created_at": "2021-04-15T20:02:09Z",
    "updated_at": "2021-04-26T13:42:19Z",
    "source_created_at": "2021-04-15T20:02:09Z",
    "source_updated_at": "2021-04-26T13:42:19Z",
    "customer": {
      "source_id": "5127837778090",
      "first_name": "John",
      "last_name": "Doe",
      "emails": [
        "[email protected]"
      ],
      "phones": [
        "+11234567890"
      ],
      "locale": "fr-FR"
    },
    "shipping_address": {
      "company": "AS",
      "first_name": "John",
      "last_name": "Doe",
      "email": "[email protected]",
      "street_1": "40 level",
      "street_2": "Das tower",
      "street_3": "",
      "city": "SHENZHEN",
      "state": "Alabama",
      "country_region": "CHN",
      "postal_code": "59390",
      "phone": "+11234567890",
      "type": "business"
    },
    "billing_address": {
      "company": "AS",
      "first_name": "John",
      "last_name": "Doe",
      "email": "[email protected]",
      "street_1": "40 level",
      "street_2": "Das tower",
      "street_3": "",
      "city": "SHENZHEN",
      "state": "Alabama",
      "country_region": "CHN",
      "postal_code": "59390",
      "phone": "+11234567890",
      "type": "business"
    },
    "tags": []
  }
}