ShipNitro
  1. API v2
ShipNitro
  • Authentication
  • API v2
    • Getting Shipment Rates
      POST
    • Retrieve Shipment Details
      GET
    • Creating Shipment Labels
      POST
    • Get Current Credit
      GET
    • Getting Tracking number status
      POST
  • API v1 - deprecated do not use
    • Get Labels
      POST
    • Get Rates
      POST
    • Create Label
      POST
    • Get Current Credit
      GET
  • Callbacks
    • v2
      • Customer Create Label Callback
    • v1 - deprecated do not use
      • Callback Part 1
  1. API v2

Creating Shipment Labels

POST
api/v2/shipments

Request

Header Params
Content-Type
string 
required
Example:
application/json
Authorization
string 
required
To get an api key, please ask assistance to the site admin.
Example:
Basic {{apiKey}}
Body Params application/json
customerShipmentId 
string  | null 
optional
recipient
object 
required
addressLine1
string 
required
addressLine2
string  | null 
optional
city
string 
required
stateCode
string 
required
postalCode
string 
required
countryCode
string 
required
personName
string 
required
>= 3 characters
companyName
string 
required
>= 3 characters
phoneNumber
string 
required
phoneExtension
string  | null 
optional
<= 6 characters
email
string  | null 
optional
forceAddress
boolean 
required
when this field is set to false, any error on the address field will block the creation of label and will require you to fix the address.
when this is set to true, the api will not block the creation of label but it could potentially charge you with address correction fee if the address was incorrect
parcels
array [object {8}] 
required
List of packages
length
number 
required
width
number 
required
height
number 
required
dimensionUnit
enum<string> 
required
Allowed values:
CMIN
weight
number 
required
weightUnit
enum<string> 
required
Allowed values:
KGLB
count
integer 
required
referenceCodes
object 
optional
service
string  | null 
optional
Default:
fedex_ground
referenceCodes
object 
optional
reference1
string  | null 
optional
reference3
string  | null 
optional
options
object 
optional
signatureType
enum<string> 
optional
Require signature on when recieving the package
Allowed values:
adultdirectindirectnone
callbackUrl
string  | null 
optional
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
success
boolean 
required
boxId
string 
required
unique id for each shipment
message
array[string]
required
Message about the shipment
Examples
{
    "boxId": "api_fskhjoowe234asa",
    "message": [
        "Shipment Label sucessfully submitted"
    ]
}
🟠400Bad Request
Previous
Retrieve Shipment Details
Next
Get Current Credit
Built with