Bulk resource attribute values by resource lookup key

POST 
/:resourceType/:lookupKey/:lookupValue/attributes

The bulk resource attribute endpoint sets/ deletes resource attributes for a single resource identified by the lookup key. The attribute is identified via the payload by providing either id or name. If both are provided, id will be used to identify the attribute. Below is a summary of all the possible fields in the payload.

Fields

Name	Required
id	yes, if name not provided
name	yes, if id not specified
class	yes, if id not specified
type	yes
value	no, if omitted the attribute value will be deleted for the resource (set to default)

A successful response contains data about each attribute changes: whether the attribute was created/ updated for that resource, in which case the action in the response will be put, or delete if the value of the attribute for the particular resource is being deleted. After it is deleted, the attribute value for the specific resource will inherit the value from the parent resource(s).

In case of an issue, the data will contain a message explaining the reason, for ex. when an attribute is not found, or the value provided does not match the attribute type, etc.

Request

Path Parameters

resourceType stringrequired

Resource type. Possible values are products, categories, users, usergroups

lookupKey stringrequired

Lookup key. Use different lookup keys depending on the resource type

lookupValue stringrequired

The value of the key (an id, sourceId, sku, etc.)

Query Parameters

source string

Optional. Used in combination with lookup key sourceId

application/json

Body

array

• Array [

class string
name string
type string
value string

• ]

Responses

200

Bulk product attribute values by product id - 200 / Bulk product attribute values by product source id - 200 / Bulk user attribute values by user id and attribute name - 200

Response Headers

• Alt-Svc

  string

• Via

  string

• alt-svc

  string

• content-length

  string

• date

  string

• return-format

  string

• server

  string

• x-request-id

  string

application/json

Schema

Schema

data

object[]

Array [

action string

error string

id number

key string

lookupKey string

message string

success boolean

value

object

anyOf

MOD1

number

MOD2

Array [

language string

value string

]

]

messages string[]
total number

Example (from schema)

{
  "data": [
    {
      "action": "put",
      "id": 661,
      "key": "WEIGHT",
      "lookupKey": "name",
      "message": "Attribute value put.",
      "success": true,
      "value": 15
    },
    {
      "action": "put",
      "id": 671,
      "key": "MATERIAAL_FRAME",
      "lookupKey": "name",
      "message": "Attribute value put.",
      "success": true,
      "value": [
        {
          "language": "NL",
          "value": "Leer"
        },
        {
          "language": "EN",
          "value": "Leather"
        }
      ]
    },
    {
      "action": "put",
      "error": "Attribute with name [HEIGHT] not found.",
      "key": "HEIGHT",
      "lookupKey": "name",
      "success": false
    },
    {
      "action": "delete",
      "id": 668,
      "key": "COLOR",
      "lookupKey": "name",
      "message": "Attribute value deleted (set to default).",
      "success": true
    }
  ],
  "messages": [
    "Completed"
  ],
  "total": 4
}

Bulk product attribute values by product id - 200

{
  "data": [
    {
      "action": "put",
      "id": 661,
      "key": "WEIGHT",
      "lookupKey": "name",
      "message": "Attribute value put.",
      "success": true,
      "value": 15
    },
    {
      "action": "put",
      "id": 671,
      "key": "MATERIAAL_FRAME",
      "lookupKey": "name",
      "message": "Attribute value put.",
      "success": true,
      "value": [
        {
          "language": "NL",
          "value": "Leer"
        },
        {
          "language": "EN",
          "value": "Leather"
        }
      ]
    },
    {
      "action": "put",
      "error": "Attribute with name [HEIGHT] not found.",
      "key": "HEIGHT",
      "lookupKey": "name",
      "success": false
    },
    {
      "action": "delete",
      "id": 668,
      "key": "COLOR",
      "lookupKey": "name",
      "message": "Attribute value deleted (set to default).",
      "success": true
    }
  ],
  "messages": [
    "Completed"
  ],
  "total": 4
}

Bulk product attribute values by product source id - 200

