The Fulfillment model encapsulates the details of processing and delivering orders in an eCommerce context. It includes information such as fulfillment status, shipment tracking, the items to be fulfilled, and so on.

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

string

required

The unique identifier of the fulfillment. If a custom ID was provided in the request, that value is used; otherwise, a system-generated UUID is assigned. You can use this ID to manage this resource in related API calls.

Example:

423562565

order_id

string

required

It should be the same as the order.id of the Order resource.

Example:

5187092316403

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:

processing

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:

13097711141107

product_id

string

required

The ID of the product in your system.Show all...

Example:

8021450916083

product_variant_id

string

required

The ID of the product variant in source system.Show all...

Example:

43768285298931

product_title

string

The title of the product.

Example:

Power Mobile Phone

product_variant_title

string

The title of the product variant.

Example:

Power Mobile Phone (While)

sku

string

required

The item's SKU (stock keeping unit).

Example:

SKU001

quantity

integer

required

The number of items in this fulfillment.

Example:

unit_price

Money

The price of the item before discounts and taxes have been applied.

Example:

{"currency":"USD","amount":"10"}

unit_weight

Weight

The item's weight.

Example:

{"unit":"kg","value":10}

image_urls

array[string]

Image urls of this product variant.

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-16T20:02:09Z

created_at

string<date-time>

required

The date and time (ISO 8601 format) when the fulfillment was created in AfterShip.

Example:

2021-04-15T20:02:09Z

updated_at

string<date-time>

required

The date and time (ISO 8601 format) when the fulfillment was updated in AfterShip.

Example:

2021-04-16T20:02:09Z

ship_from_location

Location

The location information where the fulfillment shipped from.

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":"john.doe@example.com","phone":"+13525554500"}

ship_to_location

Location

The location information where the fulfillment shipped to.

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:

pickup_location

PickupLocation

The location information where the fulfillment is designated to be pickup from.

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:

opening_hours

OpeningHours

Opening hours information of the pickup location.

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.

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

Example

preparing...