GENERAL INFORMATION
With this endpoint you can retrieve the AI generated product descriptions. Direct link to Swagger documentation:
REQUEST
Authentication:
Bearer token, information on page POST /Token
Headers
Name | Description | Example |
|---|---|---|
X-Tenant | Tenant code supplied by Wair | “TENANT” |
QueryParameters:
Name | Description | Example |
|---|---|---|
Offset | The offset of records you want to retrieve | 100 |
Limit | Maximum number of records you want to retrieve | 10 |
ConfirmedDateTime | Confirmed date time in UTC to filter on, returns results greater or equal than this date time | 2024-01-31T13:50:31.331Z |
ItemId | Optional queryParameter to filder a specific itemId. | 1000001 |
StyleId | Optional queryParameter to filder a specific StyleId. | 1000001-001 |
Body example:
No body required.
RESPONSE
StatusCodes:
200 = OK
401 = Unauthorized, which means an expired/missing/invalid token
500 = System error, see body of the response to check which error has occured or contact integration support
Body Example:
{
"styles": [
{
"id": 100000000,
"itemId": "100001",
"styleId": "guid01",
"colorId": "guid01",
"materialId": "guid01",
"category": "tops",
"tags": [
{
"key": "tops_fit",
"values": [
"regular-fit-tops"
]
},
{
"key": "tops_length",
"values": [
"cropped"
]
}
],
"toneOfVoice": "My brand's tone of voice",
"descriptions": [
{
"languageId": 1,
"languageCode": "en-US",
"language": "English (United States)",
"countryIso2": "EN",
"countryIso3": "ENG",
"productTitle": "Womens Black Cropped Top",
"productMetaDescription": "This is a product meta description about a black cropped top",
"productDescription": "This is a product description about a black cropped top"
}
],
"createdDateTime": "2024-01-30T09:19:49.813Z",
"confirmedDateTime": "2024-01-31T09:19:49.813Z",
"confirmedBy": "user@email.com"
}
],
"offset": 0,
"limit": 0,
"moreRecordsAvailable": true
}id = unique id of the description
itemId = id of the item
styleId = id of the item style id
colorId = id of color
materialId = id of material
category = category of the product
tags = key/values pair of all the tags of the product
toneOfVoice = the tone of voice used to generate the description
languageId = the code of language used for this description
languageCode = the code of language used for this description
language = description of language used for this description
countryIso2 = 2 letter ISO country code
countryIso3 = 3 letter ISO country code
productTitle = the title of the products
productMetaDescription = product meta description
productDescription = product description
createdDateTime = when the description was generated
confirmedDateTime = when it was confirmed by the user
confirmedBy = e-mail address of user who corfirmed the description
offset = The offset you used as queryParam
limit = The limit you used as queryParam
moreRecordsAvailable = if there are more records available after your offset/limit