From 1162d51541366148ed09a00287b89da0f6eb01e5 Mon Sep 17 00:00:00 2001 From: Thomas Brinkmann Date: Wed, 1 Jun 2022 20:37:37 +0200 Subject: [PATCH] =?UTF-8?q?=E2=80=9EDELETE=20/order/{orderid}=E2=80=9C=20?= =?UTF-8?q?=C3=A4ndern?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- DELETE-%2Forder%2F%7Borderid%7D.md | 83 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 83 insertions(+) create mode 100644 DELETE-%2Forder%2F%7Borderid%7D.md diff --git a/DELETE-%2Forder%2F%7Borderid%7D.md b/DELETE-%2Forder%2F%7Borderid%7D.md new file mode 100644 index 0000000..6777218 --- /dev/null +++ b/DELETE-%2Forder%2F%7Borderid%7D.md @@ -0,0 +1,83 @@ +## **DELETE /order/{orderid}** + + +## **Inhalt** +--- +- Parameter +- Optionale Parameter +- Beispiel Anfrage +- Beispiel Antwort +- Mögliche Fehlermeldungen +--- + +### Parameter + +|URL Parameter | Typ | Beschreibung| +|----------|-----|-------------| +|orderid | integer | Die ID der Bestellung die man stornieren möchte + +|Body Parameter | Typ | Beschreibung| +|----------|-----|-------------| +| - | - | - | + + +--- + +### Optionale Parameter + +|Query-String Parameter | Typ | Beschreibung| +|----------|-----|-------------| +|- | - | - + + +--- + +### Beispiel Anfrage + +##### PHP +```php + 'control.local/api/v2/order/1', + CURLOPT_CUSTOMREQUEST => 'DELETE', + CURLOPT_HTTPHEADER => array( + 'X-TOKEN: test-token', + 'Content-Type: application/json' + ), +)); + +$response = curl_exec($curl); + +curl_close($curl); +echo $response; +``` + +##### cURL +```bash +curl --location --request DELETE 'control.local/api/v2/order/1' \ +--header 'X-TOKEN: test-token' \ +--header 'Content-Type: application/json' +``` + +--- + +### Beispiel Antwort + +```json +{ + "status": "OK", +} +``` + +### Mögliche Fehlermeldungen + +> :warning: Status Code **403** - Permission denied + +> :warning: Status Code **400** - The Order is already paid and cannot be cancelled by the api anymore. + +> :warning: Status Code **404** - No order with ID {orderId} found! + +> :warning: Status Code **500** - Order could not be cancelled \ No newline at end of file