Home TOTVS Varejo Supermercados

Árvore de páginas

Objetivo

A finalidade deste método é possibilitar a consulta de marcas de produtos.

Chamada

GET api/v2/sm_products/brands?SeqBrand=
{SeqBrand}&Description={Description}&TypeBrand=
{TypeBrand}&Status={Status}&TotalizeSaleOrder=
{TotalizeSaleOrder}&DateUpdate=
{DateUpdate}&_pageNo={_pageNo}&_pageSize=
{_pageSize}

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

Parâmetros URI (URI Parameters)

Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)
seqBrand
integerNão há.
description
stringTamanho da string: inclusive between 0 and 20
typeBrand
stringTamanho da string: inclusive between 0 and 5
status
stringTamanho da string: inclusive between 0 and 1
totalizeSaleOrder
stringTamanho da string: inclusive between 0 and 1
dateUpdate
stringNão há.
_pageNo
integerNão há.
_pageSize
integerNão há.

Parâmetros do Corpo (Body Parameters)

Não há.

Informações para Resposta (Response Information)

Descrição do Recurso (Resource Description)

Collection of BrandResponseDTO

Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)
seqBrand
integerNão há.
description
stringTamanho da string: inclusive between 0 and 20
typeBrand
stringTamanho da String: inclusive between 0 and 5
status
stringTamanho da String: inclusive between 0 and 1
totalizeSaleOrder
stringTamanho da String: inclusive between 0 and 1
dateUpdate
dateTamanho da String: inclusive between 0 and 1
ecommerce
EcommerceResponseDTONão há.

Formatos de Resposta (Response Formats)

application/json, text/json

Exemplo (Sample):

[
  {
    "seqBrand": 1,
    "description": "sample string 1",
    "typeBrand": "sample string 2",
    "status": "sample string 3",
    "totalizeSaleOrder": "sample string 4",
    "dateUpdate": "2019-10-18T16:08:16.704289-03:00",
    "ecommerce": {
      "title": "sample string 1",
      "description": "sample string 2",
      "keyWord": "sample string 3"
    }
  },
  {
    "seqBrand": 1,
    "description": "sample string 1",
    "typeBrand": "sample string 2",
    "status": "sample string 3",
    "totalizeSaleOrder": "sample string 4",
    "dateUpdate": "2019-10-18T16:08:16.704289-03:00",
    "ecommerce": {
      "title": "sample string 1",
      "description": "sample string 2",
      "keyWord": "sample string 3"
    }
  }
]

application/xml, text/xml

Exemplo (Sample):

<ArrayOfBrandResponseDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Consinco.SM.API.Entities.Entities.v2.Brand">
  <BrandResponseDTO>
    <COUNT>5</COUNT>
    <DateUpdate>2019-10-18T16:08:16.704289-03:00</DateUpdate>
    <Description>sample string 1</Description>
    <Ecommerce>
      <Description>sample string 2</Description>
      <KeyWord>sample string 3</KeyWord>
      <Title>sample string 1</Title>
    </Ecommerce>
    <SeqBrand>1</SeqBrand>
    <Status>sample string 3</Status>
    <TotalizeSaleOrder>sample string 4</TotalizeSaleOrder>
    <TypeBrand>sample string 2</TypeBrand>
  </BrandResponseDTO>
  <BrandResponseDTO>
    <COUNT>5</COUNT>
    <DateUpdate>2019-10-18T16:08:16.704289-03:00</DateUpdate>
    <Description>sample string 1</Description>
    <Ecommerce>
      <Description>sample string 2</Description>
      <KeyWord>sample string 3</KeyWord>
      <Title>sample string 1</Title>
    </Ecommerce>
    <SeqBrand>1</SeqBrand>
    <Status>sample string 3</Status>
    <TotalizeSaleOrder>sample string 4</TotalizeSaleOrder>
    <TypeBrand>sample string 2</TypeBrand>
  </BrandResponseDTO>
</ArrayOfBrandResponseDTO>