Create Shipping Label

Generate a new shipping label via UPS logistics.

POST
/api/v1/shipping/label/create

Description

Creates a shipping label. Accepts flat address fields or structured object_app / object_ship_from / object_other payloads.

Request

Headers

HeaderValueRequired
AuthorizationBearer <access_token>Yes
Content-Typeapplication/jsonYes

Body Parameters

ParameterTypeRequiredDescription
address_line_1stringYesShip-from street (or use object_app).
citystringYesCity.
statestringYesState.
zipstringYesPostal code.
countrystringNoCountry code (default US).
lengthnumberYesPackage length (inches).
widthnumberYesPackage width (inches).
heightnumberYesPackage height (inches).
lbsnumberNoWeight pounds.
oznumberNoWeight ounces.
first_namestringNoSender first name.
last_namestringNoSender last name.
phonestringNoContact phone.
label_countnumberNoNumber of labels (default 1).
label_to_contactsnumberNo1 to email label to contacts.
label_to_menumberNo1 to email label to requester.

Example Request Body

{
  "address_line_1": "100 Main St",
  "city": "Austin",
  "state": "TX",
  "zip": "78701",
  "country": "US",
  "length": 12,
  "width": 10,
  "height": 4,
  "lbs": 2,
  "oz": 0,
  "first_name": "Jane",
  "last_name": "Smith",
  "phone": "5551234567",
  "label_count": 1
}

Response

Related Endpoints

Did this page help you?