Create Label

Create the label for shipping

Payload :

customer_shipment_id (string, optional): This is a unique field. If you leave this blank, an id will automatically be generated for you. If you have made a previous call with the same customer_shipment_id and it is in the pending or successful status, the subsequent calls will not be processed. If the previous shipment failed, you can call the API again with the same customer_shipment_id.

recipient (object, required): Information about the recipient of the shipment.

company_name (string, optional): Name of the company to recieve the parcel

person_name (string, required): Name of the recipient.

phone_number (string, required): Phone number of the recipient (10 characters).

address_line1 (string, required): Address line 1 of the recipient.

address_line2 (string, optional): Address line 2 of the recipient.

state_code (string, required): State code of the recipient's location (e.g., "IN" for Indiana).

city (string, required): City of the recipient's location.

postal_code (string, required): Postal code of the recipient's location.

country_code (string, required): Country code of the recipient's location (e.g., "US" for United States).

parcels (array, required): Array containing parcel details.

weight (number, required): Weight of the parcel.

width (number, required): Width of the parcel.

height (number, required): Height of the parcel.

length (number, required): Length of the parcel.

weight_unit (string, required): Unit of weight (e.g., "LB" for pounds).

dimension_unit (string, required): Unit of dimension (e.g., "IN" for inches).

count (number, required): Number of parcels with the same specifications.

reference_codes (object, optional): Additional reference codes for the shipment.

ref_1, ref_3 (string): Reference codes (ref_2 is reserved for organization id).

callback_url (string, optional): URL where notifications about the shipment will be sent.

{
 "customer_shipment_id" :"1234555",
 "recipient": {
 		"company_name": "Shipnitro",
    "person_name" :"Test User",
    "phone_number":"9125929406",
    "address_line1": "1151 S GRAHAM RD",
    "state_code": "IN",
    "city": "GREENWOOD",
    "postal_code": "46143",
    "country_code": "US"
  },
  "parcels": [
    {
      "weight": 1,
      "width": 5,
      "height": 20,
      "length": 10,
      "weight_unit": "LB",
      "dimension_unit": "IN",
      "count": 2
    }
  ],
  "reference_codes": {
    "ref_1": "2333",
    "ref_3": "111"
  },
  "callback_url": "http://192.168.1.6:3001/"
}

Due to large numbers of pdf when bulk shipping, pdf is being sent via chunk.

Response Details:

The first data will contain the information of the pdf including netcharge mastertracking number.

hash = (md5) hash of the whole pdf you can use this to check the integrity of the pdfs once finished

body = contains base64 encoded data of pdf

box_id = is the unique id of the request

totalNumberOfPdf = expected numbers of pdfs to be recieve

{
	'hash' : '------------',
	'body' :  [
			'masterTrackingNumber' => ,
			'netCharge' => null,
			'masterPDF' => null,
			'results' => [],
		]
	'box_id' : 'unique box id'
	'totalNumberOfPdf' : ''
}

The second data you will recieve is the actual pdf information (this will be sent over and over again until all the pdfs are sent );

box_id - this is the same unique request identifier that was sent on the first

contents - this is the base64 encode data of the pdf

{
	'box_id': '',
	'contents' : ''
}

The last callback response you will recieve is a confirmation response. Once you have recieve this repsonse this means that all the pdfs are sent and nothing will follow:

{
	'box_id' : ''
	'finished' : true
}

Request

Header Params

Body Params application/json

Example

{
    "recipient": {
        "address_line1": "100 Factory St, Ste C1",
        "address_line2": " ",
        "city": "Nashua",
        "country_code": "US",
        "state_code": "NH",
        "postal_code": "03060",
        "email": "",
        "person_name": "LISHU LIANG Andy60018",
        "company_name": "fengniao",
        "phone_number": "6468810775",
        "residential": false
    },
    "parcels": [
        {
            "length": 58,
            "width": 38,
            "height": 43,
            "weight": 13.78,
            "count": 1,
            "weight_unit": "KG",
            "dimension_unit": "CM"
        },
        {
            "length": 57,
            "width": 37,
            "height": 43,
            "weight": 13.73,
            "count": 1,
            "weight_unit": "KG",
            "dimension_unit": "CM"
        },
        {
            "length": 58,
            "width": 37,
            "height": 43,
            "weight": 13.75,
            "count": 1,
            "weight_unit": "KG",
            "dimension_unit": "CM"
        },
        {
            "length": 57,
            "width": 37,
            "height": 43,
            "weight": 13.67,
            "count": 1,
            "weight_unit": "KG",
            "dimension_unit": "CM"
        },
        {
            "length": 58,
            "width": 37,
            "height": 43,
            "weight": 13.77,
            "count": 1,
            "weight_unit": "KG",
            "dimension_unit": "CM"
        },
        {
            "length": 58,
            "width": 37,
            "height": 43,
            "weight": 13.67,
            "count": 1,
            "weight_unit": "KG",
            "dimension_unit": "CM"
        },
        {
            "length": 57,
            "width": 38,
            "height": 43,
            "weight": 13.76,
            "count": 1,
            "weight_unit": "KG",
            "dimension_unit": "CM"
        },
        {
            "length": 57,
            "width": 37,
            "height": 43,
            "weight": 13.75,
            "count": 1,
            "weight_unit": "KG",
            "dimension_unit": "CM"
        }
    ],
    "reference_codes": {
        "ref_1": "BR88888006764K",
        "ref_2": "FL069785"
    },
    "callback_url":"127.0.0.1:"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

application/json

Body

Example

{
    "box_id": "api_66675c95791e88f6c2019ab2",
    "message": "Label is generated label will be send later",
    "masterTrackingNumber": null
}

Request

Request samples

Responses