Delete Variant

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:

  1. Remove outdated or incorrect variants to keep the product catalog accurate.
  2. Simplify inventory management by deleting unused variants.
  3. Verifying shop details through its unique domain prefix (shopdomain).

Example: If the shop’s domain is https://store123.myshoplazza.com, the shopdomain would be store123.

🔒

Requires product access scope. For more info , refer to:

access scope

Public Request Parameters

Parameter NameTypeRequiredParameter LocationParameter ValueDescription
Access-TokenStringYesHeaderBx-_5aV
eXNwl-4AB98s5xLV
yg0fNzGf

MuTpqtlBA
Used to authenticate API requests. Obtain an access token from the Access Token Guide.
Pass it in the Authorization header for every request.
Content-TypeStringYesHeaderapplication
/json
Indicates the media type of the request body. It tells the server how to parse the request and
the client how to interpret the response. For more details, visit Content-Type.

Public Response Parameters

Parameter NameTypeMandatoryParameter LocationExample ValueDescription
errorStringNoResponse Body{ "error": "store is not active" }Indicates an error encountered during the process. This field typically appears when the Access Token is missing or invalid. Example: { "error": "store is not active" }.
errorsArrayNoResponse Body{ "errors"[ "Product not found"] }A list of errors that occurred during the request processing. Example: { "errors": [ "No Context" ] }.
Request-IdStringYesHeaderBx-_5aV
eXNwl-4AB98s5xLV
yg0fNzGf

MuTpqtlBA
A unique identifier for each request. It helps in identifying and debugging specific requests.

Error and Errors Clarification:

Added explanation that the error and errors fields are currently dependent on the API implementation, with plans for future unification.

Request Parameters

Path Parameters

ParameterTypeRequiredExampleDescription
product_idstringYes9fb9f3c6-2300-42c1-8593-d9008d7cfc09The unique identifier for the product.
variant_idstringYes1b735278-62c7-41ad-9976-b1b63a90590dThe unique identifier for the variant.

Response Explanation

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.

FieldTypeExampleDescription
errorsArray[ "Product not found"]A list of errors encountered during the request processing.
FieldTypeExampleDescription
errorArray "store is not active"Indicates an error encountered during the process.

Request Examples

curl --request DELETE \
     --url https://{shopdomain}.myshoplaza.com/openapi/2022-01/products/9fb9f3c6-2300-42c1-8593-d9008d7cfc09/variants/1b735278-62c7-41ad-9976-b1b63a90590d \
     --header 'accept: application/json' \
     --header 'access-token: {token}'

Success Response Example

{}

Error Response Example

{
  "errors": [
     "Product not found"
  ]
}
{
  "error": "store is not active"
}

Error Details

Response Explanation

Product Response Fields

Status CodeMessagePossible ReasonExample Response
400Bad RequestInvalid input format or request structure (e.g., missing required fields or incorrect data types).Bad Request
UnauthorizedThe request is missing valid authentication credentials or the credentials provided are invalid.Unauthorized
404Product Not FoundThe product ID provided in the request does not exist.{ "errors": ["Product not found"] }
Invalid or empty product_idmissing required product_id or product_id with incorrect UUID types{ "errors": ["Invalid uuid"] }
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!