Query parameters

• sku string Required

  The Stock Keeping Unit (SKU) of the product.

Responses

• 200 application/json

  Successfully deleted products in catalog.

  Hide headers attributes Show headers attributes

  • X-RateLimit-Limit number

    The number of allowed requests in the current period.

  • X-RateLimit-Remaining number

    The number of remaining requests in the current period.

  • X-RateLimit-Retry-After string(datetime)

    The date of number of remaining requests will reset.

  Hide response attributes Show response attributes object

  • token string(uuid) Required

    A unique token that identifies the product.

  • external_id null | string Required

    An external identifier for the product, typically used for mapping with external systems.

  • sku null | string Required

    Stock Keeping Unit (SKU).

  • quantity integer Required

    The available stock quantity for the variant.

    Minimum value is 0, maximum value is 1000000.

  • is_simple boolean Required

    Indicates whether the product is a simple product (true) or has variants (false).

  • status string Required

    The current status of the product.

    Values are Active, Inactive, Disabled, Preorder, Available, Draft, Pending, Private, Publish, or Archive.

  • title string Required

    The name or title of the product.

  • images array[string(url)] Required

    A list of image URLs representing the product.

  • attributes array[object] Required

    A list of key-value pairs representing attributes.

    Hide attributes attributes Show attributes attributes object

    • name string Required

      The name of the attribute (e.g., material, size, color).

    • value string Required

      The value of the attribute corresponding to its name (e.g., cotton, red, large).

  • update_date string(date-time) Required

    The date and time when the product was last updated, in ISO 8601 format.

  • variants array[object] Required

    A list of product variants.

    Hide variants attributes Show variants attributes object

    • token string(uuid) Required

      A unique token identifying the product variant.

    • sku null | string Required

      Stock Keeping Unit (SKU).

    • barcode null | string Required

      The unique barcode for the variant, such as UPC or EAN.

    • price number Required

      The price of the variant in the specified currency.

      Minimum value is 0, maximum value is 1000000.0.

    • quantity integer Required

      The available stock quantity for the variant.

      Minimum value is 0, maximum value is 1000000.

    • images array[string(url)] Required

      A list of image URLs representing the product variant.

    • options array[object] Required

      A list of options specifying attributes of the variant (e.g., size, color).

      Hide options attributes Show options attributes object

      • name string Required

        The name of the option.

      • value string Required

        The value of the option.

    • attributes array[object] Required

      A list of key-value pairs representing attributes.

      Hide attributes attributes Show attributes attributes object

      • name string Required

        The name of the attribute (e.g., material, size, color).

      • value string Required

        The value of the attribute corresponding to its name (e.g., cotton, red, large).

    • weight null | number Required

      The weight of the product variant.

      Minimum value is 0.

    • weight_unit null | string Required

      The unit of measurement for the weight.

      Values are GRAMS, KILOGRAMS, OUNCES, POUNDS, or TONNES.

    • height null | number Required

      The height of the product variant.

      Minimum value is 0.

    • depth null | number Required

      The depth of the product variant.

      Minimum value is 0.

    • width null | number Required

      The width of the product variant.

      Minimum value is 0.

    • dimension_unit null | string Required

      The unit of measurement for dimensions (height, width, depth).

      Values are MILLILITERS, CENTILITERS, DECIMETERS, METERS, INCHES, YARD, or FEET.

    • update_date string(date-time) Required

      The date and time when the variant was last updated, in ISO 8601 format.

• 400 application/json

  Bad request

  Hide headers attributes Show headers attributes

  • X-RateLimit-Limit number

    The number of allowed requests in the current period.

  • X-RateLimit-Remaining number

    The number of remaining requests in the current period.

  • X-RateLimit-Retry-After string(datetime)

    The date of number of remaining requests will reset.

  Hide response attributes Show response attributes object

  • code string Required

    An error code that identifies the type of error that occurred.

  • message string Required

    A message that describes the error condition in a human-readable form.

  • data object | array Required

    Additional information that can help the caller understand or fix the issue.

• 404 application/json

  Not found

  Hide response attributes Show response attributes object

  • code string Required

    An error code that identifies the type of error that occurred.

  • message string Required

    A message that describes the error condition in a human-readable form.

  • data object | array Required

    Additional information that can help the caller understand or fix the issue.

• 401 application/json

  Unauthorized

  Hide response attributes Show response attributes object

  • code string Required

    An error code that identifies the type of error that occurred.

  • message string Required

    A message that describes the error condition in a human-readable form.

  • data object | array Required

    Additional information that can help the caller understand or fix the issue.

• 429 application/json

  Too many requests

  Hide headers attributes Show headers attributes

  • X-RateLimit-Limit number

    The number of allowed requests in the current period.

  • X-RateLimit-Remaining number

    The number of remaining requests in the current period.

  • X-RateLimit-Retry-After string(datetime)

    The date of number of remaining requests will reset.

  Hide response attributes Show response attributes object

  • code string Required

    An error code that identifies the type of error that occurred.

  • message string Required

    A message that describes the error condition in a human-readable form.

  • data object | array Required

    Additional information that can help the caller understand or fix the issue.

• 500 application/json

  Internal server error

  Hide response attributes Show response attributes object

  • code string Required

    An error code that identifies the type of error that occurred.

  • message string Required

    A message that describes the error condition in a human-readable form.

  • data object | array Required

    Additional information that can help the caller understand or fix the issue.