Skip to Content
dzshipBY DZBUILD
Shipping

Get the waybill of a parcel

Returns the label the courier prints for this parcel. format "pdf" carries the file in data as base64; format "url" carries a link in url. GET /v1/couriers says which couriers offer labels (capabilities.label); the others answer 422.

POST
/v1/label

Returns the label the courier prints for this parcel. format "pdf" carries the file in data as base64; format "url" carries a link in url. GET /v1/couriers says which couriers offer labels (capabilities.label); the others answer 422.

Request Body

application/json
  1. body
courier*string
credentials?

The caller's own credentials for that courier, 1-8 string fields. Never stored. Omit entirely for the sandbox courier.

options?
trackingNumber*string
Lengthlength <= 80

Response Body

The label

application/json
  1. response
trackingNumber*string
format*string
Value in"pdf""zpl""url"
data*string

Base64 of the file for pdf and zpl; the link for url

url?string

Present when format is url

Example Request
curl -X POST 'https://freeship.dzbuild.com/v1/label' \  -H 'Content-Type: application/json' \  -d '{  "courier": "string",  "trackingNumber": "string"}'
Example Response
{  "trackingNumber": "string",  "format": "pdf",  "data": "string",  "url": "string"}