Skip to main content

Shipment Receipt Webhooks

Actions​

You can subscribe to the following actions:

  • shipment_receipt.completed
  • shipment_receipt.created
  • shipment_receipt.updated
  • shipment_receipt.deleted

Review webhooks to learn how to use these actions.

Use Cases​

Here are some recommended setups for common flows.

Notify when a Shipment is Received​

If you would like to be notified of an incoming shipment is received then follow the below configuration.

Configuration​

Configure your webhook to subscribe to the shipment_receipt.created action.

You will receive notifications for all new receipts being created. Note that if the completed_time property is not set then this receipt is not finalized and the quantities can still be updated.

Notify when Shipment Receipt is Completed​

If you would like to be notified when a receipt is finalized then follow the below configuration.

Configuration​

Configure your webhook to subscribe to shipment_receipt.completed action.

When the completed_time of a shipment is set you will receive a notification. The completed time can be set when the receipt is created or later as an update. Note that if you are also subscribed to shipment_receipt.updated or shipment_receipt.created you may receive webhooks for those depending on when completed_time is set.