PUT /api/v2/alias_products/:id
Update an alias product

Supported Formats

json

Errors

Code Description
401 Unauthorized. Include a WWW-Authenticate header field containing a challenge applicable to the requested resource.
403 Forbidden. The request was a valid request, but the server is refusing to respond to it. 403 error semantically means "unauthorized", i.e. the user does not have the necessary permissions for the resource.
404 Not Found. The requested resource could not be found.
422 Unprocessable Entity. The request was well-formed but was unable to be followed due to semantic errors.
500 Internal Server Error. An unexpected condition was encountered.

Examples

request:
  Same as product create

response: 
  Same as product create

Params

Param name Description
alias_product
required

Validations:

  • Must be a Hash
alias_product[locale]
optional , nil allowed

Locale for this product. Should be one of the language codes defined on CommerceConnect. Defaults to the default language.

Validations:

  • Must be a String
alias_product[name]
optional , nil allowed

Product or sku name

Validations:

  • Must be a String
alias_product[code]
optional , nil allowed

Unique identifier for product and sku

Validations:

  • Must be a String
alias_product[product_class_name]
optional , nil allowed

Class name that this product is assigned to. This must be created beforehand

Validations:

  • Must be a String
alias_product[status]
optional , nil allowed

Validations:

  • Must be one of: inactive, active.
alias_product[product_attributes]
optional , nil allowed

Validations:

  • Must be a Hash
alias_product[product_attributes][_any_attribute_code_]
optional , nil allowed

The key of attribute is attribute code and value is a valid json type that matches the base type of the attribute

Validations:

  • Must be a String
alias_product[catalogs]
optional , nil allowed

Link these catalogs with the product.

Validations:

  • Must be an Array of nested elements
alias_product[catalogs][id]
optional , nil allowed

Catalog ID

Validations:

  • Must be a Integer
alias_product[catalogs][name]
optional , nil allowed

Catalog name

Validations:

  • Must be a String