Create a Fulfillment Event

Manually create a new tracking event for a fulfillment. This is used to push custom shipment status updates — for example, when integrating with a carrier or 3PL that is not natively connected to the platform. Creating events can also trigger customer notification emails on supported platforms.

Note: Required fields and accepted status values vary by platform.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Available platforms

This endpoint is supported by 7 platforms. Click on each platform to see its specific required fields and accepted status values.

BigCommerce · Liverpool · Mercado Libre · Shopify · Tienda Nube · Yampi · Zoho Inventory

Same schema, platform-aware details. Required fields, accepted status values, and whether the event triggers a customer notification vary by platform.

Path Params
string
required

The unique identifier of the order.

string
required

The unique identifier of the fulfillment record.

Body Params

Fulfillment event data to create. Required fields vary by platform.

string

Shipment status for this event (e.g., in_transit, out_for_delivery, delivered, attempted_delivery, failure). Accepted values vary by platform.

string

Human-readable description of the event (e.g., 'Package arrived at sorting facility'). Optional.

string

City where the event occurred. Optional.

string

State or province where the event occurred. Optional.

string

Country where the event occurred (ISO code). Optional.

date-time

ISO 8601 timestamp when this event occurred. Defaults to the current time if omitted.

Response

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json