Home TOTVS Varejo Supermercados

Árvore de páginas

Objetivo

A finalidade deste método é, possibilitar a consulta de fornecedores dos produtos.

Chamada

GET api/v2/sm_products/suppliers

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

Parâmetros URI (URI Parameters)

Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)
deletedIndicates if return deleted records. – Optional – (N = No, S = Yes) – Default = “N” Note: if “N”, will be showed just deleted records; if “S”, will be showed just active records.stringNão há.
exclusion_dateLast Exclusion Date – (dd/mm/aaaa or ddmmaaaa) – Optional. Valid just when parameter “DELETED” it’s = “S”.stringNão há.
last_update_dateLast Update Date – (Optional) – (dd/mm/aaaa or ddmmaaaa)stringNão há.
seq_productProduct Sequence – RequiredCollection of decimal numberRequerido
_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)

SupplierResponseDTO – List of Suppliers

Collection of SupplierResponseDTO

Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)
main_supplierIndicates if is Main SupplierstringNão há.
nameName of SupplierstringNão há.
name_tradingTrading NamestringNão há.
reg_numberBrazilian Registry of Corporate TaxpayersintegerNão há.
reg_number_digDigit of Brazilian Registry of Corporate TaxpayersintegerNão há.
resale_supplierIndicates if supplier is reseller – N = No, S = YesstringNão há.
seq_familyProduct Sequencedecimal numberNão há.
seq_productProduct Sequencedecimal numberNão há.
seq_supplierSupplier Sequencedecimal numberNão há.
statusIndicates if supllier is blocked – A = Not Blocked, I = BlockedstringNão há.
type_supplierType of Supplier – D = Distributor, I = IndustrystringNão há.

Formatos de Resposta (Response Formats)

application/json, text/json

Exemplo (Sample):

[
  {
    "main_supplier": "sample string 2",
    "name": "sample string 3",
    "name_trading": "sample string 4",
    "reg_number": 1,
    "reg_number_dig": 1,
    "resale_supplier": "sample string 5",
    "seq_family": 6.0,
    "seq_product": 7.0,
    "seq_supplier": 8.0,
    "status": "sample string 9",
    "type_supplier": "sample string 10"
  },
  {
    "main_supplier": "sample string 2",
    "name": "sample string 3",
    "name_trading": "sample string 4",
    "reg_number": 1,
    "reg_number_dig": 1,
    "resale_supplier": "sample string 5",
    "seq_family": 6.0,
    "seq_product": 7.0,
    "seq_supplier": 8.0,
    "status": "sample string 9",
    "type_supplier": "sample string 10"
  }
]

application/xml, text/xml

Exemplo (Sample):

<ArrayOfSupplierResponseDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
 xmlns="http://schemas.datacontract.org/2004/07/SMProductsV3.Business.DTOs.Suppliers">
  <SupplierResponseDTO>
    <DATE_UPDATE_FAMILY>2019-10-16T18:08:24.8624742-03:00</DATE_UPDATE_FAMILY>
    <DATE_UPDATE_FAMILY_SUPPLIER>2019-10-16T18:08:24.8624742-03:00</DATE_UPDATE_FAMILY_SUPPLIER>
    <DATE_UPDATE_PERSON>2019-10-16T18:08:24.8624742-03:00</DATE_UPDATE_PERSON>
    <DATE_UPDATE_PRODUCT>2019-10-16T18:08:24.8624742-03:00</DATE_UPDATE_PRODUCT>
    <DATE_UPDATE_SUPPLIER>2019-10-16T18:08:24.8624742-03:00</DATE_UPDATE_SUPPLIER>
    <EXCLUSION_DATE>2019-10-16T18:08:24.8624742-03:00</EXCLUSION_DATE>
    <MAIN_SUPPLIER>sample string 2</MAIN_SUPPLIER>
    <NAME>sample string 3</NAME>
    <NAME_TRADING>sample string 4</NAME_TRADING>
    <REG_NUMBER>1</REG_NUMBER>
    <REG_NUMBER_DIG>1</REG_NUMBER_DIG>
    <RESALE_SUPPLIER>sample string 5</RESALE_SUPPLIER>
    <SEQ_FAMILY>6</SEQ_FAMILY>
    <SEQ_PRODUCT>7</SEQ_PRODUCT>
    <SEQ_SUPPLIER>8</SEQ_SUPPLIER>
    <STATUS>sample string 9</STATUS>
    <TYPE_SUPPLIER>sample string 10</TYPE_SUPPLIER>
  </SupplierResponseDTO>
  <SupplierResponseDTO>
    <DATE_UPDATE_FAMILY>2019-10-16T18:08:24.8624742-03:00</DATE_UPDATE_FAMILY>
    <DATE_UPDATE_FAMILY_SUPPLIER>2019-10-16T18:08:24.8624742-03:00</DATE_UPDATE_FAMILY_SUPPLIER>
    <DATE_UPDATE_PERSON>2019-10-16T18:08:24.8624742-03:00</DATE_UPDATE_PERSON>
    <DATE_UPDATE_PRODUCT>2019-10-16T18:08:24.8624742-03:00</DATE_UPDATE_PRODUCT>
    <DATE_UPDATE_SUPPLIER>2019-10-16T18:08:24.8624742-03:00</DATE_UPDATE_SUPPLIER>
    <EXCLUSION_DATE>2019-10-16T18:08:24.8624742-03:00</EXCLUSION_DATE>
    <MAIN_SUPPLIER>sample string 2</MAIN_SUPPLIER>
    <NAME>sample string 3</NAME>
    <NAME_TRADING>sample string 4</NAME_TRADING>
    <REG_NUMBER>1</REG_NUMBER>
    <REG_NUMBER_DIG>1</REG_NUMBER_DIG>
    <RESALE_SUPPLIER>sample string 5</RESALE_SUPPLIER>
    <SEQ_FAMILY>6</SEQ_FAMILY>
    <SEQ_PRODUCT>7</SEQ_PRODUCT>
    <SEQ_SUPPLIER>8</SEQ_SUPPLIER>
    <STATUS>sample string 9</STATUS>
    <TYPE_SUPPLIER>sample string 10</TYPE_SUPPLIER>
  </SupplierResponseDTO>
</ArrayOfSupplierResponseDTO>