GET
/
v3
/
lists
/
sync-summary
/
lists
curl --request GET \
  --url https://api.artisn.desarrollo-redbrand.com/api/v3/lists/sync-summary/lists \
  --header 'Authorization: Bearer <token>'
{
  "summary": {
    "status": "<string>",
    "errors": [
      "<string>"
    ],
    "warnings": [
      "<string>"
    ],
    "individualUpdates": true,
    "list": {
      "listId": "<string>",
      "listName": "<string>",
      "schedules": [
        {
          "day": "<string>",
          "openTime": "<string>",
          "closeTime": "<string>"
        }
      ],
      "categories": [
        {
          "categoryId": "<string>",
          "categoryName": "<string>",
          "childCategories": [
            {
              "categoryId": "<string>",
              "categoryName": "<string>"
            }
          ],
          "productListing": [
            {
              "productId": "<string>",
              "productName": "<string>",
              "productModifiers": [
                {
                  "modifierId": "<string>",
                  "modifierName": "<string>",
                  "modifierOptions": [
                    {
                      "optionId": "<string>",
                      "optionName": "<string>"
                    }
                  ]
                }
              ]
            }
          ]
        }
      ]
    }
  }
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
vendorId
integer
required

Unique identifier of the brand, this identifier is provided by Trade

​
storeId
integer
required

Unique identifier of the store

​
channelId
integer
required

Sales channel identifier

​
channelReferenceName
string

This field is required if the channelId attribute is not unique. Unique reference name, this name will be used for the search and association of the standardized channel

​
listName
string

Este campo es requerido si se utiliza en el atributo 'additionalInfo.relatedLists' en la sincronización de canales de venta. Nombre de la lista.

Response

200
application/json

Synchronization report obtained successfully

The response is of type object.