Acknowledge shipment
For users of fabric Webhook Service, Shipment related events can trigger HTTP call-backs to notify web clients via a merchant-defined URL/URI, typically an API Gateway for a middleware. While the response to fabric Webhook service HTTP call-back may occur, a secondary call-back can utilize this Acknowledge shipment endpoint to indicate that a secondary external system has acknowledged this shipment event. Middleware receives the event, transforms it in a suitable format, and sends a success response back to fabric, confirming it received the event. It also sends the transformed event to an external merchant system (typically in XML or JSON).
With this endpoint, middleware immediately sends an asynchronous acknowledgement to fabric, based on shipping ID, to indicate whether the call was successful. This acknowledgement is used for learning, auditing, and taking any necessary action.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
Merchant's 24-character tenant ID
Sales channel ID
Unique request ID
Path Parameters
24-character system-generated shipment ID. It is generated in the response of Create Shipment - POST /shipments
endpoint.
Body
Shipment acknowledgement time from middleware. If omitted, fabric uses the time (UTC) of Acknowledgement shipment call - POST /shipments/{shipmentId}/acknowledge
.
Merchant-defined custom attributes. This is a placeholder for addition info (in key: value pairs)
Response
Shipment acknowledgement time (UTC)
Was this page helpful?