Skip to main content

PIMS Product Management API

POST 
/pim/manage/products

This API provides a powerful tool for managing your products. You can add and edit product information at the attribute level, as well as retrieve information about all Product Attributes in the PIMS system and their values for a specific product.

To use this API, send a POST request body JSON. ✔The description of JSON keys is provided in the Example Value and Schema.

Set the action key in the JSON body to one of the following values:

  • listProduct: Retrieve information about a product.
  • listProductsBySku: Retrieve a list of products with specified SKUs.
  • getList: Retrieve a list of products in the PIMS system. ✔To manage the output of products list, use the params block, the description of which can be found in the Schema for JSON requests section.
  • editProduct: Modify an existing product's details
  • createProduct: Add a new product to the PIMS
  • historyProduct: Retrieve the history of product attribute changes in the PIMS system.

Delete Product: In PIMS, products are not permanently deleted. Instead, they are marked as deleted by setting their status attribute to 'deleted'. When using APIs that retrieve lists of products, these deleted products will only be included if the appropriate parameter is specified. This ensures that you can always access and restore these products by changing their status back to any other value. This approach helps maintain a complete history and prevents accidental data loss.

Specify the SKU (unique code or number) of the product for which you want to perform this action as the value of the sku key in the JSON body.
To edit or add product attributes, list the required attributes in the JSON body in the format "attribute name" = "attribute value". When entering attributes, make sure that the attribute value matches its corresponding attribute type. For example, if the attribute type is "dropdown", the attribute value must match one of the values in the "dictionary" attribute. If the name of any attribute is incorrect, it will be ignored.

If the action is successful, the API response contains all Product Attributes in the PIMS system and their values for the specified product in JSON format. The API response also includes a definition section with complete information about the structure of each attribute in the PIMS system.

Please note the following important aspect of edit attribute product:

  • variation_skus read only, set automatically if sku is specified as parent
  • variation_matrix read only, dynamic data: all variations parent sku.

Do not pass read-only parameters as modifiable.

Access to product attributes is set by the added View for the authorization key:

  • all product attributes if the ApiKey has no View
  • if no View is specified in the parameter, the default View applies

Attribute names are set and returned according to the applied View.

Request​

Responses​

success