delete https://{shopdomain}.myshoplaza.com/openapi/2022-01/products//variants/
Requires
write_productaccess scope. More access scope
The Delete Variant API allows users to remove a specific product variant by providing its product_id and variant_id. This endpoint ensures precise management of product data, enabling users to delete unwanted or outdated variants from their product catalog efficiently.This API is especially useful for:
- Remove outdated or incorrect variants to keep the product catalog accurate.
- Simplify inventory management by deleting unused variants.
Request Parameters
Public Request Parameters
Path Parameters
| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
product_id | string | Yes | 9fb9f3c6-2300-42c1-8593-d9008d7cfc09 | The unique identifier for the product. |
variant_id | string | Yes | 1b735278-62c7-41ad-9976-b1b63a90590d | The unique identifier for the variant. |
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 |
|---|---|---|---|
errors | Array | [ "Product not found"] | A list of errors encountered during the request processing. |
| Field | Type | Example | Description |
|---|---|---|---|
error | Array | "store is not active" | Indicates an error encountered during the process. |
Error Details
| 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 | Product Not Found | The product ID provided in the request does not exist. | { "errors": ["Product not found"] } |
Invalid or empty product_id | missing required product_id or product_id with incorrect UUID types | { "errors": ["Invalid uuid"] } |