{
  "data": [
    {
      "action": "put",
      "id": 661,
      "key": "WEIGHT",
      "lookupKey": "name",
      "message": "Attribute value put.",
      "success": true,
      "value": 15
    },
    {
      "action": "put",
      "id": 671,
      "key": "MATERIAAL_FRAME",
      "lookupKey": "name",
      "message": "Attribute value put.",
      "success": true,
      "value": [
        {
          "language": "NL",
          "value": "Leer"
        },
        {
          "language": "EN",
          "value": "Leather"
        }
      ]
    },
    {
      "action": "put",
      "error": "Attribute with name [HEIGHT] not found.",
      "key": "HEIGHT",
      "lookupKey": "name",
      "success": false
    },
    {
      "action": "delete",
      "id": 668,
      "key": "COLOR",
      "lookupKey": "name",
      "message": "Attribute value deleted (set to default).",
      "success": true
    }
  ],
  "messages": [
    "Completed"
  ],
  "total": 4
}

Bulk user attribute values by user id and attribute name - 200

{
  "data": [
    {
      "action": "put",
      "id": 48,
      "key": "SHOW_REKENING",
      "lookupKey": "name",
      "message": "Attribute value put.",
      "success": true,
      "value": "Y"
    }
  ],
  "messages": [
    "Completed"
  ],
  "total": 1
}

400

Bulk product attribute values by product id - 400 (schema validation error)

Response Headers

• Alt-Svc

  string

• Via

  string

• alt-svc

  string

• content-length

  string

• date

  string

• return-format

  string

• server

  string

• x-request-id

  string

application/json

Schema

Schema

error

object

code number

messages string[]

moreInfo string

status number

type string

Example (from schema)

{
  "error": {
    "code": 10007,
    "messages": [
      "#/0/type: decimal is not a valid enum value",
      "#/0/type: decimal is not a valid enum value",
      "#/0/value: expected type: String, found: JSONArray",
      "#/0/type: decimal is not a valid enum value",
      "#/0/value: expected type: Integer, found: JSONArray",
      "#/0/value: expected type: Number, found: JSONArray",
      "#/0/type: decimal is not a valid enum value",
      "#/0/value: expected type: String, found: JSONArray",
      "#/0/type: decimal is not a valid enum value",
      "#/0/value: expected type: String, found: JSONArray"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/10007",
    "status": 400,
    "type": "SchemaValidationException"
  }
}

Bulk product attribute values by product id - 400 (schema validation error)

{
  "error": {
    "code": 10007,
    "messages": [
      "#/0/type: decimal is not a valid enum value",
      "#/0/type: decimal is not a valid enum value",
      "#/0/value: expected type: String, found: JSONArray",
      "#/0/type: decimal is not a valid enum value",
      "#/0/value: expected type: Integer, found: JSONArray",
      "#/0/value: expected type: Number, found: JSONArray",
      "#/0/type: decimal is not a valid enum value",
      "#/0/value: expected type: String, found: JSONArray",
      "#/0/type: decimal is not a valid enum value",
      "#/0/value: expected type: String, found: JSONArray"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/10007",
    "status": 400,
    "type": "SchemaValidationException"
  }
}

404

Bulk product attribute values by product id - 404 / Bulk product attribute values by product source id - 404

Response Headers

• Alt-Svc

  string

• Via

  string

• alt-svc

  string

• content-length

  string

• date

  string

• return-format

  string

• server

  string

• x-request-id

  string

application/json

Schema

Schema

error

object

code number

messages string[]

moreInfo string

status number

type string

Example (from schema)

{
  "error": {
    "code": 10009,
    "messages": [
      "Parent resource [Product] with id [372212] not found."
    ],
    "moreInfo": "https://www.propel.us/docs/errors/10009",
    "status": 404,
    "type": "ParentProductNotFound"
  }
}

Bulk product attribute values by product id - 404

{
  "error": {
    "code": 10009,
    "messages": [
      "Parent resource [Product] with id [372212] not found."
    ],
    "moreInfo": "https://www.propel.us/docs/errors/10009",
    "status": 404,
    "type": "ParentProductNotFound"
  }
}

Bulk product attribute values by product source id - 404

{
  "error": {
    "code": 10009,
    "messages": [
      "Parent resource [Product] with sourceId [076548] not found."
    ],
    "moreInfo": "https://www.propel.us/docs/errors/10009",
    "status": 404,
    "type": "ParentProductNotFound"
  }
}

Loading...