curl --request PUT \
--url https://api.artisn.desarrollo-redbrand.com/api/v3/lists/{listId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"list": {
"ecommerceChannelId": 123,
"channelReferenceName": "<string>",
"listId": "<string>",
"listName": "<string>",
"vendorId": "<string>",
"storeId": "<string>",
"channelId": "<string>",
"schedules": [
{
"day": "<string>",
"startDate": "<string>",
"endDate": "<string>",
"startTime": "<string>",
"endTime": "<string>"
}
]
},
"categories": [
{
"categoryId": "<string>",
"categoryName": "<string>",
"displayInList": true,
"featured": true,
"crossSellingCategory": true,
"position": 123,
"images": [
{
"imageCategoryId": "<string>",
"fileUrl": "<string>"
}
],
"childCategories": [
{
"categoryId": "<string>",
"categoryName": "<string>"
}
],
"productListing": [
{
"productId": "<string>",
"position": 123
}
],
"schedules": [
{
"day": "<string>",
"startDate": "<string>",
"endDate": "<string>",
"startTime": "<string>",
"endTime": "<string>"
}
]
}
],
"products": [
{
"productId": "<string>",
"name": "<string>",
"description": "<string>",
"standardTime": true,
"featured": true,
"priceInfo": {
"price": 123,
"salePrice": 123
},
"productModifiers": [
{
"modifierId": "<string>",
"position": 123
}
],
"schedules": [
{
"day": "<string>",
"startDate": "<string>",
"endDate": "<string>",
"startTime": "<string>",
"endTime": "<string>"
}
],
"images": [
{
"imageCategoryId": "<string>",
"fileUrl": "<string>"
}
]
}
],
"modifierGroups": [
{
"modifierId": "<string>",
"modifier": "<string>",
"minOptions": 123,
"maxOptions": 123,
"visible": true,
"position": 123,
"type": "<string>",
"modifierOptions": [
{
"optionId": "<string>",
"productId": "<string>",
"default": true,
"position": 123
}
]
}
],
"scheduledActivities": [
{
"productId": "<string>",
"scheduledActiveStatus": "2023-11-07T05:31:56Z",
"scheduledInactiveStatus": "2023-11-07T05:31:56Z"
}
]
}
'{
"listId": "<string>",
"name": "<string>",
"active": true
}This endpoint allows you to register or edit a list in the system. Important: Each submitted request is processed as a new configuration, so if a product, category, modifier, etc. is not sent all your configuration will be deleted
curl --request PUT \
--url https://api.artisn.desarrollo-redbrand.com/api/v3/lists/{listId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"list": {
"ecommerceChannelId": 123,
"channelReferenceName": "<string>",
"listId": "<string>",
"listName": "<string>",
"vendorId": "<string>",
"storeId": "<string>",
"channelId": "<string>",
"schedules": [
{
"day": "<string>",
"startDate": "<string>",
"endDate": "<string>",
"startTime": "<string>",
"endTime": "<string>"
}
]
},
"categories": [
{
"categoryId": "<string>",
"categoryName": "<string>",
"displayInList": true,
"featured": true,
"crossSellingCategory": true,
"position": 123,
"images": [
{
"imageCategoryId": "<string>",
"fileUrl": "<string>"
}
],
"childCategories": [
{
"categoryId": "<string>",
"categoryName": "<string>"
}
],
"productListing": [
{
"productId": "<string>",
"position": 123
}
],
"schedules": [
{
"day": "<string>",
"startDate": "<string>",
"endDate": "<string>",
"startTime": "<string>",
"endTime": "<string>"
}
]
}
],
"products": [
{
"productId": "<string>",
"name": "<string>",
"description": "<string>",
"standardTime": true,
"featured": true,
"priceInfo": {
"price": 123,
"salePrice": 123
},
"productModifiers": [
{
"modifierId": "<string>",
"position": 123
}
],
"schedules": [
{
"day": "<string>",
"startDate": "<string>",
"endDate": "<string>",
"startTime": "<string>",
"endTime": "<string>"
}
],
"images": [
{
"imageCategoryId": "<string>",
"fileUrl": "<string>"
}
]
}
],
"modifierGroups": [
{
"modifierId": "<string>",
"modifier": "<string>",
"minOptions": 123,
"maxOptions": 123,
"visible": true,
"position": 123,
"type": "<string>",
"modifierOptions": [
{
"optionId": "<string>",
"productId": "<string>",
"default": true,
"position": 123
}
]
}
],
"scheduledActivities": [
{
"productId": "<string>",
"scheduledActiveStatus": "2023-11-07T05:31:56Z",
"scheduledInactiveStatus": "2023-11-07T05:31:56Z"
}
]
}
'{
"listId": "<string>",
"name": "<string>",
"active": true
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
General information of the list to be created
Show child attributes
Unified sales channel identifier, refers to the standardized channel identifier.
Unique reference name, used for search and association of the standardized channel.
Unique identifier of the list. Ex: pickup-menu, daily-menu, ...
Name that identifies the list. Ex: 'menu app'
Unique brand identifier, provided by Trade.
Unique identifier of the store, refers to the storeId parameter of the creation of stores and sales channels. The 'replicate_in_all' value allows the current list to be replicated for all stores
Unique identifier of the sales channel, refers to the channelId parameter of the creation of stores and sales channels.
Permite definir las categorías de productos, así como su organización en la lista.
Show child attributes
Permite definir los productos o items, así como su organización en la lista.
Show child attributes
Permite definir un listado de modificadores que se utilizarán en la lista.
Show child attributes