Auth
Stores and Sales Channels
Lists
Products
Injection Web Services
Order Fulfillment
Switch Transactional
Products
This endpoint allows adding a list to the system
This endpoint allows you to add 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.
POST
/
api
/
v3
/
products
Copy
curl --request POST \
--url https://api.artisn.desarrollo-redbrand.com/api/api/v3/products \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"list": {
"listName": "<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,
"additionalInfo": {}
}
]
}
],
"products": [
{
"productId": "<string>",
"name": "<string>",
"type": "PRODUCT",
"description": "<string>",
"standardTime": true,
"featured": true,
"modifierId": "<string>",
"taxesInfo": [
{
"vatRatePercentage": 123,
"name": "<string>",
"type": "<string>"
}
],
"priceInfo": {
"price": 123,
"pointPrice": 123,
"suggestedPrice": 123,
"suggestedPointPrice": 123
},
"schedules": [
{
"day": "MONDAY",
"startDate": "2023-12-25",
"endDate": "2023-12-25",
"startTime": "<string>",
"endTime": "<string>"
}
],
"upselling": [
"<string>"
],
"crossSelling": [
"<string>"
],
"tags": [
"<string>"
],
"images": [
{
"imageCategoryId": "<string>",
"fileUrl": "<string>"
}
],
"productModifiers": [
{
"modifierId": "<string>",
"position": 123
}
],
"additionalInfo": {}
}
],
"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>"
}
]
}
],
"ecommerceChannelId": 123,
"channelReferenceName": "<string>"
}'
Copy
{
"listId": "<string>",
"name": "<string>",
"active": true
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
Response
200
application/json
List successfully registered
The response is of type object
.
Copy
curl --request POST \
--url https://api.artisn.desarrollo-redbrand.com/api/api/v3/products \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"list": {
"listName": "<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,
"additionalInfo": {}
}
]
}
],
"products": [
{
"productId": "<string>",
"name": "<string>",
"type": "PRODUCT",
"description": "<string>",
"standardTime": true,
"featured": true,
"modifierId": "<string>",
"taxesInfo": [
{
"vatRatePercentage": 123,
"name": "<string>",
"type": "<string>"
}
],
"priceInfo": {
"price": 123,
"pointPrice": 123,
"suggestedPrice": 123,
"suggestedPointPrice": 123
},
"schedules": [
{
"day": "MONDAY",
"startDate": "2023-12-25",
"endDate": "2023-12-25",
"startTime": "<string>",
"endTime": "<string>"
}
],
"upselling": [
"<string>"
],
"crossSelling": [
"<string>"
],
"tags": [
"<string>"
],
"images": [
{
"imageCategoryId": "<string>",
"fileUrl": "<string>"
}
],
"productModifiers": [
{
"modifierId": "<string>",
"position": 123
}
],
"additionalInfo": {}
}
],
"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>"
}
]
}
],
"ecommerceChannelId": 123,
"channelReferenceName": "<string>"
}'
Copy
{
"listId": "<string>",
"name": "<string>",
"active": true
}
Assistant
Responses are generated using AI and may contain mistakes.