Catalog.getBrands

Request the Catalog Brand data from the shop system.

Request

JSON Example

[
  {
      "api":1,
      "method":"auth",
      "params":{
         "username":"...",
         "password":"..."
      },
      "id":1
   },
   {
    "api": 1,
    "method": "Catalog.getBrands",
    "params": {},
    "id": 1
  }
]

Response

Response sends all Brand records:

[  
   {  
      "api":1,
      "result":[  
        {
        	"brandId": 28,
          "globalIdentifier": 'b123',
					"status": "active",
					"name": "Nike",
          "name_en": "Nike"
        },
        {
        	"brandId": 32,
          "globalIdentifier": 'b124',
					"status": "inactive",
					"name": "Samsung",
          "name_en": "Samsung"
        }
      ],
      "id":1
   }
]

Make sure values are properly encoded in the types specified below, as the Sync Agent client will not do any automatic conversion. Using strings instead of integers (eg.: "42" instead of 42), or integers instead of booleans (1 instead of true) will result in a validation error during sync.

Field name

Type

Mandatory

Value

Description

brandId

integer

yes

 undefined

id of the brand in the Shop system

globalIdentifier

varchar(255)

no

 undefined

identifier for this brand, which is unique across several country databases for your shop system 1)

status

enum

yes

"active", "inactive", "deleted"

 undefined

name

varchar(255)

yes

 undefined

Name of the Brand in the local language of the shop (e. g. Thai, French)

name_en

varchar(255)

no

 undefined

Name of the Brand in English 2)

1) not used by all shop systems 2) "name_en" field seems not to be used in the Sellercenter Application code.