Skip to main content
POST
/
api
/
v3
/
products
Add a product list
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>",
      "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": [
        {
          "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>"
}
'
import requests

url = "https://api.artisn.desarrollo-redbrand.com/api/api/v3/products"

payload = {
    "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>",
            "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": [
                {
                    "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>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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>',
        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: [
          {
            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>'
  })
};

fetch('https://api.artisn.desarrollo-redbrand.com/api/api/v3/products', 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/api/v3/products",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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>',
                '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' => [
                                [
                                                                '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>'
  ]),
  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/api/v3/products"

	payload := strings.NewReader("{\n  \"list\": {\n    \"listName\": \"<string>\"\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          \"additionalInfo\": {}\n        }\n      ]\n    }\n  ],\n  \"products\": [\n    {\n      \"productId\": \"<string>\",\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"standardTime\": true,\n      \"featured\": true,\n      \"modifierId\": \"<string>\",\n      \"taxesInfo\": [\n        {\n          \"vatRatePercentage\": 123,\n          \"name\": \"<string>\",\n          \"type\": \"<string>\"\n        }\n      ],\n      \"priceInfo\": {\n        \"price\": 123,\n        \"pointPrice\": 123,\n        \"suggestedPrice\": 123,\n        \"suggestedPointPrice\": 123\n      },\n      \"schedules\": [\n        {\n          \"startDate\": \"2023-12-25\",\n          \"endDate\": \"2023-12-25\",\n          \"startTime\": \"<string>\",\n          \"endTime\": \"<string>\"\n        }\n      ],\n      \"upselling\": [\n        \"<string>\"\n      ],\n      \"crossSelling\": [\n        \"<string>\"\n      ],\n      \"tags\": [\n        \"<string>\"\n      ],\n      \"images\": [\n        {\n          \"imageCategoryId\": \"<string>\",\n          \"fileUrl\": \"<string>\"\n        }\n      ],\n      \"productModifiers\": [\n        {\n          \"modifierId\": \"<string>\",\n          \"position\": 123\n        }\n      ],\n      \"additionalInfo\": {}\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  \"ecommerceChannelId\": 123,\n  \"channelReferenceName\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.artisn.desarrollo-redbrand.com/api/api/v3/products")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"list\": {\n    \"listName\": \"<string>\"\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          \"additionalInfo\": {}\n        }\n      ]\n    }\n  ],\n  \"products\": [\n    {\n      \"productId\": \"<string>\",\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"standardTime\": true,\n      \"featured\": true,\n      \"modifierId\": \"<string>\",\n      \"taxesInfo\": [\n        {\n          \"vatRatePercentage\": 123,\n          \"name\": \"<string>\",\n          \"type\": \"<string>\"\n        }\n      ],\n      \"priceInfo\": {\n        \"price\": 123,\n        \"pointPrice\": 123,\n        \"suggestedPrice\": 123,\n        \"suggestedPointPrice\": 123\n      },\n      \"schedules\": [\n        {\n          \"startDate\": \"2023-12-25\",\n          \"endDate\": \"2023-12-25\",\n          \"startTime\": \"<string>\",\n          \"endTime\": \"<string>\"\n        }\n      ],\n      \"upselling\": [\n        \"<string>\"\n      ],\n      \"crossSelling\": [\n        \"<string>\"\n      ],\n      \"tags\": [\n        \"<string>\"\n      ],\n      \"images\": [\n        {\n          \"imageCategoryId\": \"<string>\",\n          \"fileUrl\": \"<string>\"\n        }\n      ],\n      \"productModifiers\": [\n        {\n          \"modifierId\": \"<string>\",\n          \"position\": 123\n        }\n      ],\n      \"additionalInfo\": {}\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  \"ecommerceChannelId\": 123,\n  \"channelReferenceName\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.artisn.desarrollo-redbrand.com/api/api/v3/products")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"list\": {\n    \"listName\": \"<string>\"\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          \"additionalInfo\": {}\n        }\n      ]\n    }\n  ],\n  \"products\": [\n    {\n      \"productId\": \"<string>\",\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"standardTime\": true,\n      \"featured\": true,\n      \"modifierId\": \"<string>\",\n      \"taxesInfo\": [\n        {\n          \"vatRatePercentage\": 123,\n          \"name\": \"<string>\",\n          \"type\": \"<string>\"\n        }\n      ],\n      \"priceInfo\": {\n        \"price\": 123,\n        \"pointPrice\": 123,\n        \"suggestedPrice\": 123,\n        \"suggestedPointPrice\": 123\n      },\n      \"schedules\": [\n        {\n          \"startDate\": \"2023-12-25\",\n          \"endDate\": \"2023-12-25\",\n          \"startTime\": \"<string>\",\n          \"endTime\": \"<string>\"\n        }\n      ],\n      \"upselling\": [\n        \"<string>\"\n      ],\n      \"crossSelling\": [\n        \"<string>\"\n      ],\n      \"tags\": [\n        \"<string>\"\n      ],\n      \"images\": [\n        {\n          \"imageCategoryId\": \"<string>\",\n          \"fileUrl\": \"<string>\"\n        }\n      ],\n      \"productModifiers\": [\n        {\n          \"modifierId\": \"<string>\",\n          \"position\": 123\n        }\n      ],\n      \"additionalInfo\": {}\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  \"ecommerceChannelId\": 123,\n  \"channelReferenceName\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "listId": "<string>",
  "name": "<string>",
  "active": true
}
{
  "message": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
list
object

General information of the list where the defined products will be added

​
modifierGroups
object[]

Allows you to define a list of modifiers that will be used in the list

​
products
object[]

Allows you to define the products or items, as well as their organization in the list

​
categories
object[]

Allows you to define product categories as well as their organization in the list

​
ecommerceChannelId
integer

Unified sales channel identifier, refers to the standardized channel identifier

​
channelReferenceName
string

Unique reference name, used for search and association of the standardized channel.

Response

List successfully registered

​
listId
string
​
name
string
​
active
boolean