The Create Shipment endpoint initiates the shipment creation process. When this endpoint is called, the system begins generating the shipping label with the carrier. Since label generation may take some time, the label will not always be immediately available after the shipment is created.Important: After successfully creating a shipment, you must poll the Retrieve Shipment Details endpoint every 10 seconds to check if the shipping label has been generated. Continue polling until the label is available, or until 10 minutes have elapsed.
If the label is ready, the Retrieve Shipment response will include the label data.
If the label is not yet ready, the response will indicate that the label is still being processed.
If 10 minutes have elapsed without a label being generated, it is most likely that the shipment encountered an error during processing with the carrier. In this case, the client should stop polling and handle the situation appropriately (e.g., show an error message to your users, retry the shipment creation process, or contact our support).
This asynchronous workflow ensures that you reliably obtain the shipment label once it has been generated by the carrier.
Request
Header Params
Body Params application/json
Example
{"recipient":{"postalCode":"34986","city":"PORT SAINT LUCIE","stateCode":"FL","addressLine1":"7600 LTC Parkway","addresLine2":null,"countryCode":"US","personName":"PBI3-Fedex","companyName":"Test","email":null,"phoneNumber":"8888888888","forceAddress":true},"parcels":[{"weight":2,"width":12,"height":2,"length":11,"weightUnit":"LB","dimensionUnit":"IN","count":1,"referenceCodes":{"reference1":"test1111","reference3":"test1122"}},{"weight":5,"width":15,"height":2,"length":11,"weightUnit":"LB","dimensionUnit":"IN","count":1,"referenceCodes":{"reference1":"test2222","reference3":"test3333"}}]}
