Get Shipment by Id

The operation retrieves shipment details using shipmentId.

SecuritybearerAuth

Request

path Parameters

shipmentId

required

string

The shipmentId, a unique identifier for an individual Shipment.

header Parameters

X-PB-Developer-Partner-Id

string

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.

Responses

200

The shipment has been retrieved.

400

Invalid request.

401

The request could not be authorized.

404

The requested resource was not found.

500

The request could not be completed due to an internal error.

get/api/v1/shipments/{shipmentId}

Request samples

Response samples

application/json

{"correlationId": "b448ca2e733d4e23994a85374b9d8264",
"fromAddress": {"addressLine1": "27 Waterview Dr",
"addressLine2": "near abc street",
"addressLine3": "near xyz street",
"cityTown": "Rochester",
"company": "ABC Company",
"countryCode": "US",
"email": "rs.canid@gmail.com",
"name": "Rufous Sirius Canid",
"phone": "323 555-1212",
"postalCode": "14609-7418",
"residential": false,
"stateProvince": "NY"
},
"parcel": {"length": 2,
"width": 1,
"height": 1,
"dimUnit": "IN",
"weightUnit": "OZ",
"weight": 1
},
"metadata": [{"name": "costAccountName",
"value": "test"
}
],
"parcelId": "B1092",
"parcelTrackingNumber": "9471309105156000826739",
"rate": {"baseCharge": 25.5,
"carrier": "USPS",
"currencyCode": "USD",
"parcelType": "PKG",
"rateTypeId": "CONTRACT_RATES",
"serviceId": "EM",
"specialServices": [{"fee": 88.5,
"inputParameters": [{"name": "INPUT_VALUE",
"value": "5000"
}
],
"specialServiceId": "Ins"
},
{"fee": 3.35,
"inputParameters": [{"name": "INPUT_VALUE",
"value": "12345"
}
],
"specialServiceId": "RR"
},
{"fee": 0,
"specialServiceId": "liveanimal"
},
{"fee": 0,
"specialServiceId": "Sig"
},
{"fee": 0,
"specialServiceId": "PO to Addressee"
}
],
"totalCarrierCharge": 117.35
},
"service": "",
"shipmentId": "XXXX2200579677758143",
"shipmentOptions": {"addToManifest": true,
"printCustomMessage": "Print Message 1",
"receiptOption": "RECEIPT_WITH_INSTRUCTIONS",
"printDepartment": "department",
"printInvoiceNumber": "invoicenumber",
"printPONumber": "ponumber",
"shipperId": "1234567890",
"minimalAddressValidation": true,
"bookingConfirmationNumber": "XXXX56789812",
"billingWeight": "128.0"
},
"status": "COMPLETE",
"toAddress": {"addressLine1": "27 Waterview Dr",
"addressLine2": "near abc street",
"addressLine3": "near xyz street",
"cityTown": "Stamford",
"company": "Pitney Bowes Inc.",
"countryCode": "US",
"email": "john.publica@pb.com",
"name": "Paul Wright",
"phone": "203-555-1213",
"postalCode": "06905-4317",
"residential": false,
"stateProvince": "CT"
},
"altReturnAddress": {"addressLine1": "27 Waterview Dr",
"addressLine2": "near abc street",
"addressLine3": "near xyz street",
"company": "PB",
"email": "user@email.com",
"residential": true,
"cityTown": "Shelton",
"countryCode": "US",
"name": "User Name",
"phone": "203-555-1213",
"postalCode": "06484",
"stateProvince": "CT"
}
}