Update an order

patch
/orders/{id}

Update an order by ID

id
string
required

Order ID

as-store-id
string

The identifier of your store. It is not the store ID generated by AfterShip.

note
string

An optional note that a shop owner can attach to the order.

<= 5000 characters
source_updated_at
string

The date and time when the product was last modified. ISO 8601.

customer
Customer
Example:
{"source_id":"5127837778090","first_name":"teddy","last_name":"chan","emails":["[email protected]"],"locale":"en-US","phones":["+8613265883816"]}
source_id
string

A unique identifier for the customer.

<= 32 characters
first_name
string
required

The customer's first name.

<= 256 characters
last_name
string

The customer's last name.

<= 256 characters
emails
array[string]
required

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
shipping_address
Address
Example:
{"source_id":"1","description":"My Home Address","company":"aftership","first_name":"teddy","last_name":"chan","email":"[email protected]","address_line_1":"address2","address_line_2":"1233","address_line_3":null,"city":"HongKong","state":"","country_region":"HKG","postal_code":"12323","phone":{"country_code":"86","number":"13265883816"},"type":null,"tax_number":null}
description
string

The name or description of this address.

<= 256 characters
company
string

The company of the person associated with this address.

<= 256 characters
first_name
string
required

The customer’s first name.

<= 256 characters
last_name
string

The customer’s last name.

<= 256 characters
email
string

The unique email address of the customer.

<= 254 characters
address_line_1
string
required

The customer's mailing address.

<= 256 characters
address_line_2
string

An additional field for the customer's mailing address.

<= 256 characters
address_line_3
string

An additional field for the customer's mailing address.

<= 256 characters
city
string
required

The customer’s city, town, or village.

<= 256 characters
state
string
required

The customer’s region name. Typically a province, a state, or a prefecture.

<= 256 characters
country_region
string
required

The customer's country.

<= 3 characters
postal_code
string

The customer’s postal code, also known as zip, postcode, Eircode, etc.

<= 256 characters
phone
string

The customer’s phone number at this address.

<= 256 characters
type
string

The type of address (Eg: My home address, My office address).

Allowed values:
bussinessresidential
tax_number
string

Tax number for the address.

<= 256 characters
source_id
string

A unique identifier for the address.

<= 32 characters
billing_address
Address
Example:
{"source_id":"1","description":"My Home Address","company":"aftership","first_name":"teddy","last_name":"chan","email":"[email protected]","address_line_1":"address2","address_line_2":"1233","address_line_3":null,"city":"HongKong","state":"","country_region":"HKG","postal_code":"12323","phone":{"country_code":"86","number":"13265883816"},"type":null,"tax_number":null}
tags
array[string]

Tags attached to the order, formatted as a string of comma-separated values.

<= 100 items
Auth
:
Parameters
:
:
Body
preparing...