delete
https://{subdomain}.myshoplaza.com/openapi/2025-06/orders/post_sales/
Allows you to remove a specific post-sales order record (e.g., a return or exchange request) by its unique identifier.
Requireswrite_orderaccess scope. More access scope
The Delete Post Sale Order API allows developers remove a specific post-sale order record from the system.
This API is especially useful for:
- Cleaning up cancelled post-sale requests
- Removing duplicate or erroneous post-sale records
- Maintaining data hygiene in returns/refunds systems
Request Parameters
Public Request Parameters
Path Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
post_sale_id | string | Yes | ID of the post-sale order to delete | "ps_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 |