Delete Collection

The Delete Collection API allows users to delete a specific collection by providing its unique ID in the path parameter. This operation is irreversible and will remove the collection and its associated metadata from the system.

Use Cases:

  1. Remove outdated or irrelevant collections.
  2. Manage and clean up collections for better organization.
  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 collection 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"["No Context"] }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
idstringYesa60fe556-43ad-4e07-9125-507ac1bf71f7Unique identifier of the collection.

Response Explanation

Success Response

FieldTypeExampleDescription
empty_objectobject{}Indicates the collection was successfully deleted.

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[ "Collection 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}.myshoplazza.com/openapi/2022-01/collections/{id} \
     --header 'accept: application/json' \
     --header 'access-token: {your-access-token}'
    

Success Response Example

{}

Error Response Example

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

Error Details

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
422Collection Not FoundThe Collection ID provided in the request does not exist.{ "errors": ["Collection not found"] }
Invalid or empty collection_idmissing required collection_id or collection_id with incorrect UUID types{ "errors": [ "collection_id has an invalid UUID"]}
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!