Paying for Shipment
At the time of offer selection, the other offers (not selected) are deleted.
Attention! Asynchronous processing.
Because the process of buying a shipment is asynchronous the server will return a response without changes related to the buy itself (status change, tracking number assignement) because that data will be available only after some time
|Integer||Offer ID available for the shipment being paid|
The attribute is required.
Errors that may appear when paying for a shipment:
resource_not_found- User has no access to the resource or the shipment does not exist.
offer_unavailable- Offer is in a different status than
transaction_failed- If the payment processing was not succesful
offer_expired- Offer is expired (offers are available 5 minutes after they have been generated)
Asynchronous Shipment payment
To retrieve information about the succesful purchase of the shipment, in the organisation settings define a url for sending
shipment_confirmed events. This will result in ShipX sending the following information to the url.