Cancel the label of 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
DELETE /labels/order/{orderId}

Removes the label and the tracking from the order. The shipment is cancelled with the carrier for PPL, GLS, TopTrans, DPD SK, SPS, Alza and Allegro. For Packeta, DPD, WeDo and One by Allegro only the stored label is removed and the parcel stays registered with the carrier; cancel it in the carrier's administration.

Path parameters

  • orderId integer Required

    Omnicado order id

Responses

  • 200 application/json

    Label cancelled

    Hide response attributes Show response attributes object
    • orderId integer
    • cancelled boolean
  • 404 application/json

    order_not_found, or label_not_found when there is no label to cancel

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

      Machine-readable reason, listed with each response

  • 409 application/json

    already_departed: the Alza shipment has already left

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

      Machine-readable reason, listed with each response

  • 502 application/json

    carrier_error

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

      Machine-readable reason, listed with each response

DELETE /labels/order/{orderId}
curl \
 --request DELETE 'api.services.omnicado.com/api/v2/labels/order/1843311' \
 --header "X-OMNICADO-TOKEN: $API_KEY"
Response examples (200)
{
  "orderId": 1843311,
  "cancelled": true
}
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 (502)
{
  "error": "Carrier ppl is not installed on this account",
  "code": "carrier_not_installed"
}