delete
https://{subdomain}.myshoplaza.com/openapi/2025-06/orders/
Allows the deletion of a specific order by its unique ID.
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
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
order_id | string | Yes | Unique order identifier | "order_12345" |
Response Explanation
Public Response Parameters
Successful Response
| Parameter | Type | Example | Description |
|---|---|---|---|
code | string | "success" | Status code of the API response |
message | string | "Order retrieved successfully" | Descriptive message about the response |
data | object | - | Complete order object containing all details |
Error Response
| Field | Type | Example | Description |
|---|---|---|---|
code | string | InvalidParameter | Error http message |
message | string | `` | Error message |