Close Day
Generate a closing shipping list (bordero) for a group of shipments under the same contract. Returns a bordero ID and a base64-encoded PDF report.
POST /shippinglist/create
Request
Headers
| Header | Value |
|---|---|
Authorization | Bearer <your_api_token> |
Content-Type | application/json |
Body Parameters
| Field | Type | Required | Description |
|---|---|---|---|
shipment_ids | number[] | Yes | Array of shipment IDs to include in the closing list |
contract_code | string | Yes | Contract code for the shipments (e.g. brt-Test) |
Example
Request
{
"shipment_ids": [7, 8, 9],
"contract_code": "brt-Test"
}Response Fields
| Field | Type | Description |
|---|---|---|
bordero | number | Bordero (shipping list) ID |
pdf | string | Base64-encoded PDF of the shipping list |
Decoding the PDF
const fs = require('fs')
const pdfBuffer = Buffer.from(response.pdf, 'base64')
fs.writeFileSync('bordero.pdf', pdfBuffer)All shipment_ids must belong to the same contract_code. Run this once per day per contract to finalise daily shipments with the carrier.
Error Codes
| Code | Description |
|---|---|
200 | OK — bordero generated |
Last updated on