delete
https://{shopdomain}.myshoplaza.com/openapi/2022-01/orders/
Requireswrite_orderaccess scope. More access scope
The Delete Order API allows the deletion of a specific order by its unique ID. Once deleted, the order will no longer be available in the system.
This API is especially useful for:
- Removing test orders during development.
- Deleting canceled or erroneous orders.
- Managing order data in synchronization with external systems.
Request Parameters
Public Request Parameters
Path Parameters
Path Parameters
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
| id | string | Yes | The unique ID of the order to be deleted. | 1965351157616135991222 |
Response Explanation
Public Response Parameters
Success Response
| HTTP Status Code | Description |
|---|---|
| 200 | The order was successfully deleted. |
Error Response
Error responses in the API can be represented using two different fields: errors and error. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.
| Field | Type | Example | Description |
|---|---|---|---|
errors | Array | [ "file number error"] | A list of errors encountered during the request processing. |
| Field | Type | Example | Description |
|---|---|---|---|
error | String | "Unable to find resource" | Indicates an error encountered during the process |
Error Detail
| Status Code | Message | Possible Reason | Example Response |
|---|---|---|---|
| 400 | Bad Request | Invalid input format or request structure (e.g., missing required fields or incorrect data types). | Bad Request |
| Unauthorized | The request is missing valid authentication credentials or the credentials provided are invalid. | Unauthorized | |
| 404 | Not Found | Order's id is empty or not found. | "Unable to find resource" |