PIMS Attributes Management API

POST 
/pim/manage/attributes

• Requires Data Manager ApiKey permissions.
• Example URI: https://instancename.piminto.com/api/en-us/pim/manage/attributes

A Product Attribute in the Product Information Management System (PIM) refers to the specific characteristics or details that define a product.

Well-defined attributes provide structured data to various data endpoints and websites, enhancing their usability across multiple channels, including eCommerce.

To utilize this API, send a POST request with a JSON body. Set the action key in the JSON body to one of the following values:

• listAttributeGroups: Get list of all Attribute Groups
• listAttributes: Get all attributes
• addAttribute: Add Attribute
• editAttribute: Edit Attribute
• deleteAttribute: Delete Attribute

Use Example Value and Schema for Json requests

Request

application/json

Body

required

oneOf
Get list all Attributes/Groups
action stringrequired
Possible values: [listAttributeGroups, listAttributes]
Add/Edit Attribute
action stringrequired
Possible values: [addAttribute, editAttribute]
name stringrequired
definition objectrequired
type stringrequired
Possible values: [boolean, completeness, date, dropdown, html, media, number, relation, string, text, url]
isIndexable string
Possible values: [y, n]
isSearchable string
Possible values: [y, n]
isFilterable string
Possible values: [y, n]
isUnique string
Possible values: [y, n]
collection string
Possible values: [y, n]
validation string
format string
label objectrequired
en-us stringrequired
comment object
en-us string
group string
Delete Attribute
action stringrequired
Possible values: [deleteAttribute]
name stringrequired

Responses

200

success

application/json

Schema

Schema

oneOf

Get list of all Attribute Groups

status stringrequired

data string[]required

Name Attribute Groups

Get all Attributes

data object[]required

Collection objects Attribute

Array [

name stringrequired

definition objectrequired

type stringrequired

Possible values: [boolean, completeness, date, dropdown, html, media, number, relation, string, text, url]

isIndexable string

Possible values: [y, n]

isSearchable string

Possible values: [y, n]

isFilterable string

Possible values: [y, n]

isUnique string

Possible values: [y, n]

collection string

Possible values: [y, n]

validation string

format string

label objectrequired

en-us stringrequired

comment object

en-us string

group string

]

status stringrequired

Default value: OK

Add/Edit Attribute

status stringrequired

data objectrequired

name stringrequired

definition objectrequired

type stringrequired

Possible values: [boolean, completeness, date, dropdown, html, media, number, relation, string, text, url]

isIndexable string

Possible values: [y, n]

isSearchable string

Possible values: [y, n]

isFilterable string

Possible values: [y, n]

isUnique string

Possible values: [y, n]

collection string

Possible values: [y, n]

validation string

format string

label objectrequired

en-us stringrequired

comment object

en-us string

group string

Delete Attribute

data objectrequired

name string

status stringrequired

Default value: OK

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

status_message string

Provides additional information about the API execution result, if available.

Example (from schema)

{}

Get list of all Attribute Groups

{
  "status": "Ok",
  "data": [
    "Basic",
    "Additional",
    "Sales and Logistics"
  ]
}

Get all Attributes

{
  "data": [
    {
      "definition": {
        "type": "text",
        "isIndexable": "n",
        "isSearchable": "y",
        "isFilterable": "n",
        "isUnique": "n",
        "collection": "n",
        "validation": null,
        "label": {
          "en-us": "nameattribute"
        },
        "comment": {
          "en-us": "name attribute for product card"
        },
        "group": "GroupName"
      },
      "name": "nameattribute"
    }
  ],
  "status": "OK"
}

Add/Edit Attribute

{
  "status": "OK",
  "data": {
    "name": "nameattribute",
    "definition": {
      "type": "text",
      "isIndexable": "n",
      "isSearchable": "y",
      "isFilterable": "n",
      "isUnique": "n",
      "collection": "n",
      "validation": null,
      "format": null,
      "label": {
        "en-us": "nameattribute"
      },
      "comment": {
        "en-us": "name attribute for product card"
      },
      "group": "GroupName"
    }
  }
}

Delete Attribute

{
  "data": {
    "name": "nameattribute"
  },
  "status": "OK",
  "status_message": ""
}

default

If there is an error with the API request, additional information will be provided in the response body.

Examples of error messages include:

• listAttributeGroups, listAttributes: if the attributes are not found in PIMS:

"status_message": "PIM Configuration is incomplete!"

• addAttribute:

"status_message": "Attribute with such name exists."

• editAttribute, deleteAttribute:

"status_message": "Attribute type can not be modified!"

application/json

Schema

Schema

status stringrequired

Possible values: [Error]

The status of the API request. A value of "Error" indicates that the request was not successfully sent or processed.

status_message stringrequired

Provides a message that describes the reason for the error that occurred while processing the API request.

Example (from schema)

{
  "status": "Error",
  "status_message": "string"
}

Loading...