API Portal

WMS Portal

Create Label

Request URL:

/shipment/createLabel

Request Method

POST

Request Body Parameters

Parameter Name	Example	Type	Required	Description
sellerOrderNumber	TESTORDER-001	String	Yes	Sales order number
serviceCode	–	String	Yes	Shipping service code
poZipCode	–	String	Yes	Origin warehouse postal code (5-digit), for certain USPS channels only
shipFrom (Object) — Sender’s address
shipFrom.code	–	String	No	Sender location code
shipFrom.name	TEST	String	Yes	Company or sender name
shipFrom.attentionName	TEST	String	No	Contact person
shipFrom.countryCode	US	String	Yes	2-letter country code
shipFrom.stateCode	CA	String	Yes	2-letter state code
shipFrom.city	rowland height	String	Yes	City
shipFrom.addressLine1	test	String	Yes	Address line 1
shipFrom.addressLine2	–	String	No	Address line 2
shipFrom.postalCode	91748	String	Yes	Postal code
shipFrom.phone	0000000000	String	Yes	Phone number
shipFrom.phoneExtension	0000	String	No	Phone extension
shipFrom.isResidential	false	Boolean	Yes	Is residential address
shipTo (Object) — Recipient’s address
shipTo.name	TEST	String	Yes	Company or recipient name
shipTo.attentionName	TEST	String	No	Contact person
shipTo.countryCode	US	String	Yes	2-letter country code
shipTo.stateCode	CA	String	Yes	2-letter state code
shipTo.city	rowland height	String	Yes	City
shipTo.addressLine1	test	String	Yes	Address line 1
shipTo.addressLine2	–	String	Yes	Address line 2
shipTo.postalCode	91748	String	Yes	Postal code
shipTo.phone	0000000000	String	Yes	Phone number
shipTo.phoneExtension	0000000000	String	No	Phone extension
shipTo.isResidential	true	Boolean	Yes	Is residential address
packages (Array) — Package list
length	10	Number	Yes	Length
width	10	Number	Yes	Width
height	10	Number	Yes	Height
weight	14	Number	Yes	Weight (each)
quantity	1	Number	Yes	Package quantity
declaredValue	100	Number	No	Declared insurance value (USD)
reference1	REF01	String	No	Reference number 1
reference2	–	String	No	Reference number 2
options (Object) — Order settings
dimensionUnitCode	IN	String	Yes	Dimension unit, use “IN”
weightUnitCode	LBS	String	Yes	Weight unit, use “LBS”
packageType	customPackage	String	No	Package type, default is “customPackage”
shipDate	2022-05-14	String	No	Shipping date (YYYY-MM-DD)
deliveryConfirmation	signature	String	No	Signature service: none, signature, or adultSignature
isReturnLabel	false	Boolean	No	Is return label
isDG	false	Boolean	No	Is dangerous goods
isUniqueSellerOrderNumber	false	String	No	Limit seller order number to be unique

Request Example

{
  "sellerOrderNumber": "TESTORDER-001",
  "shipFrom": {
    "name": "TEST",
    "attentionName": "TEST",
    "countryCode": "US",
    "stateCode": "CA",
    "city": "rowland height",
    "addressLine1": "test",
    "addressLine2": "",
    "postalCode": "91748",
    "phone": "0000000000",
    "phoneExtension": "0000"
  },
  "shipTo": {
    "name": "TEST",
    "attentionName": "TEST",
    "countryCode": "US",
    "stateCode": "CA",
    "city": "rowland height",
    "addressLine1": "test",
    "addressLine2": "",
    "postalCode": "91748",
    "phone": "0000000000",
    "phoneExtension": "0000000000",
    "isResidential": true
  },
  "packages": [
    {
      "length": 10,
      "width": 10,
      "height": 10,
      "weight": 14,
      "quantity": 1,
      "reference1": "REF01"
    }
  ],
  "options": {
    "dimensionUnitCode": "IN",
    "weightUnitCode": "LBS"
  }
}

Response Example

{
  "code": 200,
  "data": {
    "masterTrackingNumber": "1Z005780000000000",
    "ShipmentNo": "shipment_c26h06ron0mddh2186p0",
    "carrierCode": "UPS",
    "serviceCode": "UPSGround",
    "totalCharge": 10.02,
    "currencyCode": "USD",
    "chargeItems": null,
    "labelUrl": "https://pdf_url",
    "labelFileType": "pdf",
    "trackingNumbers": [
      "1Z005780000000000"
    ],
    "sellerOrderNumber": "TESTORDER-001",
    "fileDatas": null
  },
  "message": "success"
}