Generates labels for both DIP and MPD orders

POST /orders/labels/bulk

You can create order labels needed for order delivery by MPD or DIP transports. Number of parcels is required for label creation. Response contains base64 representation of PDF/ZPL labels.

You can generate parcel labels when the order is set to status shipping or shipped. When order is set to shipped you cannot change parcel_count anymore and the last number of labels always applies.

Headers

X-Application-Name string

Query parameters

client_id string Required

Client identifier

Body Required

labels_type string

Values are pdf or zpl.
first_position integer

Minimum value is 1.
labels_per_page number
labels array[object]
Hide labels attributes Show labels attributes array[object]
- order_id integer
- parcel_count integer
  
  Maximum value is 100.

Responses

200

OK
Hide response attributes Show response attributes object
- data object
  
  Hide data attributes Show data attributes object
  
  orders array[object]
  
  Hide orders attributes Show orders attributes array[object]
  
  order_id integer
  
  barcodes array[string]
  
  labels_raw object
  
  Hide labels_raw attributes Show labels_raw attributes object
  
  dip string
  
  base64 representation of PDF or ZPL labels
  
  mdp string
  
  base64 representation of PDF or ZPL labels
- result object
  
  Hide result attributes Show result attributes object
  
  code integer(int)
  
  status string

POST /orders/labels/bulk

curl \
 -X POST https://mpapi.proxy.omnicado.com/v1/orders/labels/bulk?client_id=yourClientId&client_id=api_token_value \
 -H "Content-Type: application/json" \
 -H "X-Application-Name: myApplicationName" \
 -d '{"labels_type":"pdf","first_position":1,"labels_per_page":4,"labels":[{"order_id":123456,"parcel_count":4}]}'

Request example

# Headers
X-Application-Name: myApplicationName

# Payload
{
  "labels_type": "pdf",
  "first_position": 1,
  "labels_per_page": 4,
  "labels": [
    {
      "order_id": 123456,
      "parcel_count": 4
    }
  ]
}

Request examples

# Headers
X-Application-Name: myApplicationName

# Payload
{
  "labels_type": "pdf",
  "first_position": 1,
  "labels_per_page": 4,
  "labels": [
    {
      "order_id": 123456,
      "parcel_count": 4
    }
  ]
}

Response examples (200)

{
  "data": {
    "orders": [
      {
        "order_id": 223424231402,
        "barcodes": [
          "14IS12361223*001004",
          "14IS12361223*002004",
          "14IS12361223*003004"
        ]
      }
    ],
    "labels_raw": {
      "dip": "JVBERi0xLjMNCiXi48/TDQoNCjEgMCBvYmoNCjw8DvUGFnZXMgMyAwIFINCj...MjcxNA0KJSVFT0YNCg==",
      "mdp": "JVBERi0xLjMNCiXi48/TDQoNCjEgMCBvYmoNCjw8DvUGFnZXMgMyAwIFINCj...MjcxNA0KJSVFT0YNCg=="
    }
  },
  "result": {
    "code": 200,
    "status": "OK"
  }
}

Response examples (200)

{
  "data": {
    "orders": [
      {
        "order_id": 223424231402,
        "barcodes": [
          "14IS12361223*001004",
          "14IS12361223*002004",
          "14IS12361223*003004"
        ]
      }
    ],
    "labels_raw": {
      "dip": "JVBERi0xLjMNCiXi48/TDQoNCjEgMCBvYmoNCjw8DvUGFnZXMgMyAwIFINCj...MjcxNA0KJSVFT0YNCg==",
      "mdp": "JVBERi0xLjMNCiXi48/TDQoNCjEgMCBvYmoNCjw8DvUGFnZXMgMyAwIFINCj...MjcxNA0KJSVFT0YNCg=="
    }
  },
  "result": {
    "code": 200,
    "status": "OK"
  }
}