Horeca24 Partner API › Orders

Cancel an order

POSThttps://management.horeca-24.de/api/partner/v1/orders/{externalId}/cancel

Approved at once in v1; the till shows the order as cancelled (the reason is not shown there). You also receive order.cancelled with reason.code: PARTNER_REQUESTED. An order cancelled already answers 200 again, so retries are safe. 409 INVALID_TRANSITION for a completed or rejected order.

Headers

AuthorizationstringRequired

Bearer pk_<connectionId>.<keyId>.<secret>

The connection's API key, from the restaurant's till. Treat it as one opaque string. 401 UNAUTHORIZED for a missing, wrong, expired or revoked key; 403 CONNECTION_REVOKED for the key of a deleted connection. After a rotation by the restaurant, the previous key keeps working for 24 hours.

Path parameters

externalIdstringRequiredpattern: ^[A-Za-z0-9._~-]{1,64}$

Your order id, as sent in POST /orders.

Request

application/jsonRequired

reasonstringRequired1-500 chars

Response

200Cancelled, also when it was cancelled already

externalIdstringRequiredpattern: ^[A-Za-z0-9._~-]{1,64}$

Your order id, unique per connection

statusstringRequiredValue: cancelled

versionintegerRequired≥ 1

Errors

objectErrorBody

400

An error; see ErrorCode

401

UNAUTHORIZED: the key is missing, malformed, unknown, wrong, expired or revoked

403

CONNECTION_REVOKED: the restaurant deleted the connection; stop sending

404

An error; see ErrorCode

409

An error; see ErrorCode

422

An error; see ErrorCode

429

RATE_LIMITED: 60 per minute and connection, shared by orders, cancel and delivery

Headers

Retry-AfterintegerOptional

Seconds until the window ends

POST/orders/{externalId}/cancel

cURL

curl -X POST https://management.horeca-24.de/api/partner/v1/orders/A/cancel \
  -H "Authorization: Bearer $PARTNER_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "reason": "Customer cancelled"
}'

Python

import os
import requests

url = "https://management.horeca-24.de/api/partner/v1/orders/A/cancel"

headers = {
    "Authorization": "Bearer " + os.environ["PARTNER_API_KEY"],
}

payload = {
    "reason": "Customer cancelled",
}

response = requests.post(url, headers=headers, json=payload)

print(response.status_code)
print(response.text)

JavaScript

const response = await fetch("https://management.horeca-24.de/api/partner/v1/orders/A/cancel", {
  method: "POST",
  headers: {
    "Authorization": "Bearer " + process.env.PARTNER_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "reason": "Customer cancelled"
  }),
});

const data = await response.text();
console.log(response.status, data);

PHP

<?php
$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://management.horeca-24.de/api/partner/v1/orders/A/cancel',
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('PARTNER_API_KEY'),
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode([
        'reason' => 'Customer cancelled',
    ]),
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;

Try it

Sends a real request to https://management.horeca-24.de/api/partner/v1

ServerAuthorizationNever stored, never sent to us.externalIdBody

Response

200

200Cancelled, also when it was cancelled already

{
  "externalId": "A-1001",
  "status": "cancelled",
  "version": 3
}

400

400An error; see ErrorCode

{
  "error": {
    "code": "INVALID_AMOUNTS",
    "message": "itemsSubtotal must be 2700",
    "path": "amounts.itemsSubtotal",
    "requestId": "6b1f2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d"
  }
}

401

401UNAUTHORIZED: the key is missing, malformed, unknown, wrong, expired or revoked

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "string",
    "path": "string",
    "details": null,
    "requestId": "string"
  }
}

403

403CONNECTION_REVOKED: the restaurant deleted the connection; stop sending

{
  "error": {
    "code": "CONNECTION_REVOKED",
    "message": "string",
    "path": "string",
    "details": null,
    "requestId": "string"
  }
}

404

404An error; see ErrorCode

{
  "error": {
    "code": "INVALID_AMOUNTS",
    "message": "itemsSubtotal must be 2700",
    "path": "amounts.itemsSubtotal",
    "requestId": "6b1f2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d"
  }
}

409

409An error; see ErrorCode

{
  "error": {
    "code": "INVALID_AMOUNTS",
    "message": "itemsSubtotal must be 2700",
    "path": "amounts.itemsSubtotal",
    "requestId": "6b1f2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d"
  }
}

422

422An error; see ErrorCode

{
  "error": {
    "code": "INVALID_AMOUNTS",
    "message": "itemsSubtotal must be 2700",
    "path": "amounts.itemsSubtotal",
    "requestId": "6b1f2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d"
  }
}

429

429RATE_LIMITED: 60 per minute and connection, shared by orders, cancel and delivery

{
  "error": {
    "code": "RATE_LIMITED",
    "message": "string",
    "path": "string",
    "details": null,
    "requestId": "string"
  }
}