Delete a product

DELETE

/products/{id}

Soft-deletes the product.

• 422 UNPROCESSABLE: it is a gift card product.
• 409 CONFLICT: it is used as a composite component.
• 409 CONFLICT: it has active variant children.
• 404 NOT_FOUND: the id is foreign, unknown, or already deleted.

Requires scope: catalog:write

Authorizations

• apiKey
• oauth2
  catalog:write

Responses

204

Delete a product

Media typeapplication/json

No content.

object

Example^generated

{}

default

An error response.

Media typeapplication/json

object

error

required

object

code

required

A machine-readable error code, e.g. VALIDATION_FAILED.

string

Allowed values: UNAUTHORIZED PLAN_REQUIRED INSUFFICIENT_SCOPE NOT_FOUND VALIDATION_FAILED CONFLICT STALE_VERSION RATE_LIMITED IDEMPOTENCY_KEY_REUSED IDEMPOTENCY_IN_PROGRESS IMAGE_FETCH_FAILED UNPROCESSABLE INTERNAL RETAILER_CANCELLED RETAILER_SUSPENDED RETAILER_NOT_FOUND TRIAL_DECISION_REQUIRED PLAN_USERS_EXCEEDED RETAILER_PAUSED PRODUCT_LIMIT_REACHED NOT_STOCK_TRACKED REASON_DIRECTION_MISMATCH REASON_NOT_ALLOWED INSUFFICIENT_STOCK OUTLET_DELETED

fields

Array<object>

object

field

required

string

message

required

string

message

required

A plain-English sentence describing what went wrong.

string

Example

{
  "error": {
    "code": "UNAUTHORIZED"
  }
}