Create a fulfillment

Create a fulfillment.

[url](../docs/common_scenarios/tracking/bopis.md)

Request

Security: API Key

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.

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 associated AfterShip order ID of this fulfillment.

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

object

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

required

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

Example:

a2a00a8bfefb423a98f456c95dfbfde5

ship_to_location

object

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

address

Address

required

The address object of ship to 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

array[Tracking]

The shipment information of the fulfillment.

tracking_number

string

required

Tracking number of a shipment.Show all...

Example:

RA123456789US

slug

string

Unique courier code. For a complete list of available courier codes, click here.

Example:

usps

service_type

string

The type of logistics service selected for this shipment, e.g. SeaFreight, SmartPost.

Example:

standard shipping

ship_date

string<date>

required

The ship date of the package in YYYY-MM-DD format.

Example:

2023-05-04

custom_fields

object

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

next_couriers

array[object]

Next Carrier Information. Utilize this field to manually specify the details for the next leg of a shipment if it involves multiple carriers. This is especially useful when the carrier handling the initial leg of the shipment does not provide information about the carrier for the subsequent leg.Show all...

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

Request

Headers

Body