Using the Streaming Items API

This API requires Authentication.

Required fields are marked with a red asterisk (*) in the Name column.

Use the streaming Items API for partial real time item updates throughout the day.

Upsert items

POST https://items.attraqt.io/items

This endpoint allows you to create or modify a list of items.

Query Parameters

Name	Type	Description
tenant*	string	Your tenant ID
environment*	string	Your environment ID
fhrValidation	string	True/false. Enforces specific validation to comply with the Fredhopper data model

Headers

Name	Type	Description
Authorization*	string	Bearer token

Request Body

Name	Type	Description
items*	array	List of items

200 Return a list of receipt ids

[
 {
  itemId: {{item id}},
  receiptId: {{receipt id}}
 }
]

400: Bad Request tenant and environment are required

401 see Troubleshooting api errors

Example of an item upsert body:

[
    {
        "id": "A0001",
        "catalogVersion": 1,
        "type": "product",
        "attributes": {
            "title": "My item",
            "description": "This is my item.",
            "categories": [ "category_id_1","category_id_2"]
        }
    }
]

If a category tree has been defined for a catalogue version, the categories attribute becomes mandatory.

Please keep the message size of each API call under 1MB for better performance.

Patch items

PATCH https://items.attraqt.io/items

This method allows you to patch attributes of given items.

Unlike the upsert, patch an item will only update attributes that are present in the request. It means that you don't need to send the whole item, but only the updated attributes.

Query Parameters

Name	Type	Description
tenant*	string	Your tenant ID
environment*	string	Your environment ID
fhrValidation	String	True/false. Enforces specific validation to comply with the Fredhopper data model

Headers

Name	Type	Description
Authorization*	string	Bearer token

Request Body

Name	Type	Description
items*	array	List of items with attributes to patch

200 Return a list of receipt ids

[
 {
  itemId: {{item id}},
  receiptId: {{receipt id}}
 }
]

400: Bad Request tenant and environment are required

Mandatory attributes aren't checked with this method. Only the attribute's types are validated.

Example of an item patch body:

[
    {
        "id": "A0001",
        "catalogVersion": 1,
        "type": "product",
        "attributes": {
            "title": "My patched title",
        }
    }
]

Delete items

POST https://items.attraqt.io/items/delete

This endpoint allows you to delete items.

Query Parameters

Name	Type	Description
tenant*	string	Your tenant ID
environment*	string	Your environment ID

Headers

Name	Type	Description
Authorization*	string	Bearer token

Request Body

Name	Type	Description
item IDs*	array	List of item IDs

200

[
 {
  itemId: {{item id}},
  receiptId: {{receipt id}}
 }
]

Example of item deletion body

[
    {
        "id": "A0001",
        "catalogVersion": 1,
        "type": "product"
    }
]