Home TOTVS Varejo Supermercados

Árvore de páginas

Objetivo

Método que permite consultar as marcas dos produtos.

Chamada

GET [URLAPI]/CadastrosEstruturaisAPI/api/v1/Marca

Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)
IdMarca

Lista de identificadores de marcas

array[integer]

Não há.

DataHoraAlteracao

Data/Hora de alteração

string($date-time)

Não há.

NomeMarca

Nome da marcastringNão há.
ExpandPropriedades expansíveisstringNão há.
FieldsCamposstringNão há.
OrderTipo de OrdenaçãostringNão há.
PageNúmero da página

integer($int32)

Não há.

PageSize

Tamanho da página

integer($int32)

Não há.

Parâmetros do Corpo (Body Parameters)

Não há.

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

  • OK (200)
  • BadRequest (400)

Formatos de Resposta (Response Formats)

application/json, text/json

CODE 200 - SUCCESS

{
  "hasNext": true,
  "items": [
    {
      "expandables": [
        "string"
      ],
      "idMarca": 0,
      "nomeMarca": "string",
      "status": "string"
    }
  ]
}

application/json, text/json

CODE 400 - BAD

{
  "code": "string",
  "message": "string",
  "detailedMessage": "string",
  "helpUrl": "string",
  "details": [
    {
      "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "notificationType": 0,
      "code": "string",
      "message": "string",
      "detailedMessage": "string",
      "status": 0
    }
  ]
}