Shipment Webhook

Use the Shipment Webhook to create shipments asynchronously, so you can submit shipment requests without waiting for immediate label generation.

Asynchronous processing separates request submission from label generation. This supports high-volume operations and lets you prepare shipments for pick-and-pack workflows before printing labels on demand.

📘
Note
This feature is available for all carriers and supports all shipment actions, such as Allocate, Create, and Process when no action is specified.

Key benefits

Improves performance and reliability by removing synchronous dependencies.
Scales processing during peak periods through queued requests.
Gives you flexibility over shipment creation and label printing.
Supports pre-created shipments and on-demand label printing.

Workflow

Submit a request to the Create Shipment Async endpoint. The system processes the request as follows:

Checks whether the Shipment Webhook is configured via the SAPIENT UI.
Performs initial schema validation on the request.
Handles the request according to the webhook status.

The system accepts the request and returns a RequestID. It queues the shipment for asynchronous processing and sends the result to your configured webhook endpoint when processing finishes.

The result contains either a success response for the requested action or an error response if processing fails.

Retry process

If the system cannot deliver a response to your webhook endpoint, it stores the failed response and retries delivery automatically.

When the webhook is suspended, the system retains pending responses and delivers them after you reactivate the webhook. You cannot submit new asynchronous shipment requests while the webhook is suspended, which prevents the backlog from increasing.

The system stores responses in blob storage for re-delivery. Data-retention policies and storage-capacity considerations apply to stored responses.

Getting started

Set Up Shipment Webhook Connection

Automate the instantaneous flow of information regarding your shipments.

Create Shipment Async

Create a shipment request using this endpoint for asynchronous processing.