Creating Shipment Labels
POST
api/v2/shipments
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"
}
}
]
}Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://app.shipnitro.com/api/v2/shipments' \
--header 'Authorization: Basic {{apiKey}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"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"
}
}
]
}'Responses
🟢200Success
application/json
Body
Examples
{
"boxId": "api_fskhjoowe234asa",
"message": [
"Shipment Label sucessfully submitted"
]
}🟠400Bad Request
Modified at 2025-07-15 20:35:58