Sign in

v1

latestOpenAPI 3.0.12026-08-0688138402.2 KB
Bulk waybills

Close an open bulk waybill

Closes an open bulk waybill and returns its details. The response include the Base64 for the bulk waybill PDF.

put/waybills/{id}/close

Path parameters

idinteger required

ID for the bulk waybill to be included in the filter

Request body

label_format'10x19_pdf' | 'a4_pdf'

Format of routing labels. Defaults to default label format of the user.

Example request

{
  "packages": [
    {
      "product_code": "BRI_PPB",
      "package_type": "PARCEL",
      "amount": 3,
      "weight": 1000
    }
  ]
}

Response

Successful.

idinteger

ID of the bulk waybill. Used when referencing a specific bulk waybill.

referencestring

Carrier's reference of the bulk waybill.

status'open' | 'closed'

Current status of the bulk waybill. If open, more shipments can be added to the bulk waybill.

carrier_codestring

Carrier code, identifying which carrier the bulk waybill is created for.

customer_numberstring

The customer number that is attached to the bulk waybill.

created_atstring date-time

When the bulk waybill was created.

invoice_base64string

Base64-encoded string of invoice as PDF

base64string

Base64-encoded string of bulk waybill as PDF

Example response

{
  "id": 23,
  "reference": "CS000000000NO",
  "status": "closed",
  "carrier_code": "bring",
  "customer_number": "123456789",
  "created_at": "2018-06-16T06:25:44.557Z",
  "sender": {
    "name": "Min Virksomhed ApS",
    "address1": "Strandvejen 6B",
    "zipcode": "5240",
    "city": "Odense NØ",
    "country_code": "DK"
  },
  "receiver": {
    "name": "Lene Hansen",
    "address1": "Olav Kyrres gate 7",
    "zipcode": "0273",
    "city": "Oslo",
    "country_code": "NO"
  },
  "loading": {
    "name": "Lene Hansen",
    "address1": "Skibhusvej 52",
    "zipcode": "5000",
    "city": "Odense C",
    "country_code": "DK",
    "date": "2019-01-30T13:54:29.000Z"
  },
  "delivery": {
    "name": "Lene Hansen",
    "address1": "Olav Kyrres gate 7",
    "zipcode": "0273",
    "city": "Oslo",
    "country_code": "NO"
  },
  "shipment": {
    "id": 123456,
    "label_base64": "..."
  },
  "invoice_base64": "...",
  "base64": "..."
}