Print the label for an order

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://api.documentation.omnicado.com/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json
{
  "omnicado MCP server": {
    "url": "https://api.documentation.omnicado.com/mcp"
  }
}

Close
POST /labels/order/{orderId}

Prints the shipping label for the order and returns it. When the order already has a label, that label is returned and nothing new is created, so the call is safe to repeat.

Orders shipped by a marketplace (Allegro, Alza, Temu, Mall, Base) get the marketplace's label. Other orders are printed with the carrier the order ships with, among the carriers installed on the account; send carrier to choose it yourself.

Printing a label never changes the order status.

Path parameters

  • orderId integer Required

    Omnicado order id

application/json

Body

  • carrier string

    Carrier to print with, out of those installed. Defaults to the carrier the order ships with. Not allowed for orders shipped by a marketplace.

    Values are dpd, dpdSk, gls, oneByAllegro, packeta, ppl, sps, toptrans, or wedo.

  • parcelCount integer

    Defaults to the order's package count

    Minimum value is 1, maximum value is 20.

  • labelFormat string

    Defaults to the account's label format

    Values are pdf or zpl.

Responses

  • 200 application/json

    The printed (or already stored) label

    Hide response attributes Show response attributes object
    • orderId integer | null

      Omnicado order id; null for a custom label

    • reference string

      Order number, or the reference of a custom label

    • carrier string

      Carrier code, or the marketplace delivery (e.g. alzaDelivery)

    • labelFormat string

      The format the carrier actually returned

      Values are pdf, zpl, or unknown.

    • trackingNumbers array[string]
    • trackingUrl string | null
    • cancelled boolean

      Custom labels only

    • label object
      Hide label attributes Show label attributes object
      • contentType string

        Values are application/pdf, application/zpl, or application/octet-stream.

      • content string(byte)

        Base64 encoded label

  • 202 application/json

    label_pending: the marketplace has not issued the label yet. Repeat the call after the number of seconds in the Retry-After header.

    Hide response attributes Show response attributes object
    • error string
    • code string

      Machine-readable reason, listed with each response

  • 400 application/json

    validation_failed: malformed JSON or an invalid field

    Hide response attributes Show response attributes object
    • error string
    • code string

      Machine-readable reason, listed with each response

  • 404 application/json

    order_not_found

    Hide response attributes Show response attributes object
    • error string
    • code string

      Machine-readable reason, listed with each response

  • 409 application/json

    order_cancelled; label_exists_in_other_format (cancel the label first to print it in another format); label_printing_disabled (the Packeta packet was created, but printing is turned off in the Packeta installation)

    Hide response attributes Show response attributes object
    • error string
    • code string

      Machine-readable reason, listed with each response

  • 422 application/json

    carrier_not_resolved, carrier_not_installed, carrier_not_configured, marketplace_delivery, missing_sender_address, label_format_not_supported

    Hide response attributes Show response attributes object
    • error string
    • code string

      Machine-readable reason, listed with each response

  • 502 application/json

    carrier_error: the carrier refused the shipment; error carries its reason

    Hide response attributes Show response attributes object
    • error string
    • code string

      Machine-readable reason, listed with each response

POST /labels/order/{orderId}
curl \
 --request POST 'api.services.omnicado.com/api/v2/labels/order/1843311' \
 --header "X-OMNICADO-TOKEN: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{
  "carrier": "packeta",
  "parcelCount": 2,
  "labelFormat": "pdf"
}'
Request examples
{
  "carrier": "packeta",
  "parcelCount": 2,
  "labelFormat": "pdf"
}
Response examples (200)
{
  "orderId": 1843311,
  "reference": "ESHOP-2026-004211",
  "carrier": "packeta",
  "labelFormat": "pdf",
  "trackingNumbers": [
    "Z1234567890"
  ],
  "trackingUrl": "https://tracking.packeta.com/cs/?id=Z1234567890",
  "cancelled": false,
  "label": {
    "contentType": "application/pdf",
    "content": "JVBERi0xLjQK..."
  }
}
Response examples (202)
{
  "error": "Carrier ppl is not installed on this account",
  "code": "carrier_not_installed"
}
Response examples (400)
{
  "error": "Carrier ppl is not installed on this account",
  "code": "carrier_not_installed"
}
Response examples (404)
{
  "error": "Carrier ppl is not installed on this account",
  "code": "carrier_not_installed"
}
Response examples (409)
{
  "error": "Carrier ppl is not installed on this account",
  "code": "carrier_not_installed"
}
Response examples (422)
{
  "error": "Carrier ppl is not installed on this account",
  "code": "carrier_not_installed"
}
Response examples (502)
{
  "error": "Carrier ppl is not installed on this account",
  "code": "carrier_not_installed"
}