omnicado-mall-proxy
POST /orders/{orderId}/labels

Replaced by batch /orders/labels endpoint.

Headers

  • X-Application-Name string

Path parameters

  • orderId integer(int64) Required

    Order identifier

Query parameters

  • client_id string Required

    Client identifier

Body Required

Parcel count

  • label_type string

    Values are pdf or zpl. Default value is pdf.

  • parcel_count integer Required

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 string

        base64 representation of PDF or ZPL labels

    • result object
      Hide result attributes Show result attributes object
      • code integer(int)
      • status string
    • paging object
      Hide paging attributes Show paging attributes object
      • pages integer
      • size integer
      • page integer
POST /orders/{orderId}/labels 
curl \
 -X POST https://mpapi.proxy.omnicado.com/v1/orders/89591350/labels?client_id=yourClientId&client_id=api_token_value \
 -H "Content-Type: application/json" \
 -H "X-Application-Name: myApplicationName" \
 -d '{"label_type":"pdf","parcel_count":3}'
Request example 
# Headers
X-Application-Name: myApplicationName

# Payload
{
  "label_type": "pdf",
  "parcel_count": 3
}
Request examples 
# Headers
X-Application-Name: myApplicationName

# Payload
{
  "label_type": "pdf",
  "parcel_count": 3
}
Response examples (200) 
{
  "data": {
    "orders": [
      {
        "order_id": 223424231402,
        "barcodes": [
          "14IS12361223*001004",
          "14IS12361223*002004",
          "14IS12361223*003004"
        ]
      }
    ],
    "labels_raw": "JVBERi0xLjMNCiXi48/TDQoNCjEgMCBvYmoNCjw8DvUGFnZXMgMyAwIFINCj...MjcxNA0KJSVFT0YNCg=="
  },
  "result": {
    "code": 200,
    "status": "OK"
  },
  "paging": {
    "pages": 1,
    "size": 1,
    "page": 1
  }
}
Response examples (200) 
{
  "data": {
    "orders": [
      {
        "order_id": 223424231402,
        "barcodes": [
          "14IS12361223*001004",
          "14IS12361223*002004",
          "14IS12361223*003004"
        ]
      }
    ],
    "labels_raw": "JVBERi0xLjMNCiXi48/TDQoNCjEgMCBvYmoNCjw8DvUGFnZXMgMyAwIFINCj...MjcxNA0KJSVFT0YNCg=="
  },
  "result": {
    "code": 200,
    "status": "OK"
  },
  "paging": {
    "pages": 1,
    "size": 1,
    "page": 1
  }
}