Update fulfillment by ID - AfterShip Commerce API

Request

Security: API Key

Path Parameters

id

string

required

The ID of the fulfillment.

Headers

as-store-id

string

required

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.

Body

source_updated_at

string

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

Example:

2021-04-15T20:02:09Z

pickup_info

Pickup

The pickup information of the fulfillment. It is recommended to include this field if the fulfillment's delivery method is pickup.

instructions

string

Instructions for the pickup process.Show all...

Example:

Shop open from Mon to Fri

estimated_ready_for_pickup_at

object

The expected date and time when the items in this fulfillment order will be ready for pickup.Show all...

pickup_deadline_at

string<date-time>

The latest time by which the pickup must be completed, formatted in ISO 8601.Show all...

Example:

2021-04-15T20:02:09Z

trackings

Represents shipment tracking information. This object supports two mutually exclusive usage patterns:Show all...

id

string

required

The unique identifier of a tracking resource previously created via the Tracking API.

ship_from_location

Location

The location information where the fulfillment shipped from. It is recommended to include this field if the fulfillment's delivery method is shipping.

location_id

string

The unique identifier for the location, as provided by AfterShip. You can manage and configure these locations here.

Example:

489b4bdec18d45d387752d63fb51ee1d

address

Address

The addess object of this location.

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"}

pickup_location

PickupLocation

The location information where the fulfillment is designated to be pickup from. Mandatory when the delivery method of the fulfillment is pickup.

location_id

string

The unique identifier for the address. You can find or create the corresponding value here.

Example:

e9ec84ff351e45e089a7b75ae497e1ae

address

AddressWithCoordinate

Address of the pickup location.

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","coordinate":{"latitude":43,"longitude":-75}}

opening_hours

OpeningHours

Opening hours information of the pickup location.