Páginas filhas
  • Rotas REST - E-commerce

Aviso:

Os programas PD0309, PD0310, PD0623, PD0627 e PD0628 estarão disponíveis até a release 12.1.2311 do sistema para utilização com uma loja por modelo de negócio (B2C/B2B). Para suporte a múltiplas lojas por modelo de negócio ou a partir da versão 12.1.2403 deverá ser utilizada a Central de Configurações E-commerce (https://tdn.totvs.com/x/NhvKK).

01. CATEGORIA

Ao cadastrar uma categoria no programa PD0623, essa categoria será enviada do ERP Datasul para o E-commerce.

No momento que é cadastrada ou alterada uma categoria, será gerado um registro na tabela: depto-integr-loja.

Na tabela depto-integr-loja fica armazenada o código da categoria e a data e hora da última criação ou alteração do registro.

Para confirmar que a categoria foi criada e visualizar os dados que estão sendo enviados do ERP Datasul para VTEX, é possível realizar uma requisição REST para o servidor onde a integração será executada por meio da ROTA:

GET - http://[servidor]/dts/datasul-rest/resources/prg/cdp/v1/businessFamilyPublic/ecommerce

A autorização para acesso é feita por meio de autenticação Basic Auth, informando usuário e senha de um usuário cadastrado no ERP:

Requisição REST que apresenta todas as categorias cadastradas no programa PD0623.

Para retornar todas as categorias cadastradas no programa PD0623, a partir de uma última data e hora de atualização do registro utilizar a ROTA:

GET http://servidor/dts/datasul-rest/resources/prg/cdp/v1/businessFamilyPublic/ecommerce?lastUpdate=2022-02-17T00:00:00.001

Necessário informar o Query Params lastUpdate no formato de data e hora: 2022-02-17T00:00:00.001

Neste exemplo serão buscadas todas as categorias criadas/alteradas a partir do dia 17-02-2022 e do horário 00:00:00:

O JSON que envia as informações da categoria do ERP Datasul para o e-commerce é composto dos seguintes campos:

SERIALIZE-NAMETABELA.CAMPO ERPDescrição
categoryParentCodedepto-integr-loja.cod-familia-comercCódigo da Família Comercial no ERP
categoryErpDescdepto-integr-loja.desc-familia-comerc-erpDescrição da Família Comercial no ERP
categoryNamedepto-integr-loja.nom-deptoNome da Categoria no e-commerce
categoryDescriptiondepto-integr-loja.dsl-deptoDescrição da Categoria no e-commerce
isActivedepto-integr-loja.log-ativoDefine se a categoria estará ativa no e-commerce
categoryParentCodedepto-integr-loja.cod-familia-comerc-paiSe a categoria é filha de outra categoria, é gravado neste campo o código da categoria pai
erpLastChangedepto-integr-loja.dtm-alterData e hora da última criação ou alteração do registro
areItemsIntegratedlog-itens-integrIndica se a categoria possui item já integrado com o e-commerce (campo não disponível na tabela do banco de dados, apenas de controle interno no ERP)

02. PRODUTO

Ao cadastrar um item no programa PD0623, esse item será enviada do ERP Datasul para o E-commerce.

No momento que é cadastrado um item no programa PD0623, será gerado um registro na tabela: item-integr-loja.

Na tabela item-log fica armazenada o código do item e a data e hora da última criação ou alteração do registro.

Na primeira carga dos itens do ERP Datasul para o e-commerce, todos os itens gravados na tabela item-integr-loja serão enviados para o e-commerce. 

Nas cargas posteriores serão considerados os itens que possuírem registros na tabela item-log.

Para confirmar que o item foi definido para ser enviado para o e-commerce e visualizar os dados que estão sendo enviados do ERP Datasul para VTEX, é possível realizar uma requisição REST para o servidor onde a integração será executada por meio da ROTA:

GET - http://[servidor]/dts/datasul-rest/resources/prg/cep/v1/productPublic/ecommerce

A autorização para acesso é feita por meio de autenticação Basic Auth, informando usuário e senha de um usuário cadastrado no ERP:


Para retornar todos os itens cadastrados no programa PD0623 (ou que sofreram uma alteração nos dados do item por meio do programa CD0204 ou CD0903) a partir de uma última data e hora de atualização do registro utilizar a ROTA:

GET http://servidor/dts/datasul-rest/resources/prg/cep/v1/productPublic/ecommerce?lastUpdate=2022-02-17T00:00:00.001

Necessário informar o Query Params lastUpdate no formato de data e hora: 2022-02-17T00:00:00.001

Neste exemplo serão buscados os itens criados/alterados a partir do dia 17-02-2022 e do horário 00:00:00:

O JSON que envia as informações do produto do ERP Datasul para o e-commerce é composto dos seguintes campos:

SERIALIZE-NAMETABELA.CAMPO ERPDescrição
categoryCodeitem.fm-cod-comCódigo da Família Comercial a qual o item pertence no ERP
itemCodeitem.cod-item Código do item 
itemDescriptionitem.desc-item Descrição do item 
isActiveitem.cod-obsoletoDefine se o item estará ativo no e-commerce (totalmente obsoleto no CD0204, significa que o item estará inativo no e-commerce)
erpLastChangeitem-log.dtm-alterData e hora da última criação ou alteração do registro 
integratedDepositlog-integr-deposIndica se o item possui um depósito já integrado com o e-commerce (campo não disponível na tabela do banco de dados, apenas de controle interno no ERP)
integratedPriceTablog-integr-tbIndica se o item possui uma tabela de preço já integrada com o e-commerce (campo não disponível na tabela do banco de dados, apenas de controle interno no ERP)

03. DEFINIÇÕES DO PRODUTO

Ao cadastrar um item no programa PD0623, as definições desse item será enviada do ERP Datasul para o E-commerce.

No momento que é cadastrado um item no programa PD0623, será gerado um registro na tabela: item-integr-loja.

Na tabela item-log fica armazenada o código do item e a data e hora da última criação ou alteração do registro.

Na primeira carga dos itens do ERP Datasul para o e-commerce, todas as definições dos itens gravados na tabela item-integr-loja serão enviadas para o e-commerce. 

Nas cargas posteriores serão considerados as definições dos itens que possuírem registros na tabela item-log.

Para confirmar que as definições dos itens serão envidas para o e-commerce e visualizar os dados que estão sendo enviados do ERP Datasul para VTEX, é possível realizar uma requisição REST para o servidor onde a integração será executada por meio da ROTA:

GET - http://[servidor]/dts/datasul-rest/resources/prg/cep/v1/productSkuPublic/ecommerce

A autorização para acesso é feita por meio de autenticação Basic Auth, informando usuário e senha de um usuário cadastrado no ERP:

Para retornar todas as definições dos itens cadastrados no programa PD0623 (ou que sofreram uma alteração nos dados do item por meio do programa CD0204 ou CD0903) a partir de uma última data e hora de atualização do registro utilizar a ROTA:

GET http://servidor/dts/datasul-rest/resources/prg/cep/v1/productSkuPublic/ecommerce?lastUpdate=2022-02-17T00:00:00.001

Necessário informar o Query Params lastUpdate no formato de data e hora: 2022-02-17T00:00:00.001

Neste exemplo serão buscados todas as definições dos itens criados/alterados a partir do dia 17-02-2022 e do horário 00:00:00:

O JSON que envia as informações das definições do produto do ERP Datasul para o e-commerce é composto dos seguintes campos:

SERIALIZE-NAMETABELA.CAMPO ERPDescrição
referenceCodeitem.cod-referCódigo da Família Comercial a qual o item pertence no ERP
itemCodeitem.cod-item Código do item 
itemDescriptionitem.desc-item Descrição do item 
isActiveitem.cod-obsoletoDefine se o item estará ativo no e-commerce (totalmente obsoleto no CD0204, significa que o item estará inativo no e-commerce)
erpLastChangeitem-log.dtm-alterData e hora da última criação ou alteração do registro 
barCodeitem-mat.cod-eanCódigo GTIN do item informado no programa CD0903
lengthitem.comprimComprimento do item informada no programa CD0903
heightitem.alturaAltura do item informada no programa CD0903
widthitem.larguraLargura do item informada no programa CD0903
weightitem.peso-liquidoPeso líquido do item informado no programa CD0903
realWeightitem.peso-brutoPeso bruto do item informado no programa CD0903
measurementUnititem.unUnidade de medida informada para o item no programa CD0204
productRootCodeitem.it-codigoCódigo do item no ERP 

Caso o item possua o tipo de controle de estoque por referência, algumas informações serão buscadas da tabela ref-item:

SERIALIZE-NAMETABELA.CAMPO ERPDescrição
referenceCoderef-item.cod-referCódigo da Família Comercial a qual o item pertence no ERP
itemCoderef-item.cod-item Código do item 
itemDescriptionitem.desc-item Descrição do item 
isActiveitem.cod-obsoletoDefine se o item estará ativo no e-commerce (totalmente obsoleto no CD0204, significa que o item estará inativo no e-commerce)
erpLastChangeitem-log.dtm-alterData e hora da última criação ou alteração do registro 
barCodeitem-mat.cod-eanCódigo GTIN do item informado no programa CD0903
lengthref-item.comprimComprimento do item informada no programa CD0903
heightref-item.alturaAltura do item informada no programa CD0903
widthref-item.larguraLargura do item informada no programa CD0903
weightref-item.peso-liquidoPeso líquido do item informado no programa CD0903
realWeightref-item.peso-brutoPeso bruto do item informado no programa CD0903
measurementUnititem.unUnidade de medida informada para o item no programa CD0204
productRootCodeitem.it-codigoCódigo do item no ERP 

04. SALDO EM ESTOQUE

Ao cadastrar um item no programa PD0623, e um depósito no programa PD0628, o saldo em estoque do item informado no programa PD0623, com o depósito e estabelecimento informado no PD0028, será verificado o saldo em estoque disponível desse item/estabelecimento/depósito e enviado do ERP Datasul para o E-commerce.

No momento que é cadastrado um depósito no programa PD0628, será gerado um registro na tabela: tab-integr-loja-cia.

Na tabela movto-estoq fica armazenada o código do item, estabelecimento, depósito e a data e hora da última criação ou alteração do registro.

Na primeira carga dos itens do ERP Datasul para o e-commerce, todos os saldo em estoque disponíveis dos depósitos gravados na tabela tab-integr-loja-cia serão enviadas para o e-commerce. 

Nas cargas posteriores serão considerados as definições dos itens que possuírem registros na tabela movto-estoq.

No Programa PD0623 o item IPHONE 13 foi definido como um item a ser integrado no e-commerce.

No programa PD0628 foi definido que os depósitos que terão seu saldo em estoque disponível para o e-commerce, para o estabelecimento 1 serão fab, alm e esp:

Portanto se o item IPHONE 13 possuir saldo em estoque cadastrado no estabelecimento 1, para um dos depósitos (fab, alm e esp) o saldo em estoque disponível será enviado para o e-commerce:

Na imagem acima, o item IPHONE 13, tem saldo em estoque cadastrado para o estabelecimento 1, somente no depósito fab. Portando somente o saldo disponível no estoque fab do estabelecimento 1 será enviado para o e-commerce. 

Se desejar enviar também o saldo em estoque disponível dos outros depósitos informados no programa PD0628 (alm e esp) será necessário cadastrar saldo em estoque para o item IPHONE 13 e estabelecimento 1 nos depósitos alm e esp.

Para confirmar que as definições do saldo em estoque foram realizadas corretamente e serão enviadas para o e-commerce, e que será possível visualizar os dados que estão sendo enviados do ERP Datasul para VTEX, é possível realizar uma requisição REST para o servidor onde a integração será executada por meio da ROTA:

GET - http://[servidor]/dts/datasul-rest/resources/prg/cep/v1/stockBalancePublic/ecommerce

A autorização para acesso é feita por meio de autenticação Basic Auth, informando usuário e senha de um usuário cadastrado no ERP:


Para retornar todas as definições do saldo em estoque informado para o item cadastrado no programa PD0623, e depósito e estabelecimento no programa PD0628 (e que sofreram uma alteração no saldo em estoque disponível) a partir de uma última data e hora de atualização do registro utilizar a ROTA:

GET http://servidor/dts/datasul-rest/resources/prg/cep/v1/stockBalancePublic/ecommerce?lastUpdate=2022-02-17T00:00:00.001

Necessário informar o Query Params lastUpdate no formato de data e hora: 2022-02-17T00:00:00.001

Neste exemplo serão buscadas todo o saldo em estoque disponível criado/alterado a partir do dia 17-02-2022 e do horário 00:00:00:

O JSON que envia as informações das definições do saldo em estoque do ERP Datasul para o e-commerce é composto dos seguintes campos:

SERIALIZE-NAMETABELA.CAMPO ERPDescrição
branchCodesaldo-estoq.cod-estabelCódigo do estabelecimento a qual o saldo em estoque foi vinculado no ERP
itemCodesaldo-estoq.it-codigoCódigo do item a qual o saldo em estoque foi vinculado no ERP. Caso o item seja possua o controle de estoque por referência, a tag itemCode será preenchida dessa forma: saldo-estoq.it-codigo|saldo-estoq.cod-refer
referenceCodesaldo-estoq.cod-referReferência do item a qual o saldo em estoque foi vinculado no ERP
warehouseCodecod-deposDepósito a qual o saldo em estoque foi vinculado no ERP
erpLastChangeDATETIME-TZ(MONTH(movto-estoq.dt-trans), DAY(movto-estoq.dt-trans), YEAR(movto-estoq.dt-trans), INTEGER(ENTRY(1, movto-estoq.hr-trans, ':')), INTEGER(ENTRY(2, movto-estoq.hr-trans, ':')), INTEGER(ENTRY(3, movto-estoq.hr-trans, ':')), 0)Data e hora da última criação ou alteração do registro 
quantitysaldo-estoq.qtidade-atu  -                            saldo-estoq.qt-alocada   -                             saldo-estoq.qt-aloc-prod -                            saldo-estoq.qt-aloc-ped. Define o saldo disponível em estoque (campo não disponível na tabela do banco de dados, apenas de controle interno no ERP)

05. TABELA DE PREÇO

Ao cadastrar uma tabela de preço no programa PD0627, a tabela de preço será enviada do ERP Datasul para o E-commerce.

No momento que é cadastrado um item no programa PD0627, será gerado um registro na tabela: tab-integr-loja-cia

Na tabela tab-preco-log fica armazenada o código da tabela e a data e hora da última criação ou alteração do registro.

Na primeira carga dos itens do ERP Datasul para o e-commerce, todas as definições dos itens gravados na tabela tab-integr-loja-cia serão enviadas para o e-commerce. 

Nas cargas posteriores serão considerados as definições dos itens que possuírem registros na tabela tab-preco-log.

Para confirmar que as tabelas de preços serão enviadas para o e-commerce e visualizar os dados que estão sendo enviados do ERP Datasul para VTEX, é possível realizar uma requisição REST para o servidor onde a integração será executada por meio da ROTA:

GET - http://[servidor]/dts/datasul-rest/resources/prg/cdp/v1/priceTablePublic/ecommerce

A autorização para acesso é feita por meio de autenticação Basic Auth, informando usuário e senha de um usuário cadastrado no ERP:

Para retornar todas as tabelas de preços cadastradas no programa PD0627 (e que sofreram uma alteração no programa CD1508) a partir de uma última data e hora de atualização do registro utilizar a ROTA:

GET http://servidor/dts/datasul-rest/resources/prg/cdp/v1/priceTablePublic/ecommerce?lastUpdate=2022-02-17T00:00:00.001

Necessário informar o Query Params lastUpdate no formato de data e hora: 2022-02-17T00:00:00.001

Neste exemplo serão buscadas todas as tabelas de preços criadas/alteradas a partir do dia 17-02-2022 e do horário 00:00:00:

O JSON que envia as informações da tabela de preço do ERP Datasul para o e-commerce é composto dos seguintes campos:

SERIALIZE-NAMETABELA.CAMPO ERPDescrição
priceTableCodetb-preco.nr-tabpreCódigo da tabela de preço no ERP
initialDatetb-preco.dt-inivalData de início de validade da tabela de preço no ERP. 
finalDatetb-preco.dt-fimvalData final de validade da tabela de preço no ERP
priceTableDescriptiontb-preco.descricaoDescrição da tabela de preço no ERP
erpLastChangetb-preco.dtm-alterData e hora da última criação ou alteração do registro 
isActivetb-preco.situacaoDefine se a tabela de preço estará ativa no e-commerce ( informação não utilizada no e-commerce)

06. ITEM DA TABELA DE PREÇO 

Para que um item tenha seu preço enviado do ERP Datasul  para o e-commerce, será necessário cadastrar um item no programa PD0623, informar um preço para este item no programa CD1508 e que a tabela a qual este item está vinculado, esteja informada no PD0627. Com esta parametrização será enviado o preço do item do ERP Datasul para o E-commerce.

No momento que é cadastrado um preço para o item na tabela de preço no programa CD1508, será gerado um registro na tabela: preço-item.

Na tabela preco-item-log fica armazenado o código do item, tabela de preço, preço do item e a data e hora da última criação ou alteração do registro.

Na primeira carga dos itens do ERP Datasul para o e-commerce, todos os preços dos itens informados no programa PD0623, das tabelas de preço do programa PD0627 e que tenham preço cadastrados no CD1508, serão enviadas para o e-commerce. 

Nas cargas posteriores serão considerados as definições dos preços dos itens que possuírem registros na tabela preco-item-log.

No Programa PD0623 o item IPHONE 13 foi definido como um item a ser integrado no e-commerce.

No programa PD0627 foi definido que a tabela de preço VTEX é uma tabela a ser integrada do ERP Datasul para o e-commerce:

E no programa CD1508 foi cadastrado um preço para o item IPHONE 13 na tabela de preço VTEX:

Com isso o preço do item IPHONE 13 da tabela de preço VTEX será enviado do ERP Datasul para o e-commerce.

Para confirmar que as tabelas de preços serão enviadas para o e-commerce e visualizar os dados que estão sendo enviados do ERP Datasul para VTEX, é possível realizar uma requisição REST para o servidor onde a integração será executada por meio da ROTA:

GET - http://[servidor]/dts/datasul-rest/resources/prg/cdp/v1/priceItemPublic/ecommerce

A autorização para acesso é feita por meio de autenticação Basic Auth, informando usuário e senha de um usuário cadastrado no ERP:

Para retornar todos os preços dos itens das tabelas de preços cadastradas no programa PD0627 (e que sofreram uma alteração no preço programa CD1508) a partir de uma última data e hora de atualização do registro utilizar a ROTA:

GET http://servidor/dts/datasul-rest/resources/prg/cdp/v1/priceItemPublic/ecommerce?lastUpdate=2022-02-17T00:00:00.001

Necessário informar o Query Params lastUpdate no formato de data e hora: 2022-02-17T00:00:00.001

Neste exemplo serão buscadas todas as tabelas de preços criadas/alteradas a partir do dia 17-02-2022 e do horário 00:00:00:

O JSON que envia as informações dos preços dos itens da tabela de preço do ERP Datasul para o e-commerce é composto dos seguintes campos:

SERIALIZE-NAMETABELA.CAMPO ERPDescrição
priceTableCodepreço-item.nr-tabpreCódigo da tabela de preço no ERP
startDatepreco-item.dt-inivalData de início de validade do preço do item da tabela de preço no ERP. 
endDateendDateDefine a data final de validade do preço do item da tabela de preço  (campo não disponível na tabela do banco de dados, apenas de controle interno no ERP)
itemCodepreco-item.it-codigoCódigo do item no ERP. Caso o item possua o controle de estoque por referência, a tag itemCode será preenchida dessa forma: preco-item.it-codigo|preco-item.cod-refer
erpLastChangepreco-item.dtm-alter

Data e hora da última criação ou alteração do registro 

isActivepreco-item.situacaoDefine se o preço do item da tabela de preço estará ativo no e-commerce ( informação não utilizada no e-commerce)
pricepreco-item.preco-fobPreço do item na tabela de preço no ERP
priceItemKeypriceItemKeyDefine a chave do preço do item da tabela de preço (preco-item.nr-tabpre|preco-item.it-codigo|preco-item.cod-refer|preco-item.cod-unid-med|preco-item.dt-inival|reco-item.quant-min) para encontrar este registro no e-commerce (campo não disponível na tabela do banco de dados, apenas de controle interno no ERP)