Deliveries API
Search
K
Comment on page

Print Labels

Warehouses often print labels to paste them into every package before dispatching. You can use this endpoint to generate a PDF file with the labels from one or more deliveries.
This report will send by email

Endpoint

POST /v1/reports/export/new

Request

Property
Type
Description
Required
Constraints
deliveries
string
IDs of the task you want to print label
YES
Separated by comma
tz
string
Timezone of report
NO
Format "HH:mm"
lang
string
Language of report. Can be es, en, pt
NO
report_type
string
Report type, for this case is "LABEL"
YES
report_name
string
File name
YES
emails
string
List of emails where the report will be sent
YES
Separated by comma

Response

Property
Type
Description
code
string
Result code
data.executionArn
string
Execution process of the report generator.
startDate
string
Request submission date.

Example

Request
200 Success
curl --location 'https://api.shippify.co/v1/reports/export/new' \
--header 'Authorization: Basic XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--header 'Content-Type: application/json' \
--header 'Cookie: locale=es' \
--data-raw '{
"tz": "-05:00",
"lang": "en",
"report_type": "LABEL",
"deliveries": "t-pruaas-4973",
"report_name": "Report 27-10-2023 04:46",
"emails": "[email protected]"
}'
{
"code": "OK",
"data": {
"executionArn": "arn:aws:states:sa-east-1:878623218037:execution:reportMachineProd:RS_324217",
"startDate": "2023-10-27T21:50:51.087Z"
}
}

Email

Email with label report

Report

Label report