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.

A custom identifier for the fulfillment. If not provided, the system will generate a UUID. Must be unique within the store and immutable. You can use this ID to manage the resource in subsequent API calls.

<= 128 characters

Example:

my-custom-id-123

Match pattern:

^[a-zA-Z0-9_-]+$

order_id

string

required

The unique identifier of the order. This value must match the id of the order as returned by the GET /orders or GET /orders/{id} endpoints in the current API version.

Example:

960d25e570834e84b2a0fffd08fab7f9

delivery_method

string

required

Delivery method of the order. For BOPIS related feature, please specify pickup.Show all...

Allowed values:

pickupshipping

Example:

shipping

status

string

required

The status of the fulfillment. Depending of on the delivery_method, the allowed values are different.Show all...

Example:

pending

line_items

array[object]

required

The items which included in this fulifllment.

string

required

A unique identifier for the line item in your system. The value should be exist in one of the items in the corresponding order.Show all...

Example:

365756526

quantity

integer

required

The number of items in this fulfillment.

Example:

source_created_at

string<date-time>

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

Example:

2021-04-15T20:02:09Z

source_updated_at

string<date-time>

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

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. Note that you must provide either location_id or address, but not both.

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

object

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

required

The ID of the Location pre-created in AfterShip admin

Example:

a52eeb761d204f3cbae06fa93b452976

trackings

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

string

required

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

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

Auth

Parameters

Body

preparing...