API Portal

WMS Portal

Create Label

Request URL:
  1. /shipment/createLabel

Request Method

POST

Request Body Parameters

Parameter Name Example Type Required Description
sellerOrderNumberTESTORDER-001StringYesSales order number
serviceCode–StringYesShipping service code
poZipCode–StringYesOrigin warehouse postal code (5-digit), for certain USPS channels only
shipFrom (Object) — Sender’s address
shipFrom.code–StringNoSender location code
shipFrom.nameTESTStringYesCompany or sender name
shipFrom.attentionNameTESTStringNoContact person
shipFrom.countryCodeUSStringYes2-letter country code
shipFrom.stateCodeCAStringYes2-letter state code
shipFrom.cityrowland heightStringYesCity
shipFrom.addressLine1testStringYesAddress line 1
shipFrom.addressLine2–StringNoAddress line 2
shipFrom.postalCode91748StringYesPostal code
shipFrom.phone0000000000StringYesPhone number
shipFrom.phoneExtension0000StringNoPhone extension
shipFrom.isResidentialfalseBooleanYesIs residential address
shipTo (Object) — Recipient’s address
shipTo.nameTESTStringYesCompany or recipient name
shipTo.attentionNameTESTStringNoContact person
shipTo.countryCodeUSStringYes2-letter country code
shipTo.stateCodeCAStringYes2-letter state code
shipTo.cityrowland heightStringYesCity
shipTo.addressLine1testStringYesAddress line 1
shipTo.addressLine2–StringYesAddress line 2
shipTo.postalCode91748StringYesPostal code
shipTo.phone0000000000StringYesPhone number
shipTo.phoneExtension0000000000StringNoPhone extension
shipTo.isResidentialtrueBooleanYesIs residential address
packages (Array) — Package list
length10NumberYesLength
width10NumberYesWidth
height10NumberYesHeight
weight14NumberYesWeight (each)
quantity1NumberYesPackage quantity
declaredValue100NumberNoDeclared insurance value (USD)
reference1REF01StringNoReference number 1
reference2–StringNoReference number 2
options (Object) — Order settings
dimensionUnitCodeINStringYesDimension unit, use “IN”
weightUnitCodeLBSStringYesWeight unit, use “LBS”
packageTypecustomPackageStringNoPackage type, default is “customPackage”
shipDate2022-05-14StringNoShipping date (YYYY-MM-DD)
deliveryConfirmationsignatureStringNoSignature service: none, signature, or adultSignature
isReturnLabelfalseBooleanNoIs return label
isDGfalseBooleanNoIs dangerous goods
isUniqueSellerOrderNumberfalseStringNoLimit 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"
}