delete https://{shopdomain}.myshoplaza.com/openapi/2022-01/orders/post_sales/
Requires
write_orderaccess scope. More access scope
The Delete Post Sale Order API allows you to remove a specific post-sales order record (e.g., a return or exchange request) by its unique identifier.
This API is especially useful for:
- Canceling or discarding after-sales requests that are no longer needed.
- Maintaining a clean post-sales list by removing invalid or duplicate records.
- Automating after-sales order management in external applications.
Request Parameters
Public Request Parameters
Path Parameter
| Name | Type | Required | Desc | Example |
|---|---|---|---|---|
post_sale_id | string | Yes | The ID of the post-sales order to delete, for example: "fb07fad3-bf03-48b5-98a8-152d20c5181d". | "fb07fad3-bf03-48b5-98a8-152d20c5181d" |
Response Explanation
Public Response Parameters
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 |
|---|---|---|---|
error | String | "store is not active" | 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 | |
| 406 | Operation not allowed in current state | "Operation not allowed in current state" |