Register or edit a list
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"
}
]
}
'import requests
url = "https://api.artisn.desarrollo-redbrand.com/api/v3/lists/{listId}"
payload = {
"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"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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'
}
]
})
};
fetch('https://api.artisn.desarrollo-redbrand.com/api/v3/lists/{listId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.artisn.desarrollo-redbrand.com/api/v3/lists/{listId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'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'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.artisn.desarrollo-redbrand.com/api/v3/lists/{listId}"
payload := strings.NewReader("{\n \"list\": {\n \"ecommerceChannelId\": 123,\n \"channelReferenceName\": \"<string>\",\n \"listId\": \"<string>\",\n \"listName\": \"<string>\",\n \"vendorId\": \"<string>\",\n \"storeId\": \"<string>\",\n \"channelId\": \"<string>\",\n \"schedules\": [\n {\n \"day\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"startTime\": \"<string>\",\n \"endTime\": \"<string>\"\n }\n ]\n },\n \"categories\": [\n {\n \"categoryId\": \"<string>\",\n \"categoryName\": \"<string>\",\n \"displayInList\": true,\n \"featured\": true,\n \"crossSellingCategory\": true,\n \"position\": 123,\n \"images\": [\n {\n \"imageCategoryId\": \"<string>\",\n \"fileUrl\": \"<string>\"\n }\n ],\n \"childCategories\": [\n {\n \"categoryId\": \"<string>\",\n \"categoryName\": \"<string>\"\n }\n ],\n \"productListing\": [\n {\n \"productId\": \"<string>\",\n \"position\": 123\n }\n ],\n \"schedules\": [\n {\n \"day\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"startTime\": \"<string>\",\n \"endTime\": \"<string>\"\n }\n ]\n }\n ],\n \"products\": [\n {\n \"productId\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"standardTime\": true,\n \"featured\": true,\n \"priceInfo\": {\n \"price\": 123,\n \"salePrice\": 123\n },\n \"productModifiers\": [\n {\n \"modifierId\": \"<string>\",\n \"position\": 123\n }\n ],\n \"schedules\": [\n {\n \"day\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"startTime\": \"<string>\",\n \"endTime\": \"<string>\"\n }\n ],\n \"images\": [\n {\n \"imageCategoryId\": \"<string>\",\n \"fileUrl\": \"<string>\"\n }\n ]\n }\n ],\n \"modifierGroups\": [\n {\n \"modifierId\": \"<string>\",\n \"modifier\": \"<string>\",\n \"minOptions\": 123,\n \"maxOptions\": 123,\n \"visible\": true,\n \"position\": 123,\n \"type\": \"<string>\",\n \"modifierOptions\": [\n {\n \"optionId\": \"<string>\",\n \"productId\": \"<string>\",\n \"default\": true,\n \"position\": 123\n }\n ]\n }\n ],\n \"scheduledActivities\": [\n {\n \"productId\": \"<string>\",\n \"scheduledActiveStatus\": \"2023-11-07T05:31:56Z\",\n \"scheduledInactiveStatus\": \"2023-11-07T05:31:56Z\"\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.artisn.desarrollo-redbrand.com/api/v3/lists/{listId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"list\": {\n \"ecommerceChannelId\": 123,\n \"channelReferenceName\": \"<string>\",\n \"listId\": \"<string>\",\n \"listName\": \"<string>\",\n \"vendorId\": \"<string>\",\n \"storeId\": \"<string>\",\n \"channelId\": \"<string>\",\n \"schedules\": [\n {\n \"day\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"startTime\": \"<string>\",\n \"endTime\": \"<string>\"\n }\n ]\n },\n \"categories\": [\n {\n \"categoryId\": \"<string>\",\n \"categoryName\": \"<string>\",\n \"displayInList\": true,\n \"featured\": true,\n \"crossSellingCategory\": true,\n \"position\": 123,\n \"images\": [\n {\n \"imageCategoryId\": \"<string>\",\n \"fileUrl\": \"<string>\"\n }\n ],\n \"childCategories\": [\n {\n \"categoryId\": \"<string>\",\n \"categoryName\": \"<string>\"\n }\n ],\n \"productListing\": [\n {\n \"productId\": \"<string>\",\n \"position\": 123\n }\n ],\n \"schedules\": [\n {\n \"day\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"startTime\": \"<string>\",\n \"endTime\": \"<string>\"\n }\n ]\n }\n ],\n \"products\": [\n {\n \"productId\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"standardTime\": true,\n \"featured\": true,\n \"priceInfo\": {\n \"price\": 123,\n \"salePrice\": 123\n },\n \"productModifiers\": [\n {\n \"modifierId\": \"<string>\",\n \"position\": 123\n }\n ],\n \"schedules\": [\n {\n \"day\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"startTime\": \"<string>\",\n \"endTime\": \"<string>\"\n }\n ],\n \"images\": [\n {\n \"imageCategoryId\": \"<string>\",\n \"fileUrl\": \"<string>\"\n }\n ]\n }\n ],\n \"modifierGroups\": [\n {\n \"modifierId\": \"<string>\",\n \"modifier\": \"<string>\",\n \"minOptions\": 123,\n \"maxOptions\": 123,\n \"visible\": true,\n \"position\": 123,\n \"type\": \"<string>\",\n \"modifierOptions\": [\n {\n \"optionId\": \"<string>\",\n \"productId\": \"<string>\",\n \"default\": true,\n \"position\": 123\n }\n ]\n }\n ],\n \"scheduledActivities\": [\n {\n \"productId\": \"<string>\",\n \"scheduledActiveStatus\": \"2023-11-07T05:31:56Z\",\n \"scheduledInactiveStatus\": \"2023-11-07T05:31:56Z\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.artisn.desarrollo-redbrand.com/api/v3/lists/{listId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"list\": {\n \"ecommerceChannelId\": 123,\n \"channelReferenceName\": \"<string>\",\n \"listId\": \"<string>\",\n \"listName\": \"<string>\",\n \"vendorId\": \"<string>\",\n \"storeId\": \"<string>\",\n \"channelId\": \"<string>\",\n \"schedules\": [\n {\n \"day\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"startTime\": \"<string>\",\n \"endTime\": \"<string>\"\n }\n ]\n },\n \"categories\": [\n {\n \"categoryId\": \"<string>\",\n \"categoryName\": \"<string>\",\n \"displayInList\": true,\n \"featured\": true,\n \"crossSellingCategory\": true,\n \"position\": 123,\n \"images\": [\n {\n \"imageCategoryId\": \"<string>\",\n \"fileUrl\": \"<string>\"\n }\n ],\n \"childCategories\": [\n {\n \"categoryId\": \"<string>\",\n \"categoryName\": \"<string>\"\n }\n ],\n \"productListing\": [\n {\n \"productId\": \"<string>\",\n \"position\": 123\n }\n ],\n \"schedules\": [\n {\n \"day\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"startTime\": \"<string>\",\n \"endTime\": \"<string>\"\n }\n ]\n }\n ],\n \"products\": [\n {\n \"productId\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"standardTime\": true,\n \"featured\": true,\n \"priceInfo\": {\n \"price\": 123,\n \"salePrice\": 123\n },\n \"productModifiers\": [\n {\n \"modifierId\": \"<string>\",\n \"position\": 123\n }\n ],\n \"schedules\": [\n {\n \"day\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"startTime\": \"<string>\",\n \"endTime\": \"<string>\"\n }\n ],\n \"images\": [\n {\n \"imageCategoryId\": \"<string>\",\n \"fileUrl\": \"<string>\"\n }\n ]\n }\n ],\n \"modifierGroups\": [\n {\n \"modifierId\": \"<string>\",\n \"modifier\": \"<string>\",\n \"minOptions\": 123,\n \"maxOptions\": 123,\n \"visible\": true,\n \"position\": 123,\n \"type\": \"<string>\",\n \"modifierOptions\": [\n {\n \"optionId\": \"<string>\",\n \"productId\": \"<string>\",\n \"default\": true,\n \"position\": 123\n }\n ]\n }\n ],\n \"scheduledActivities\": [\n {\n \"productId\": \"<string>\",\n \"scheduledActiveStatus\": \"2023-11-07T05:31:56Z\",\n \"scheduledInactiveStatus\": \"2023-11-07T05:31:56Z\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"listId": "<string>",
"name": "<string>",
"active": true
}{
"message": "<string>"
}Lists
This endpoint allows registering or editing a list in the system
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
PUT
/
v3
/
lists
/
{listId}
Register or edit a list
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"
}
]
}
'import requests
url = "https://api.artisn.desarrollo-redbrand.com/api/v3/lists/{listId}"
payload = {
"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"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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'
}
]
})
};
fetch('https://api.artisn.desarrollo-redbrand.com/api/v3/lists/{listId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.artisn.desarrollo-redbrand.com/api/v3/lists/{listId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'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'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.artisn.desarrollo-redbrand.com/api/v3/lists/{listId}"
payload := strings.NewReader("{\n \"list\": {\n \"ecommerceChannelId\": 123,\n \"channelReferenceName\": \"<string>\",\n \"listId\": \"<string>\",\n \"listName\": \"<string>\",\n \"vendorId\": \"<string>\",\n \"storeId\": \"<string>\",\n \"channelId\": \"<string>\",\n \"schedules\": [\n {\n \"day\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"startTime\": \"<string>\",\n \"endTime\": \"<string>\"\n }\n ]\n },\n \"categories\": [\n {\n \"categoryId\": \"<string>\",\n \"categoryName\": \"<string>\",\n \"displayInList\": true,\n \"featured\": true,\n \"crossSellingCategory\": true,\n \"position\": 123,\n \"images\": [\n {\n \"imageCategoryId\": \"<string>\",\n \"fileUrl\": \"<string>\"\n }\n ],\n \"childCategories\": [\n {\n \"categoryId\": \"<string>\",\n \"categoryName\": \"<string>\"\n }\n ],\n \"productListing\": [\n {\n \"productId\": \"<string>\",\n \"position\": 123\n }\n ],\n \"schedules\": [\n {\n \"day\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"startTime\": \"<string>\",\n \"endTime\": \"<string>\"\n }\n ]\n }\n ],\n \"products\": [\n {\n \"productId\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"standardTime\": true,\n \"featured\": true,\n \"priceInfo\": {\n \"price\": 123,\n \"salePrice\": 123\n },\n \"productModifiers\": [\n {\n \"modifierId\": \"<string>\",\n \"position\": 123\n }\n ],\n \"schedules\": [\n {\n \"day\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"startTime\": \"<string>\",\n \"endTime\": \"<string>\"\n }\n ],\n \"images\": [\n {\n \"imageCategoryId\": \"<string>\",\n \"fileUrl\": \"<string>\"\n }\n ]\n }\n ],\n \"modifierGroups\": [\n {\n \"modifierId\": \"<string>\",\n \"modifier\": \"<string>\",\n \"minOptions\": 123,\n \"maxOptions\": 123,\n \"visible\": true,\n \"position\": 123,\n \"type\": \"<string>\",\n \"modifierOptions\": [\n {\n \"optionId\": \"<string>\",\n \"productId\": \"<string>\",\n \"default\": true,\n \"position\": 123\n }\n ]\n }\n ],\n \"scheduledActivities\": [\n {\n \"productId\": \"<string>\",\n \"scheduledActiveStatus\": \"2023-11-07T05:31:56Z\",\n \"scheduledInactiveStatus\": \"2023-11-07T05:31:56Z\"\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.artisn.desarrollo-redbrand.com/api/v3/lists/{listId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"list\": {\n \"ecommerceChannelId\": 123,\n \"channelReferenceName\": \"<string>\",\n \"listId\": \"<string>\",\n \"listName\": \"<string>\",\n \"vendorId\": \"<string>\",\n \"storeId\": \"<string>\",\n \"channelId\": \"<string>\",\n \"schedules\": [\n {\n \"day\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"startTime\": \"<string>\",\n \"endTime\": \"<string>\"\n }\n ]\n },\n \"categories\": [\n {\n \"categoryId\": \"<string>\",\n \"categoryName\": \"<string>\",\n \"displayInList\": true,\n \"featured\": true,\n \"crossSellingCategory\": true,\n \"position\": 123,\n \"images\": [\n {\n \"imageCategoryId\": \"<string>\",\n \"fileUrl\": \"<string>\"\n }\n ],\n \"childCategories\": [\n {\n \"categoryId\": \"<string>\",\n \"categoryName\": \"<string>\"\n }\n ],\n \"productListing\": [\n {\n \"productId\": \"<string>\",\n \"position\": 123\n }\n ],\n \"schedules\": [\n {\n \"day\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"startTime\": \"<string>\",\n \"endTime\": \"<string>\"\n }\n ]\n }\n ],\n \"products\": [\n {\n \"productId\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"standardTime\": true,\n \"featured\": true,\n \"priceInfo\": {\n \"price\": 123,\n \"salePrice\": 123\n },\n \"productModifiers\": [\n {\n \"modifierId\": \"<string>\",\n \"position\": 123\n }\n ],\n \"schedules\": [\n {\n \"day\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"startTime\": \"<string>\",\n \"endTime\": \"<string>\"\n }\n ],\n \"images\": [\n {\n \"imageCategoryId\": \"<string>\",\n \"fileUrl\": \"<string>\"\n }\n ]\n }\n ],\n \"modifierGroups\": [\n {\n \"modifierId\": \"<string>\",\n \"modifier\": \"<string>\",\n \"minOptions\": 123,\n \"maxOptions\": 123,\n \"visible\": true,\n \"position\": 123,\n \"type\": \"<string>\",\n \"modifierOptions\": [\n {\n \"optionId\": \"<string>\",\n \"productId\": \"<string>\",\n \"default\": true,\n \"position\": 123\n }\n ]\n }\n ],\n \"scheduledActivities\": [\n {\n \"productId\": \"<string>\",\n \"scheduledActiveStatus\": \"2023-11-07T05:31:56Z\",\n \"scheduledInactiveStatus\": \"2023-11-07T05:31:56Z\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.artisn.desarrollo-redbrand.com/api/v3/lists/{listId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"list\": {\n \"ecommerceChannelId\": 123,\n \"channelReferenceName\": \"<string>\",\n \"listId\": \"<string>\",\n \"listName\": \"<string>\",\n \"vendorId\": \"<string>\",\n \"storeId\": \"<string>\",\n \"channelId\": \"<string>\",\n \"schedules\": [\n {\n \"day\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"startTime\": \"<string>\",\n \"endTime\": \"<string>\"\n }\n ]\n },\n \"categories\": [\n {\n \"categoryId\": \"<string>\",\n \"categoryName\": \"<string>\",\n \"displayInList\": true,\n \"featured\": true,\n \"crossSellingCategory\": true,\n \"position\": 123,\n \"images\": [\n {\n \"imageCategoryId\": \"<string>\",\n \"fileUrl\": \"<string>\"\n }\n ],\n \"childCategories\": [\n {\n \"categoryId\": \"<string>\",\n \"categoryName\": \"<string>\"\n }\n ],\n \"productListing\": [\n {\n \"productId\": \"<string>\",\n \"position\": 123\n }\n ],\n \"schedules\": [\n {\n \"day\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"startTime\": \"<string>\",\n \"endTime\": \"<string>\"\n }\n ]\n }\n ],\n \"products\": [\n {\n \"productId\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"standardTime\": true,\n \"featured\": true,\n \"priceInfo\": {\n \"price\": 123,\n \"salePrice\": 123\n },\n \"productModifiers\": [\n {\n \"modifierId\": \"<string>\",\n \"position\": 123\n }\n ],\n \"schedules\": [\n {\n \"day\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"startTime\": \"<string>\",\n \"endTime\": \"<string>\"\n }\n ],\n \"images\": [\n {\n \"imageCategoryId\": \"<string>\",\n \"fileUrl\": \"<string>\"\n }\n ]\n }\n ],\n \"modifierGroups\": [\n {\n \"modifierId\": \"<string>\",\n \"modifier\": \"<string>\",\n \"minOptions\": 123,\n \"maxOptions\": 123,\n \"visible\": true,\n \"position\": 123,\n \"type\": \"<string>\",\n \"modifierOptions\": [\n {\n \"optionId\": \"<string>\",\n \"productId\": \"<string>\",\n \"default\": true,\n \"position\": 123\n }\n ]\n }\n ],\n \"scheduledActivities\": [\n {\n \"productId\": \"<string>\",\n \"scheduledActiveStatus\": \"2023-11-07T05:31:56Z\",\n \"scheduledInactiveStatus\": \"2023-11-07T05:31:56Z\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"listId": "<string>",
"name": "<string>",
"active": true
}{
"message": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
General information of the list to be created
Show child attributes
Show child attributes
Permite definir las categorías de productos, así como su organización en la lista.
Show child attributes
Show child attributes
Permite definir los productos o items, así como su organización en la lista.
Show child attributes
Show child attributes
Permite definir un listado de modificadores que se utilizarán en la lista.
Show child attributes
Show child attributes
Permite programar la activación e inactivación de productos en una fecha futura.
Show child attributes
Show child attributes
⌘I