Skip to content

Get Shipment by Id

Request

"The operation retrieves shipment details using shipmentId."

Security
bearerAuth
Path
shipmentIdstringrequired

The shipmentId, a unique identifier for an individual Shipment.

Headers
X-PB-Developer-Partner-Idstring

The Developer Partner ID is assigned by PB to uniquely identify a Developer's strategic business partners. If the developer is the sole business partner, this field isn't required.

curl -i -X GET \
  'https://api-sandbox.sendpro360.pitneybowes.com/shipping/api/v2/shipments/{shipmentId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-PB-Developer-Partner-Id: string'

Responses

The shipment has been retrieved.

Bodyapplication/json
correlationIdstring

Unique identifier assigned by the shipping system to the transaction.

Example:"49ce304a251447539c84b204d968d7c4"
subIdstring

Subscription identifier associated with the shipment.

Example:"sac735d"
fromAddressobject(fromAddressV2Response)

The complete address of the Sender.

toAddressobject(fromAddressV2Response)

The complete address of the Sender.

altReturnAddressobject

Alternate return address for the shipment, if provided.

parcelTrackingNumberstring

Tracking number assigned to the parcel by the carrier.

Example:"UPS2202625646462636"
serviceIdstring

The unique identifier given to the carrier specific service.

Example:"NDA"
rateobject(rateResponseV2)
shipmentIdstring

Unique identifier of the shipment.

Example:"UPS2202625646462636"
shipmentOptionsobject

Additional shipment options.

customsobject(Customs)

Customs information required for international shipments and optional for domestic shipments.

  • Required only for RMG carrier in domestic shipment requests.
  • Must include customsItems and customsInfo objects.
statusstring

Current status of the shipment.

Example:"Label Printed"
carrierstring

Carrier code/name used for the shipment.

Example:"ups"
carrierAccountIdstring

Carrier account Id used for the shipment.

Example:"EQ7Ar2dmXXX"
metadataArray of objects

Additional metadata that needs to be stored for this shipment can be added here.
Supported values are Cost Account Name, Cost Account Id, Cost Account Code, Account Code and Company Code.
If Cost Account metadata is provided, all three Cost Account fields are required.

parcelsArray of objects

List of parcels for a multi-parcel request.

dispenseClientstring

Client/system used to create the shipment.

Example:"api"
refundStatusstring

Refund status of the shipment.

isInternationalboolean

Indicates whether the shipment is international.

Example:true
isReturnLblRequestedboolean

Indicates whether a return label was requested.

Example:false
insuredboolean

Indicates if the shipment is insured.

Example:true
carrierCodestring

Code of the carrier handling the shipment.

transactionCreateDatestring, (date-time)

Date and time when the shipment transaction was created.

Example:"2026-02-09T07:22:05.457Z"
locationIdstring

Identifier of the location where the shipment originated.

Example:"zLwdWnZ7LyVWknO"
referencesobject(referenceV2)

References are tags or information that is printed on Shipping Label based on the customer's requirement.
Reference Fields can have values/indication like department name, invoice no., package description, purchase order no., carrier note, cost account no., transportation no., or PO no., print custom message etc.
Each of the reference field can have only one indication/value.

ecommerceProviderobject

E-commerce platform details associated with the shipment. This object will only be return in case of using Order Management APIs.

Response
{ "correlationId": "49ce304a251447539c84b204d968d7c4", "subId": "sac735d", "fromAddress": { "name": "Sender Name", "addressLine1": "1600 Amphitheatre Parkway", "addressLine2": "near abc street", "addressLine3": "near xyz street", "company": "PB", "email": "testuser@gmail.com", "phone": "6502530000", "cityTown": "Mountain View", "stateProvince": "CA", "postalCode": "94043", "inductionPostalCode": "06905", "countryCode": "US", "residential": true }, "toAddress": { "name": "Sender Name", "addressLine1": "1600 Amphitheatre Parkway", "addressLine2": "near abc street", "addressLine3": "near xyz street", "company": "PB", "email": "testuser@gmail.com", "phone": "6502530000", "cityTown": "Mountain View", "stateProvince": "CA", "postalCode": "94043", "inductionPostalCode": "06905", "countryCode": "US", "residential": true }, "altReturnAddress": { "name": "Paul Wright", "addressLine1": "24182 Kathy Ave", "cityTown": "Lake Forest", "stateProvince": "CA", "postalCode": "92630-1827", "countryCode": "US", "phone": "203-555-1213", "residential": false }, "parcelTrackingNumber": "UPS2202625646462636", "serviceId": "NDA", "rate": { "baseCharge": 16.15, "carrier": "PUROLATOR", "currencyCode": "CAD", "parcelType": "PKG", "serviceId": "GRD", "surcharges": [ { … } ], "totalCarrierCharge": 22.46, "deliveryCommitment": { "estimatedDeliveryDateTime": "2024-03-25", "maxEstimatedNumberOfDays": 5, "guarantee": "None" }, "inductionPostalCode": "06905", "destinationZone": 1, "baseChargeTaxes": [ { … } ], "totalTaxAmount": 2.69, "publishedTotalCarrierCharge": 73.12 }, "shipmentId": "UPS2202625646462636", "shipmentOptions": { "billingWeight": "16.00" }, "customs": { "customsInfo": { "reasonForExport": "DOCUMENTS", "comments": "Test comment", "invoiceNumber": "001189223", "importerCustomsReference": "987654", "sdrValue": 23.32, "EELPFC": "NOEEI 30.2D2", "currencyCode": "USD", "fromCustomsReference": "EFEFE4554545", "licenseNumber": "456ABC123", "certificateNumber": "987", "customsDeclaredValue": 6000, "termsOfSale": "DDP" }, "customsItems": [ { … } ], "customsDocuments": [ { … } ] }, "status": "Label Printed", "carrier": "ups", "carrierAccountId": "EQ7Ar2dmXXX", "metadata": [ { "name": "costAccountName", "value": "cost account 123" } ], "parcels": [ { "parcel": { … }, "parcelType": "PKG", "specialServices": [ … ], "references": { … }, "items": [ … ] } ], "dispenseClient": "api", "refundStatus": "string", "isInternational": true, "isReturnLblRequested": false, "insured": true, "carrierCode": "string", "transactionCreateDate": "2026-02-09T07:22:05.457Z", "locationId": "zLwdWnZ7LyVWknO", "references": { "reference1": "custome message", "reference2": "SendTech", "reference3": "98437", "reference4": "Overnight Shipping", "poNumber": "R2W 2H2", "department": "Name department", "additionalReference1": "612987641", "additionalReference2": "989", "shippingNotes": "Handle with care.", "ShipperReference": "REF123456789", "transportationReference": "TRANSREF987654321" }, "ecommerceProvider": { "customer": { "id": "CUST12345", "email": "john.doe@example.com", "first_name": "John", "last_name": "Doe" }, "orderNumber": "3865" } }