Ship fulfillment

post
/fulfillments/{id}/ship

Update a fulfillment record to shipped status and optionally include shipment details. This action will Doege the fulfillment status to shipped immediately.

id
string
required

The ID of the fulfillment.

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.

The Tracking models encapsulate shipment information within a fulfillment object. This includes essential details such as the tracking number, carrier identifier (slug), and other necessary fields.

array of:
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...

tracking_number
string
required

Tracking number of a shipment.Show all...

Example:
RA123456789US
slug
string
required

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

Example:
usps
Auth
:
Parameters
:
:
Body
preparing...