Create a Label

Create a Label

Creates labels for the requested shipment

HTTP Request

📘
POST
https://www.weels.ca/api/label

Request Parameters

Parameter Name	Description
width	Width of parcel (Inches)
length	Length of parcel (Inches)
height	Height of parcel (inches)
weight	Weight of parcel (kg)
service_type	"SAMEDAY" or "NEXTDAY"
business_name	The name of the business
origin
origin > company	Origin Company name
origin > first_name	Origin first name
origin > last_name	Origin last name
origin > phone	10-digit Origin phone number
origin > email	Origin email address
origin > address
origin > address > line1	Origin Address line 1
origin > address > line2	Origin Address line 2
origin > address > city	Origin City
origin > address > province	Origin Province
origin > address > postal_code	Origin postal code
origin > address > country	Origin country, default = CA
destination
destination > company	Destination Company name
destination > first_name	Destination first name
destination > last_name	Destination last name
destination > phone	10-digit Destination phone number
destination > email	Destination email address
destination > address
destination > address > line1	Destination Address line 1
destination > address > line2	Destination Address line 2
destination > address > city	Destination City
destination > address > province	Destination Province
destination > address > postal_code	Destination postal code
destination > address > country	Destination country, default = CA
options
options > age_verification	Default = false, accepted values are 18, 19, or 21.
options > signature	Default = false, accepted values are true or false
options > refrigeration	Default = 0, 0 = None, 1 = Refrigerated, 2 = Frozen
reference	Optional reference number
order_num	Optional order number

{"width":"12","length":"12","height":"4","weight":"0.75","service_type":"SAMEDAY","business_name":"My Company Name","origin":{"company":"My Company Name","first_name":"Sam","last_name":"Lockhart","phone":"4169255229","email":"[email protected]","address":{"line1":"123 Main St","line2":"Unit 3","city":"Markham","postal_code":"L3R9T5","province":"ON","country":"CA"}},"destination":{"company":"Company Name","first_name":"Ryan","last_name":"Glass","phone":"1111111111","email":"[email protected]","address":{"line1":"180 University Ave","line2":"Suite 1304","city":"Toronto","postal_code":"M5H0A2","province":"ON","country":"CA"}},"options":{"age_verification":"19","refigeration":"0","signature":true},"reference":"test 123","order_num":"1234567890"}

PHP Array Example

$fields = array(
	"width" => "12",
  "length" => "12",
 	"height" => "4",
	"weight" => "0.75",
  "service_type" => "SAMEDAY",
  "business_name" => "My Company Name",
  "origin" => array (
  	"company" => "My Company Name",
    "first_name" => "Sam",
    "last_name" => "Lockhart",
    "phone" => "4169255229",
    "email" => "[email protected]",
    "address" => array(
    	"line1" => "123 Main St",
			"line2" => "Unit 3",
      "city" => "Markham",
      "postal_code" => "L3R9T5",
      "province" => "ON",
      "country" => "CA"
	)            
 		),
	"destination" => array(
  	"company" => "Company Name",
    "first_name" => "Ryan",
    "last_name" => "Glass",
    "phone" => "1111111111",                
    "email" => "[email protected]",
    "address" => array(
   		"line1" => "180 University Ave",
      "line2" => "Suite 1304",
      'city' => "Toronto",
      "postal_code" => "M5H0A2",
      "province" => "ON",
      "country" => "CA"
	)               
  	),    
  "options" => array(
    "age_verification" => "19",
    "refigeration" => "0",
    "signature" => true,
    ),
    "reference" => "test 123",
    "order_num" => "1234567890"
);

Response Paramters

Parameter Name	Description
shipment_id	the tracking number of the shipment
expected	unix timestamp of expected delivery date
tracking_url	tracking URL for shipment
live_tracking_url	If applicable, a live tracking URL
label	URL to shipping label
price
price > base	base cost of the shipment
price > age_verification	additional cost for age verification
price > signature	additional cost for signature required
price > refrigeration	additional cost for refrigeration
price > hst	hst
price > pst	pst
price > total	Total cost of shipment

{"shipment_id":10027926,"tracking_url":"https://www.weels.ca/track/10027926",expected":1628816400,"label":"https:\/\/www.weels.ca\/images\/labels\/10027926-1628698703.pdf","price":{"base": "10.00","age_verification":"1.00","signature":"1.00","refrigeration":null,"hst":"1.56","pst":"0.00","total":"13.56"}}

📘POST

Request Parameters

PHP Array Example

Response Paramters

📘
POST