Create Shipment Label

This API describes how to create a shipment label.

Method: POST

Request Body

json

{
  "reference_no": "123abc",
  "shipping_method": "STANDARD",
  "currency": "USD",
  "duty_term": "DDP",
  "hazardous": false,
  "dangerous": false,
  "warehouse_code": "LAX",
  "from_address": {
    "name": "shipper name",
    "company_name": "",
    "address_1": "123 First St.",
    "address_2": "",
    "email": "help@email.com",
    "city": "Anytown",
    "state": "CA",
    "zip": "90210",
    "country": "US",
    "phone": "1234567890",
    "sender_id_no": "",
    "sender_tax_no": "",
    "sender_vat": ""
  },
  "to_address": {
    "name": "receiver name",
    "company_name": "",
    "address_1": "1 MAIN ST",
    "address_2": "",
    "email": "help@email.com",
    "city": "Anytown",
    "state": "CA",
    "zip": "90210",
    "country": "US",
    "phone": "1234567890",
    "residential_address": true,
    "consignee_id_type": "",
    "consignee_id_no": "",
    "consignee_id_expired": "",
    "consignee_tax_no": ""
  },
  "package": {
    "name": "",
    "weight": 20.35,
    "width": 12.55,
    "length": 15.2,
    "height": 4.7,
    "line_items": [
      {
        "sku": "sku-1",
        "unit_price": 10.05,
        "quantity": 1,
        "weight": 10,
        "product_name": "abc",
        "product_desc": "abc",
        "hs_code": "",
        "country_origin": "CN"
      },
      {
        "sku": "sku-2",
        "unit_price": 20.05,
        "quantity": 2,
        "weight": 5,
        "product_name": "def",
        "product_desc": "abc",
        "hs_code": "",
        "country_origin": "CN"
      }
    ]
  }
}

Request Body Explanation

Attribute Name	Type	Description
reference_no	String	Reference Number, must be unique
shipping_method	String	Method of shipping
currency	String	Currency code, only support USD for now
duty_term	String	(optional) Duty payment type, DDP(default) or DDU
hazardous	Boolean	(optional) If hazardous, False(default) or True
dangerous	Boolean	(optional) If dangerous, False(default) or True
warehouse_code	String	(optional) code of the warehouse shipping from
from_address	Object	sender's address
to_address	Object	consignee's address
name	String	name of sender or consignee
company_name	String	name of company
address_1	String	address line 1
address_2	String	address line 2
email	String	email address
city	String	city name
state	String	state or province
zip	String	zip code
country	String	country name
phone	String	phone number
sender_id_no	String	(optional) sender's ID number, ""(default)
sender_tax_no	String	(optional) sender's tax account number, ""(default)
sender_vat	String	(optional) sender's VAT value for some Europe destination, ""(default)
residential_address	Boolean	if residential address, True or False
consignee_id_type	String	consignee's ID type, "ID" or "PP", needed for countries CN/KR/TW
consignee_id_no	String	consignee's ID number, needed for countries CN/KR/TW
consignee_id_expired	String	consignee ID's expiration date, YYYYMMDD
consignee_tax_no	String	consignee's tax account number
package	Object	package information
name	String	package name
weight	Float	package weight, unit LB
width	Float	package width, unit inch
length	Float	package length, unit inch
height	Float	package height, unit inch
line_items	Object	item information
sku	String	sku number
unit_price	Float	price of each unit
quantity	Integer	quantity of this item
weight	Float	item weight, unit LB
product_name	String	(optional) product's name, ""(default)
product_desc	String	(optional) product's description, ""(default)
hs_code	String	(optional) item's Harmonized System code, ""(default)
country_origin	String	(optional) item's original country, ""(default)

Response Body

json

{
  "code": 200,
  "message": "success",
  "data": [
    {
      "reference_no": "123abc",
      "package": {
        "name": "",
        "shipping_method": "STAND",
        "tracking_number": "1ZGG47310324343941",
        "tracking_url": "https://www.goforgps.com/tracking/?search=1ZGG47310324343941",
        "label_pdf": "https://url-to-label.com/package1.pdf"
      }
    }
  ]
}

Response Body Explanation

Attribute Name	Type	Description
code	Integer	Response code: 200 successful, 400/500 failed
reference_no	String	Reference Number
packages	List	package shipping information
name	String	package name
shipping_method	String	Method of shipping
tracking_number	String	Shipping tracking number
tracking_url	String	Link of tracking trace
label_pdf	String	Download link of shipping label's PDF file