Print a label for a parcel outside Omnicado

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/custom

Prints a label for a parcel that is not an order in Omnicado, with a carrier installed on the account (customLabels: true in /labels/carriers: Packeta, GLS, PPL, DPD).

reference identifies the parcel. Sending the same reference again returns the label already printed (200) and never registers a second parcel with the carrier, so a timed-out request can be safely retried.

The parcel ships from the expedition address of a selling channel: Packeta uses the channel's Packeta sender label, GLS and PPL its primary expedition address, DPD the DSW set for the channel in the DPD installation. PPL picks the product the expedition would: Smart for a pickup point, Connect outside the Czech Republic, Business otherwise, each in its cash-on-delivery variant when cashOnDelivery is sent.

application/json

Body Required

  • reference string Required

    Your id of the parcel, unique within the account. Repeating it returns the label already printed instead of a new parcel.

    Format should match the following pattern: ^[A-Za-z0-9._-]{1,64}$.

  • carrier string Required

    A carrier with customLabels: true in /labels/carriers

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

  • labelFormat string

    Defaults to the account's label format

    Values are pdf or zpl.

  • sender object | null
    Hide sender attribute Show sender attribute object | null
    • sellingChannelId integer | null

      Selling channel whose expedition address the parcel ships from. Defaults to the first channel of the account with an expedition address.

  • recipient object Required
    Hide recipient attributes Show recipient attributes object
    • name string Required
    • companyName string | null
    • street string Required

      Street with the house number

    • city string Required
    • zip string Required
    • countryCode string Required

      ISO 3166-1 alpha-2

    • phone string | null

      Packeta needs a phone or an e-mail

    • email string | null
  • pickupPointId string | null

    The carrier's pickup point (Packeta point, PPL ParcelShop, DPD Pickup). Without it the parcel is delivered to the address. Not available for GLS.

  • cashOnDelivery object

    Leave out when there is no cash on delivery

    Hide cashOnDelivery attributes Show cashOnDelivery attributes object
    • amount string Required

      Decimal amount; a number is accepted too

    • currency string Required

      ISO currency code

    • variableSymbol string | null
  • declaredValue object

    Parcel value. Required for Packeta unless cashOnDelivery is sent.

    Hide declaredValue attributes Show declaredValue attributes object
    • amount string Required

      Decimal amount; a number is accepted too

    • currency string Required

      ISO currency code

  • parcels array[object] Required

    Packeta carries one parcel per packet; send one request per parcel.

    At least 1 but not more than 20 elements.

    Hide parcels attribute Show parcels attribute object
    • weightKg number Required

      Minimum value is 0.

  • note string | null

Responses

  • 201 application/json

    Label printed

    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

  • 200 application/json

    A label with this reference was printed before; it is returned again

    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

  • 400 application/json

    validation_failed

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

      Machine-readable reason, listed with each response

  • 409 application/json

    label_in_progress (another request with the same reference is still printing); label_cancelled (the reference belongs to a cancelled label, use a new one)

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

      Machine-readable reason, listed with each response

  • 422 application/json

    carrier_not_supported, carrier_not_installed, carrier_not_configured, sender_not_found, missing_sender_address, label_format_not_supported, invalid_shipment (the carrier cannot ship the parcel as sent; error says what to change)

    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 parcel; error carries its reason

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

      Machine-readable reason, listed with each response

POST /labels/custom
curl \
 --request POST 'api.services.omnicado.com/api/v2/labels/custom' \
 --header "X-OMNICADO-TOKEN: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{
  "reference": "ESHOP-2026-004211",
  "carrier": "packeta",
  "labelFormat": "pdf",
  "sender": {
    "sellingChannelId": 812
  },
  "recipient": {
    "name": "Jana Nováková",
    "companyName": "string",
    "street": "Křižíkova 12",
    "city": "Praha",
    "zip": "18600",
    "countryCode": "CZ",
    "phone": "+420777123456",
    "email": "jana@example.cz"
  },
  "pickupPointId": "string",
  "cashOnDelivery": {
    "amount": "1290.00",
    "currency": "CZK",
    "variableSymbol": "4211"
  },
  "declaredValue": {
    "amount": "1290.00",
    "currency": "CZK"
  },
  "parcels": [
    {
      "weightKg": 1.2
    }
  ],
  "note": "Ring twice"
}'
Request examples
{
  "reference": "ESHOP-2026-004211",
  "carrier": "packeta",
  "labelFormat": "pdf",
  "sender": {
    "sellingChannelId": 812
  },
  "recipient": {
    "name": "Jana Nováková",
    "companyName": "string",
    "street": "Křižíkova 12",
    "city": "Praha",
    "zip": "18600",
    "countryCode": "CZ",
    "phone": "+420777123456",
    "email": "jana@example.cz"
  },
  "pickupPointId": "string",
  "cashOnDelivery": {
    "amount": "1290.00",
    "currency": "CZK",
    "variableSymbol": "4211"
  },
  "declaredValue": {
    "amount": "1290.00",
    "currency": "CZK"
  },
  "parcels": [
    {
      "weightKg": 1.2
    }
  ],
  "note": "Ring twice"
}
Response examples (201)
{
  "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 (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 (400)
{
  "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"
}