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​

Header Parameters

    ApiView string

    View name from the PIM's view Dictionary. ✔If the ApiView parameter is not passed- data is returned according to default View defined for access group.

Body

required
    oneOf
    action stringrequired

    Possible values: [listProduct]

    sku string

Responses​

success

Schema
    oneOf
    status stringrequired

    The status of the API request. A value of "OK" indicates that the request was successfully sent and processed

    sku stringrequired
    data objectrequired
    attributes objectrequired

    Detailed information about the product, its variants, their corresponding attributes, and values

    sku string

    Unique product code or number.

    categories string[]

    Collection of categories that the product is assigned to.

    Presented the relative path of the category that is calculated and uses '>' as a separator for the category name.

    status string

    Status of the product. Can only take the following values: active, inactive, deleted.

    thumbnail string

    Link to internal or external image asset in the form of a url.

    title string

    Short description of the product.

    price string

    Presented as a recommended attribute

    rod_diameter string

    It can be any attribute from your Pims system. The attribute 'rod_diameter' is provided here as an example for the variation SKU.

    variation_attributes string[]

    Collection of attributes for the current product and the SKUs in the variation_skus collection. The values of these attribute data are set as variations of the product.

    variation_of string

    Collection of sku's that are variations of the current product. This field value is automatically maintained by the PIMS.

    variation_skus string[]

    List of sku's that are variations of the current product. This field value is automatically maintained by the PIMS.

    variation_matrix object

    A JSON object in which the variation SKUs act as keys, and their attribute-value pairs act as values. It represents dynamic data that can vary depending on the product and its variations.

    The following JSON schema is provided as an example only, where:

    Part-number01, Part-number02- are the variation SKU keys.

    rod_diameter- is an attribute of the variation SKUs, which can be any attribute from your Pims system. The attribute 'rod_diameter' is provided here as an example.

    Part-number01 object
    rod_diameter string[]
    Part-number02 object
    rod_diameter string[]
    Part-number00 object
    rod_diameter string[]
    definition objectrequired

    Complete information about the structure of each attribute in the PIMs system.

    status object
    type stringrequired
    collection string
    isUnique string
    label objectrequired
    en-us stringrequired
    validation string
    isSearchable string
    isIndexable string
    isFilterable string
    group string
    comment objectrequired
    en-us stringrequired
    variation_skus object
    isUnique string
    dictionaryIsStatic string
    comment objectrequired
    en-us stringrequired
    value string
    collection string
    isIndexable string
    label objectrequired
    en-us stringrequired
    validation string
    group string
    type stringrequired
    isSearchable string
    isSimpleType string
    isFilterable string
    variation_attributes object
    isSearchable string
    group string
    type stringrequired
    label objectrequired
    en-us stringrequired
    isIndexable string
    validation string
    isFilterable string
    isSimpleType string
    value string
    comment objectrequired
    en-us stringrequired
    dictionaryIsStatic string
    isUnique string
    collection string
    variation_of object
    isSimpleType string
    isFilterable string
    type stringrequired
    group string
    validation string
    label objectrequired
    en-us stringrequired
    isIndexable string
    isSearchable string
    collection string
    dictionaryIsStatic string
    isUnique string
    value string
    comment objectrequired
    en-us stringrequired
    sku object
    isFilterable string
    collection string
    isSearchable string
    comment objectrequired
    en-us stringrequired
    group string
    type stringrequired
    label objectrequired
    en-us stringrequired
    isIndexable string
    isUnique string
    validation string
    rod_diameter object
    collection string
    isFilterable string
    type stringrequired
    isIndexable string
    isUnique string
    isSimpleType string
    group string
    label objectrequired
    en-us stringrequired
    dictionary object
    visible integer[]
    sortingMethod string
    columns string[]
    validation undefined[]
    sorting undefined[]
    unique integer[]
    data string[]
    validation string
    value string
    isSearchable string
    comment objectrequired
    en-us stringrequired
    dictionaryIsStatic string
    price object
    value string
    label objectrequired
    en-us stringrequired
    comment objectrequired
    en-us stringrequired
    collection string
    group string
    isFilterable string
    isSimpleType string
    validation string
    isIndexable string
    isUnique string
    type stringrequired
    isSearchable string
    dictionaryIsStatic string
    title object
    isFilterable string
    group string
    collection string
    label objectrequired
    en-us stringrequired
    comment objectrequired
    en-us stringrequired
    isIndexable string
    isUnique string
    validation string
    isSearchable string
    type stringrequired
    categories object
    type stringrequired
    collection string
    label objectrequired
    en-us stringrequired
    isUnique string
    isFilterable string
    isSearchable string
    isIndexable string
    validation string
    group string
    comment objectrequired
    en-us stringrequired
    thumbnail object
    comment objectrequired
    en-us stringrequired
    group string
    collection string
    type stringrequired
    isSearchable string
    isFilterable string
    isIndexable string
    validation string
    label objectrequired
    en-us stringrequired
    isUnique string
Loading...