Using the Item Schema API

This API requires Authentication.

Create an item schema

POST https://items.attraqt.io/item-schemas

Query Parameters

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

Headers

Name	Type	Description
Authorization*	string	Bearer token containing the following permission:

Request Body

Name	Type	Description
itemSchema*	object	itemSchema

200 itemSchema successfully created.

{}

400: Bad Request itemSchema validation failed (see error table below)

{
    // Response
}

400: Bad Request schema names should be unique per tenant

{
    // Response
}

Error category	Description
ITEM_SCHEMA_TENANT_ENV	Tenant and Environment are required
ITEM_SCHEMA_NAME	Name required
ITEM_SCHEMA_VERSION	version should not be set when creating a itemSchema
ITEM_SCHEMA_ATTRIBUTES	schema contains an invalid attribute

The schema version is managed by the API, don't include it on creation. When you create an item schema the version is set to 1.

Example of an item schema creation body:

{
    "name": "product",
    "attributes": [
        {
            "name": "title",
            "type": "TEXT"
        },
        {
            "name": "description",
            "type": "TEXT"
        }
    ],
    "nestedItemSchemas": [
        {
            "attributes": [
                {
                    "name": "price",
                    "type": "INTEGER"
                },
                {
                    "name": "color",
                    "type": "TEXT"
                }
            ]
        }
    ]
}

Update an item schema

PUT https://items.attraqt.io/item-schemas/{name}

This endpoint allows you to update an existing item schema.

Path Parameters

Name	Type	Description
name*	string

Query Parameters

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

Headers

Name	Type	Description
Authorization*	string	Bearer token containing the following permission:

Request Body

Name	Type	Description
itemSchema*	string	itemSchema to update

200

400: Bad Request Item Schema should exist to be updated

{
    // Response
}

400: Bad Request itemSchema validation failed

{
    // Response
}

Updating an item schema will increment his version by 1.

Delete an item schema

DELETE https://items.attraqt.io/item-schemas/{name}/{version}

Path Parameters

Name	Type	Description
name*	string	Name of itemSchema to delete.
version*	integer	​Version of itemSchema to delete.

Query Parameters

Name	Type	Description
tenant*	string
environment*	string

Headers

Name	Type	Description
Authorization*	string	Bearer token containing the following permission:

200

400: Bad Request itemSchema is used in a catalog

{
    // Response
}

400: Bad Request itemSchema not found

{
    // Response
}

Get an item schema

GET /item-schemas/{name}/{version}

Get a full item schema by providing its slug and version.

Path Parameters

Name	Type	Description
name*	string	Name of itemSchema to get.
version*	integer	​Version of itemSchema to get.

Query Parameters

Name	Type	Description
tenant*	string
environment*	string

Headers

Name	Type	Description
Authorization*	string	Bearer token containing the following permission:

200 return fulll itemSchema

{{item schema}}

404: Not Found

{
    // Response
}