delete
https://{shopdomain}.myshoplaza.com/openapi/2022-01/metafield_definition/
Deletes a specific metafield definition by its unique ID.
This API is especially useful for:
- Removing outdated or unnecessary metafield definitions.
- Cleaning up unused metafield definitions for better resource organization.
- Ensuring only relevant metadata definitions remain active.
Note: The operation is scoped to a specific shop, identified by its unique domain prefix (shopdomain), ensuring all deletions are applied to the correct store.
Request Parameters
Public Request Parameters
Path Parameters
| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
id | string | Yes | 374034306256875562 | Unique ID of the metafield definition. |
Response Explanation
Public Response Parameters
Successful Response
| Status Code | Description | Example Response |
|---|---|---|
200 OK | Address deleted successfully. | {} |
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 | ["Id is required"] | A list of errors encountered during the request processing. |
| 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 | |
| 500 | Id is not found | Metafield definition id id not found | invalid value, should be pointer to struct or slice |