Presence API ECOMMERCE - ECM-PRODUTOS (completo)

Presence API ECOMMERCE - ECM-PRODUTOS (completo)

Cadastro de Produtos

Este método é responsável por listar os produtos da base da dados.

Para os dados retornarem corretamente, o Endpoint de chamada é diferente, deve-se utilizar a seguinte URL:


Parâmetros

Nome
Obrigatório
Tipo
Descrição
id_webserviceSIMIntegerID do webservice
data_at
SIM quando não informada referência_site
Data (AAAA-MM-DDT00:00:00)
Data de atualização dos dados. Padrão ISO8601.
referencia_site
SIM quando não informado data_at
String
Código do produto no Presence Domain
Categorias
NÃO
Boolean
Dados da Categoria do Produto
SKUS
NÃO
Boolean
Dados do SKU do Produto
Estoques
NÃO
Boolean
Dados do Estoque do Produto
Precos
NÃO
Boolean
Dados dos Preços do Produto
categorias_apenas_principal
NÃO
Boolean
"S" para apresentar apenas categoria principal ou "N" para todas
categorias_hierarquia_completa
NÃO
Boolean
"S" para apresentar hierarquia completa ou "N" para apenas principal

BODY

  1. {
  2.     "id_webservice" : 995,
  3.     "data_at" : "2022-02-15",
  4.     "Categorias" : true,
  5.     "SKUS" : true,
  6.     "Estoques" : true,
  7.     "Precos" : true,
  8.      "categorias_apenas_principal": "S",
  9.      "categorias_hierarquia_completa": "N"
  10. }
    OU
    1. {
    2.   "id_webservice" : 995,
    3.   "referencia_site" : "00002"
    4. }

    JSON de Retorno

      Nome
      Tipo
      Descrição
      referencia
      String
      Código do Produto
      codigoExterno
      String
      Código interno do Produto no Ecommerce
      descricao
      String
      Descrição do Produto
      narrativa
      String
      		Descrição/Narrativa do Produto
      status
      String
      Situação do Produto (Ativo/Inativo)
      apresentarNaHome
      String
      Produto apresenta na página principal? (S = SIM, N = Não)
      unidadeMedida
      String
      Sigla da Unidade de Medida
      unidadeMedidaDesc
      String
      Descrição da Unidade de Medida
      unidadeMedidaFator
      Integer
      Fator de conversão da Unidade de Medida
      composicao
      String
      Composição do Produto
      observacao
      String
      Observações do produto
      fichaTecnica
      String
      Especificações técnicas do produto
      departamento
      String
      Código do departamento do produto
      departamentoDesc
      String
      		Descrição do Departamento
      grupo
      String
      Código do grupo
      grupoDesc
      String
      Descrição do Grupo
      subgrupo
      String
      Código do Subgrupo
      subgrupoDesc
      String
      Descrição do Subgrupo
      linha
      String
      Código da linha
      linhaDesc
      String
      Descrição da linha do produto
      colecao
      String
      Código da coleção
      colecaoDesc
      String
      Descrição da coleção
      marcaCodint
       Integer
      Código interno da Marca
      marcaDesc
       String
      Descrição da Marca
      marcaCodext
       String
      Código interno da marca no ecommerce
      fornecedor
       Integer
      Código interno do fornecedor
      fornecedorFantasia
       String
      Nome Fantasia do Fornecedor
      referenciaFornecedor
       String
      Referencia do Fornecedor
      altura
       Real
      Altura do produto
      largura
       Real
      Largura do produto
      comprimento
       Real
      Comprimento do Produto
      peso
       Real
      Peso do Produto
      dataCadastro
       Data (AAAA-MM-DDT00:00:00)
      Data de cadastro do produto
      dataAtualizacao
       Data (AAAA-MM-DDT00:00:00)
      Data de atualização do produto
      pk
      String
      Código interno do produto no site
      idProcesso
      Integer
      Código do Método
      name
      String
      Nome do Item no Site
      refid
      String
      Código da Referencia
      description
      String
      Descrição completa da referencia
      shortdescription
      String
      Descrição resumida da referencia
      keywords
      String
      Tags da referencia
      title
      String
      Nome de exibição da referencia
      metatagdescription
      String
      Descrição da meta tag
      brand
      String
      Descrição da marca
      brandId
      String
      Código da marca.
      textLink
      String
      Link do produto na plataforma.

      Se parâmetro Categoria = True

      Nome
      Tipo
      Descrição
      referencia
       String
       Código da Referência
      referenciaCodigoExterno
       String
       Código interno da Referência no Ecommerce
      codigo
      Integer
      Código da categoria
      codigoPai
      Integer
      Código da categoria pai
      descricao
       String
       Descrição da categoria do produto
      codigoExterno
      String
      Código da categoria na plataforma
      codigoPaiExterno
      String
      Código da categoria pai na plataforma
      principal
      String
      Indica se a categoria é principal 'S' ou 'N'
      dataAt
      Data (AAAA-MM-DDT00:00:00)
       Data da atualização da categoria
      idProcesso
      Integer
      Código do Método
      pk
      String
      Chave primária do Registro

      Se parâmetro SKUS = True

      Nome
      Tipo
      Descrição
      referenciaSiteOut
      String
      Código do Produto/Referência
      sku
      String
      SKU do Produto
      corpos
      String
      Código da Cor
      cor
      String
      Descrição da Cor
      tampos
      String
      Código do tamanho
      tamanho
      String
      Descrição do Tamanho
      descricao
      String
      Descrição do SKU (REF+TAM+COR)
      corCodigoExterno
      String
      Código interno da cor no Ecommerce
      tamanhoCodigoExterno
      String
      Código interno do tamanho no Ecommerce
      status
      String
      Situação do SKU (Ativo/Inativo)
      skuCodigoExterno
      String
      Código interno do sku no ecommerce
      gtin
      String
      Código GTIN do produto
      codigoAuxiliar
      String
      Código EAN do produto
      codigoEcommerce
      String
      Código Ecommerce
      pk
      String
      Chave primária do registro
      idProcesso
      Integer
      Código do Método

      Se parâmetro Estoques = True

      Nome
      Tipo
      Descrição
      sku
      String
      SKU do produto
      codigoExterno
      String
      Código interno do SKU no Ecommerce
      warehouse
      String
      Código da loja
      warehouseCodigoExterno
      String
      Código interno da loja no Ecommerce
      quantidade
      Real
      		Quantidade do SKU na loja
      dataAt
      Data (AAAA-MM-DDT00:00:00)
      Data da atualização do SKU
      idProcesso
      Integer
      Código do Método
      pk
      String
      Chave Primária do Registro

      Se parâmetro Precos = True

      Nome
      Tipo
      Descrição
      sku
      String
      SKU do Produto
      skuCodigoExterno
      String
      Código interno do SKU no Ecommerce
      codigoProduto
      String
      Código da Referência
      IdPreco
      Integer
      ID da configuração de preço
      precoCodExterno
      String
      Código externo do preço
      precoCusto
      Real
      Preço de custo do SKU
      precoBase
      Real
      Preço base do SKU
      precoBasePromo
      Real
      Preço base promocional do SKU
      dataInicio
      Data (AAAA-MM-DDT00:00:00)
      Data de Início do preço base promocional
      dataFim
      Data (AAAA-MM-DDT00:00:00)
      Data de término do preço base promocional
      precoLista
      Real
      Preço lista do SKU
      dataAt
      Data (AAAA-MM-DDT00:00:00)
      Data de atualização do preço
      idProcesso
      Integer
      Código do Método
      pk
      String
      Chave primária do registro


      Exemplo de Retorno

      1. {
      2.     "status": "ok",
      3.     "method": "ECM-PRODUTOS",
      4.     "data": [
      5.         {
      6.             "referencia": "00001",
      7.             "codigoExterno": null,
      8.             "descricao": "PRODUTO DE TESTE",
      9.             "narrativa": "PRODUTO DE TESTE",
      10.             "status": "Ativo",
      11.             "apresentarNaHome":"S",
      12.             "unidadeMedida": "PC",
      13.             "unidadeMedidaDesc": "PC",
      14.             "unidadeMedidaFator": 1,
      15.             "composicao": "Teste de quebra de linha para Composição do produto 00001.",
      16.             "observacao": "",
      17.             "fichaTecnica": "",
      18.             "departamento": "01",
      19.             "departamentoDesc": "CAMISETA",
      20.             "grupo": "01",
      21.             "grupoDesc": "AUTORAL ADULTO",
      22.             "subgrupo": "  ",
      23.             "subgrupoDesc": "",
      24.             "linha": "01",
      25.             "linhaDesc": "BASICA",
      26.             "colecao": "99",
      27.             "colecaoDesc": "PRESENCE HOMOLOG",
      28.             "marcaCodint": 1,
      29.             "marcaDesc": "ÚNICA",
      30.             "marcaCodext": "2003194",
      31.             "fornecedor": 29,
      32.             "fornecedorFantasia": "FORNECEDOR MATO GROSSO PF",
      33.             "referenciaFornecedor": "VERSAOFINAL290",
      34.             "altura": 0,
      35.             "largura": 0,
      36.             "comprimento": 0,
      37.             "peso": 0,
      38.             "dataCadastro": null,
      39.             "dataAtualizacao": "2022-03-14 16:33:55.000",
      40.             "pk": "00001",
      41.             "idProcesso": 5,
      42.             "name": "PRODUTO DE TESTE",
      43.             "refid": "00001",
      44.             "description": "ECM Descrição PRODUTO DE TESTE",
      45.             "shortdescription": "ECM Descrição Curta PRODUTO DE TESTE",
      46.             "keywords": null,
      47.             "title": "PRODUTO DE TESTE",
      48.             "metatagdescription": null,
      49.             "brand": "ÚNICA",
      50.             "brandId": "2003194",
      51.             "textLink": "PRODUTO DE-TESTE",
      52.             "Categorias": [
      53.                 {
      54.                     "referencia": "00001",
      55.                     "referenciaCodigoExterno": null,
      56.                     "codigo": 24,
      57.                     "codigoPai": null,
      58.                     "descricao": "CAMISA",
      59.                     "codigoExterno": "144",
      60.                     "codigoPaiExterno": null,
      61.                     "principal": "N",
      62.                     "dataAt": "2022-03-04 16:57:07.000",
      63.                     "idProcesso": 4,
      64.                     "pk": "24"
      65.                 },
      66.                 {
      67.                     "referencia": "00001",
      68.                     "referenciaCodigoExterno": null,
      69.                     "codigo": 25,
      70.                     "codigoPai": 24,
      71.                     "descricao": "VARIADA",
      72.                     "codigoExterno": "145",
      73.                     "codigoPaiExterno": "144",
      74.                     "principal": "N",
      75.                     "dataAt": "2022-03-04 16:57:07.000",
      76.                     "idProcesso": 4,
      77.                     "pk": "25"
      78.                 },
      79.                 {
      80.                     "referencia": "00001",
      81.                     "referenciaCodigoExterno": null,
      82.                     "codigo": 26,
      83.                     "codigoPai": 25,
      84.                     "descricao": "SORTIDA",
      85.                     "codigoExterno": "146",
      86.                     "codigoPaiExterno": "145",
      87.                     "principal": "S",
      88.                     "dataAt": "2022-03-04 16:57:07.000",
      89.                     "idProcesso": 4,
      90.                     "pk": "26"
      91.                 }
      92.             ],
      93.             "SKU": [
      94.                 {
      95.                     "referenciaSiteOut": "00001",
      96.                     "sku": "000010101",
      97.                     "corpos": "01",
      98.                     "cor": "BRANCA",
      99.                     "tampos": "01",
      100.                     "tamanho": "8",
      101.                     "descricao": "ABREAKOMBI BRANCA TAM: 8",
      102.                     "corCodigoExterno": "21336",
      103.                     "tamanhoCodigoExterno": "20860",
      104.                     "status": "Ativo",
      105.                     "skuCodigoExterno": "0012348965",
      106.                     "gtin": "6660000000017",
      107.                     "codigoAuxiliar": "2000000016573",
      108.                     "codigoEcommerce": null,
      109.                     "pk": "000010101",
      110.                     "idProcesso": 6
      111.                 }
      112.             ],
      113.             "Estoques": [
      114.                 {
      115.                     "sku": "000010101",
      116.                     "codigoExterno": "0012348965",
      117.                     "warehouse": "99",
      118.                     "warehouseCodigoExterno": "W99",
      119.                     "quantidade": -10000030,
      120.                     "dataAt": "2022-01-13 15:21:57.000",
      121.                     "idProcesso": 13,
      122.                     "pk": "000010101"
      123.                 },
      124.                 {
      125.                     "sku": "000010102",
      126.                     "codigoExterno": "2913",
      127.                     "warehouse": "99",
      128.                     "warehouseCodigoExterno": "W99",
      129.                     "quantidade": -9,
      130.                     "dataAt": "2022-01-13 15:21:57.000",
      131.                     "idProcesso": 13,
      132.                     "pk": "000010102"
      133.                 },
      134.                 {
      135.                     "sku": "000010201",
      136.                     "codigoExterno": "2903",
      137.                     "warehouse": "99",
      138.                     "warehouseCodigoExterno": "W99",
      139.                     "quantidade": -13,
      140.                     "dataAt": "2022-01-13 15:21:57.000",
      141.                     "idProcesso": 13,
      142.                     "pk": "000010201"
      143.                 },
      144.                 {
      145.                     "sku": "000010202",
      146.                     "codigoExterno": "2914",
      147.                     "warehouse": "99",
      148.                     "warehouseCodigoExterno": "W99",
      149.                     "quantidade": 8,
      150.                     "dataAt": "2022-01-13 15:21:57.000",
      151.                     "idProcesso": 13,
      152.                     "pk": "000010202"
      153.                 },
      154.                 {
      155.                     "sku": "000010301",
      156.                     "codigoExterno": "2904",
      157.                     "warehouse": "99",
      158.                     "warehouseCodigoExterno": "W99",
      159.                     "quantidade": -55,
      160.                     "dataAt": "2022-01-13 15:21:57.000",
      161.                     "idProcesso": 13,
      162.                     "pk": "000010301"
      163.                 },
      164.                 {
      165.                     "sku": "000010302",
      166.                     "codigoExterno": "2915",
      167.                     "warehouse": "99",
      168.                     "warehouseCodigoExterno": "W99",
      169.                     "quantidade": 8,
      170.                     "dataAt": "2022-01-13 15:21:57.000",
      171.                     "idProcesso": 13,
      172.                     "pk": "000010302"
      173.                 },
      174.                 {
      175.                     "sku": "000010401",
      176.                     "codigoExterno": "2905",
      177.                     "warehouse": "99",
      178.                     "warehouseCodigoExterno": "W99",
      179.                     "quantidade": 8,
      180.                     "dataAt": "2022-02-08 16:57:02.000",
      181.                     "idProcesso": 13,
      182.                     "pk": "000010401"
      183.                 },
      184.                 {
      185.                     "sku": "000010402",
      186.                     "codigoExterno": "2916",
      187.                     "warehouse": "99",
      188.                     "warehouseCodigoExterno": "W99",
      189.                     "quantidade": 0,
      190.                     "dataAt": "2022-01-13 15:21:57.000",
      191.                     "idProcesso": 13,
      192.                     "pk": "000010402"
      193.                 },
      194.                 {
      195.                     "sku": "000010501",
      196.                     "codigoExterno": "2906",
      197.                     "warehouse": "99",
      198.                     "warehouseCodigoExterno": "W99",
      199.                     "quantidade": 2,
      200.                     "dataAt": "2022-02-08 16:35:29.000",
      201.                     "idProcesso": 13,
      202.                     "pk": "000010501"
      203.                 },
      204.                 {
      205.                     "sku": "000010502",
      206.                     "codigoExterno": "2917",
      207.                     "warehouse": "99",
      208.                     "warehouseCodigoExterno": "W99",
      209.                     "quantidade": 1,
      210.                     "dataAt": "2022-01-13 15:21:57.000",
      211.                     "idProcesso": 13,
      212.                     "pk": "000010502"
      213.                 },
      214.                 {
      215.                     "sku": "000010601",
      216.                     "codigoExterno": "2907",
      217.                     "warehouse": "99",
      218.                     "warehouseCodigoExterno": "W99",
      219.                     "quantidade": 4,
      220.                     "dataAt": "2022-01-13 15:21:57.000",
      221.                     "idProcesso": 13,
      222.                     "pk": "000010601"
      223.                 },
      224.                 {
      225.                     "sku": "000010602",
      226.                     "codigoExterno": "2918",
      227.                     "warehouse": "99",
      228.                     "warehouseCodigoExterno": "W99",
      229.                     "quantidade": 1,
      230.                     "dataAt": "2022-01-13 15:21:57.000",
      231.                     "idProcesso": 13,
      232.                     "pk": "000010602"
      233.                 },
      234.                 {
      235.                     "sku": "000010701",
      236.                     "codigoExterno": "2908",
      237.                     "warehouse": "99",
      238.                     "warehouseCodigoExterno": "W99",
      239.                     "quantidade": 4,
      240.                     "dataAt": "2022-01-13 15:21:57.000",
      241.                     "idProcesso": 13,
      242.                     "pk": "000010701"
      243.                 },
      244.                 {
      245.                     "sku": "000010702",
      246.                     "codigoExterno": "2919",
      247.                     "warehouse": "99",
      248.                     "warehouseCodigoExterno": "W99",
      249.                     "quantidade": -1,
      250.                     "dataAt": "2022-01-13 15:21:57.000",
      251.                     "idProcesso": 13,
      252.                     "pk": "000010702"
      253.                 },
      254.                 {
      255.                     "sku": "000010801",
      256.                     "codigoExterno": "2909",
      257.                     "warehouse": "99",
      258.                     "warehouseCodigoExterno": "W99",
      259.                     "quantidade": 5,
      260.                     "dataAt": "2022-01-13 15:21:57.000",
      261.                     "idProcesso": 13,
      262.                     "pk": "000010801"
      263.                 },
      264.                 {
      265.                     "sku": "000010802",
      266.                     "codigoExterno": "2920",
      267.                     "warehouse": "99",
      268.                     "warehouseCodigoExterno": "W99",
      269.                     "quantidade": 0,
      270.                     "dataAt": "2022-01-13 15:21:57.000",
      271.                     "idProcesso": 13,
      272.                     "pk": "000010802"
      273.                 },
      274.                 {
      275.                     "sku": "000010901",
      276.                     "codigoExterno": "2910",
      277.                     "warehouse": "99",
      278.                     "warehouseCodigoExterno": "W99",
      279.                     "quantidade": -6,
      280.                     "dataAt": "2022-01-13 15:21:57.000",
      281.                     "idProcesso": 13,
      282.                     "pk": "000010901"
      283.                 },
      284.                 {
      285.                     "sku": "000010902",
      286.                     "codigoExterno": "2921",
      287.                     "warehouse": "99",
      288.                     "warehouseCodigoExterno": "W99",
      289.                     "quantidade": 0,
      290.                     "dataAt": "2022-01-13 15:21:57.000",
      291.                     "idProcesso": 13,
      292.                     "pk": "000010902"
      293.                 },
      294.                 {
      295.                     "sku": "000011001",
      296.                     "codigoExterno": "2911",
      297.                     "warehouse": "99",
      298.                     "warehouseCodigoExterno": "W99",
      299.                     "quantidade": 6,
      300.                     "dataAt": "2022-01-13 15:21:57.000",
      301.                     "idProcesso": 13,
      302.                     "pk": "000011001"
      303.                 },
      304.                 {
      305.                     "sku": "000011002",
      306.                     "codigoExterno": "2922",
      307.                     "warehouse": "99",
      308.                     "warehouseCodigoExterno": "W99",
      309.                     "quantidade": 0,
      310.                     "dataAt": "2022-01-13 15:21:57.000",
      311.                     "idProcesso": 13,
      312.                     "pk": "000011002"
      313.                 },
      314.                 {
      315.                     "sku": "000011101",
      316.                     "codigoExterno": "2912",
      317.                     "warehouse": "99",
      318.                     "warehouseCodigoExterno": "W99",
      319.                     "quantidade": 4,
      320.                     "dataAt": "2022-01-13 15:21:57.000",
      321.                     "idProcesso": 13,
      322.                     "pk": "000011101"
      323.                 },
      324.                 {
      325.                     "sku": "000011102",
      326.                     "codigoExterno": "2923",
      327.                     "warehouse": "99",
      328.                     "warehouseCodigoExterno": "W99",
      329.                     "quantidade": 1,
      330.                     "dataAt": "2022-01-13 15:21:57.000",
      331.                     "idProcesso": 13,
      332.                     "pk": "000011102"
      333.                 }
      334.             ],
      335.             "Precos": [
      336.                 {
      337.                     "sku": "000010101",
      338.                     "skuCodigoExterno": "0012348965",
      339.                     "codigoProduto": "00001",
      340.                     "idPreco": 1,
      341.                     "precoCodExterno": "TP01",
      342.                     "precoCusto": 1008.99,
      343.                     "precoBase": 30.04,
      344.                     "precoBasePromo": 30.07,
      345.                     "dataInicio": "2020-12-01 00:00:00.000",
      346.                     "dataFim": "2020-12-31 00:00:00.000",
      347.                     "precoLista": 30.04,
      348.                     "dataAt": "2020-12-07 15:55:52.000",
      349.                     "idProcesso": 14,
      350.                     "pk": "00001&01&01"
      351.                 },
      352.                 {
      353.                     "sku": "000010101",
      354.                     "skuCodigoExterno": "0012348965",
      355.                     "codigoProduto": "00001",
      356.                     "idPreco": 99,
      357.                     "tabelaCodExterno": "TP99",
      358.                     "precoCusto": 1008.99,
      359.                     "precoBase": 8,
      360.                     "precoBasePromo": 0,
      361.                     "dataInicio": null,
      362.                     "dataFim": null,
      363.                     "precoBase": 8,
      364.                     "dataAt": "2016-08-27 15:16:51.000",
      365.                     "idProcesso": 14,
      366.                     "pk": "00001&01&01"
      367.                 }
      368.             ]
      369.         }
      370.     ]
      371. }

      Reporte de sucessos ou erros


      Após consulta da informação e envio para a plataforma, é necessário:
      1. Informar o sucesso da operação ao ERP;
      2. Informar erro, para dar transparência ao cliente da integração, bem como alimentar o controle de erros.

      Para reportar esse status, deverá ser utilizado o método ECM-RESULTADO-PROCESSAMENTO.

      O envio dessa sinalização é obrigatório para vinculação dos códigos Presence com códigos Plataforma, bem como para funcionamento do painel de acompanhamento de erros de integração no ERP.