Merchants will be required to notify Bread about certain shipment events details. This is facilitated by submitting a POST request to an endpoint identified by the transactionId.

ArgumentsDescriptionRequiredLocation
:tx-idIdentifier of the transaction to be retrievedYesRequest Parameter
trackingNumberShipment carrier tracking numberNoRequest Body
carrierNameShipment carrier nameNoRequest Body
POST https://api.getbread.com/transactions/:tx-id/shipment
{
  "trackingNumber": "ABCDEFGH1234",
  "carrierName": "USPS"
}
curl -u <api-key>:<secret-key> -X POST \
 -H 'Content-Type: application/json' \
 https://api.getbread.com/transactions/caf8afac-1a6f-4f55-a6d8-fd46763e8cb3/shipment \
 -d = '{"trackingNumber":"ABCDEF1234","carrierName": "USPS"}'