Expandir

title	Sobre as APIs

Nossas APIs são baseadas no protocolo HTTP E possui URLs previsíveis, é orientada a recursos e utiliza códigos de resposta HTTP para indicar sucesso ou erros e exceções.

As respostas (incluindo os erros) e o corpo das requisições são obrigatoriamente formatados em JSON.

Sobre as requisições à API

Os seguintes verbos HTTP estão disponíveis para uso:

Verbo	Descrição
GET	Solicita dados de um recurso
POST	Cria um novo recurso
PUT	Atualiza um recurso
DELETE	Exclui um recurso

Cabeçalho das requisições

O cabeçalho de requisição HTTP usado é:

Accept: application/json

Content-Type: application/json

** Deve-se especificá-los no header das requisições à API.

Autenticação/Autorização

Utilizamos o Apache Shiro para identificar se a solicitação de acesso a API está autenticada, portanto apenas passar No Auth no Type AuthSerá necessário estar logado no sistema WTA.

Erros & Respostas

Utilizamos os códigos de resposta HTTP convencionais para indicar sucesso ou falha em uma solicitação à API.

Respostas de informação (100-199),
Respostas de sucesso (200-299),
Redirecionamentos (300-399)
Erros do cliente (400-499)
Erros do servidor (500-599).

URI Parameters

Alguns recursos disponibilizados podem oferecer a possibilidade de utilização de “URI Parameters” amigáveis.
Os parâmetros quando disponíveis são:

• filter - Habilita filtragem (consulta) de resultados.

Expandir

title	Lista de APIs disponíveis

Expandir

title	Login

Para obter/renovar o token de autenticação, inclua os dados nos campos a seguir:

POST: /winthor/autenticacao/v1/login

username	Nome de usuário.
password	Senha de acesso.

Expandir

title	customer

Ao performar a requisição será preenchida a tabela temporária PCLIENTFV, assim que finalizar a importação, poderá ser visualizado o cadastro através da rotina 302 302 - Cadastrar Cliente.

URI : /salesForce/customer

Expandir

title	POST/PUT

Deverá performar a requisição passando os campos referentes a tabela

tanto

para incluir

um novo registro quanto para

/alterar um registro

existente:

.

/salesForce/customer	PCCLIENTFV
imported	IMPORTADO
operationType	TIPOOPERACAO
personIdentificationNumber	CGCENT
customerName	CLIENTE
ieInput	IEENT
squareCod	CODPRACA
tradeName	FANTASIA
imEnt	IMENT
identification	RG
organRG	ORGAORG
customerIdPalm	CODCLIPALM
codeAtv1	CODATV1
inputAddress	ENDERENT
inputNumber	NUMEROENT
inputComplement	COMPLEMENTOENT
inputDistrict	BAIRROENT
phoneNumber	TELENT
city	MUNICENT
state	ESTENT
zipCode	CEPENT
country	PAISENT
referencePoint	PONTOREFER
billingAddress	ENDERCOB
addOnCollection	COMPLEMENTOCOB
billingNumber	NUMEROCOB
billingDistrict	BAIRROCOB
billingPhone	TELCOB
billingCity	MUNICCOB
billingState	ESTCOB
billingZipCode	CEPCOB
businessAddress	ENDERCOM
businessNumber	NUMEROCOM
businessComplement	COMPLEMENTOCOM
businessDistrict	BAIRROCOM
businessCity	MUNICCOM
businessState	ESTCOM
businessZipCode	CEPCOM
businessPhone	TELCOM
businessFax	FAXCOM
userId1	CODUSUR1
userId2	CODUSUR2
clientFax	FAXCLI
ownBuilding	PREDIOPROPRIO
note	OBS
obs2	OBS2
note3	OBS3
note4	OBS4
creditNote	OBSCREDITO
phoneNumber1	TELENT1
email	EMAIL
mailbox	CAIXAPOSTAL
noteDelivery1	OBSENTREGA1
noteDelivery2	OBSENTREGA2
noteDelivery3	OBSENTREGA3
noteDelivery4	OBSENTREGA4
bankNumber1	NUMBANCO1
agencyNumber1	NUMAGENCIA1
currentAccountNumber1	NUMCCORRENTE1
bankNumber2	NUMBANCO2
agencyNumber2	NUMAGENCIA2
currentAccountNumber2	NUMCCORRENTE2
amountCheckOut	QTCHECKOUT
site	SITE
managerialObs1	OBSGERENCIAL1
managerialObs2	OBSGERENCIAL2
managerialObs3	OBSGERENCIAL3
latitude	LATITUDE
longitude	LONGITUDE
dateCollect	DATACOLETA
notePackage	OBSERVACAO_PC
createDate	DTINCLUSAO
customerId	CODCLI
lastChange	DTALTERACAO
chargingId	CODCOB
paymentPlanId	CODPLPAG
emailElectronicInvoice	EMAILNFE
branchCodeIBGE	CODCIDADEIBGE
warehouseBranchId	CODFILIALNF
finalCostumer	CONSUMIDORFINAL
taxpayer	CONTRIBUINTE
customerProtest	CLIENTPROTESTO
sendingInvoiceCommercialEmail	ENVIONFEMAILCOM
weekday	DIASEMANA
numberWeek	NUMSEMANA
sequence	SEQUENCIA
periodicity	PERIODICIDADE
simpleNational	SIMPLESNACIONAL
countryCode	CODPAIS
birthDate	DTNASC
reasonRejection	MOTIVOREJEICAO
shippingDispatch	FRETEDESPACHO
clientPhone	TELCELENT
dateExclusion	DTEXCLUSAO
userIdDeleted	CODUSUARIOEXC
reasonExclusion	MOTIVOEXCLUSAO
calculatesST	CALCULAST
clientFontEst	CLIENTEFONTEST
participateFunCep	PARTICIPAFUNCEP

Expandir

title	DEL

Para excluir um registro deverá performar a requisição passando o(s) campo(s):

/salesForce/customer/	PCCLIENTFV
personIdentificationNumber	CGCENT

Expandir

title	customerReference

Ao performar a requisição será preenchida a tabela temporária PCCLIREFFV, com os dados de referência de cliente.

Expandir

title	POST/PUT

Deverá performar a requisição passando os campos referentes a tabela tanto para incluir um novo registro quanto para /alterar um registro existente:.

/salesForce/customerReference	PCCLIREFFV
imported	IMPORTADO
personIdentificationNumber	CGCCLI
referenceId	CODREF
customerId	CODCLI
referenceName	EMPREFER
referencePhone	TELREFER
referenceContact	CONTATOREFER
creditLimit	LIMCREDREFER
dateRegisterReference	DTCADASTROREFER
dateLastPurchase	DTULTCOMPREFER
valueLastPurchase	VLULTCOMPREFER
note	OBS
biggestPurchaseDate	DTMAIORCOMPREFER
biggestPurchaseValue	VLMAIORCOMPREFER
referenceChargeCode	CODCOBREFER
notePackage	OBSERVACAO_PC
dateIncluded	DTINCLUSAO

Expandir

title	DEL

Para excluir um registro deverá performar a requisição passando o(s) campo(s):

/salesForce/customerReference/	PCCLIREFFV
personIdentificationNumber	CGCCLI
referenceId	CODREF

Expandir

title	gondola

/api/wholesale/v1/salesForce/gondola

Ao performar a requisição será preenchida a tabela temporária PCGONDOLAFV.

Expandir

title	POST/PUT

Deverá performar a requisição passando os campos referentes a tabela para incluir/alterar um registro.

/salesForce/gondola	PCGONDOLAFV
imported	IMPORTADO
countNumber	NUMCONTAGEM
sellerId	CODUSUR
dateCount	DTCONTAGEM
personIdentificationNumber	CGCCLI
concurrentId	CODCONC
startTime	HORAINICIAL
endTime	HORAFINAL
notePackage	OBSERVACAO_PC
dateInclusion	DTINCLUSAO
customerId	CODCLI
lastChange	DTALTERACAO
numberVisit	NUMVISITA

Expandir

title	DEL

Para excluir um registro deverá performar a requisição passando o(s) campo(s):

/salesForce/gondola/	PCGONDOLAFV
countNumber	NUMCONTAGEM
sellerId	CODUSUR
personIdentificationNumber	CGCCLI

Expandir

title	gondolaItem

/api/wholesale/v1/salesForce/gondolaItem

Ao performar a requisição será preenchida a tabela temporária PCGONDOLAIFV.

Expandir

title	POST/PUT

Deverá performar a requisição passando os campos referentes a tabela para incluir/alterar um registro.

/salesForce/gondolaItem	PCGONDOLAIFV
numberCount	NUMCONTAGEM
productId	CODPROD
quantity	QT
sellPrice	PVENDA
sellerId	CODUSUR
personIdentificationNumber	CGCCLI
notePackage	OBSERVACAO_PC
dateInclusion	DTINCLUSAO
dateUpdate	DTALTERACAO
quantityLosses	QTPERDAS
spinSellout	GIROSELLOUT
spinMedium	GIROMEDIO

Expandir

title	DEL

Para excluir um registro deverá performar a requisição passando o(s) campo(s):

/salesForce/gondolaItem/	PCGONDOLAIFV
numberCount	NUMCONTAGEM
productId	CODPROD
sellerId	CODUSUR
personIdentificationNumber	CGCCLI

Expandir

title	indemnity

/api/wholesale/v1/salesForce/indemnity

Ao performar a requisição será preenchida a tabela temporária PCINDCFV.

Expandir

title	POST/PUT

Deverá performar a requisição passando os campos referentes a tabela para incluir/alterar um registro.

/salesForce/indemnity	PCINDCFV
id	CODINDENIZ
date	DATA
personIdentificationNumber	CGCCLI
branchId	CODFILIAL
numberPedrCa	NUMPEDRCA
indemnityType	TIPOINDENIZ
sellerId	CODUSUR
note	OBS
notePackage	OBSERVACAO_PC
imported	IMPORTADO
createData	DTINCLUSAO
customerId	CODCLI
lastChange	DTALTERACAO
indemnityNumber	NUMINDENIZ
toRecall	RETORNO

Expandir

title	DEL

Para excluir um registro deverá performar a requisição passando o(s) campo(s):

/salesForce/indemnity/	PCINDCFV
id	CODINDENIZ

Expandir

title	itemIndemnityOrder

/api/wholesale/v1/salesForce/itemIndemnityOrder

Ao performar a requisição será preenchida a tabela temporária PCINDIFV.

Expandir

title	POST/PUT

Deverá performar a requisição passando os campos referentes a tabela para incluir/alterar um registro.

/salesForce/itemIndemnityOrder	PCINDIFV
id	CODINDENIZ
productId	CODPROD
quantity	QT
sellPrice	PVENDA
note	OBS
notePackage	OBSERVACAO_PC
toRecall	RECOLHER
dateInclusion	DTINCLUSAO
dateUpdate	DTALTERACAO

Expandir

title	DEL

Para excluir um registro deverá performar a requisição passando o(s) campo(s):

/salesForce/itemIndemnityOrder/	PCINDIFV
id	CODINDENIZ
productId	CODPROD

Expandir

title	cutsMadeOrders

/api/wholesale/v1/salesForce/cutsMadeOrders

Ao performar a requisição será preenchida a tabela temporária PCRECEBIMENTOFV.

Expandir

title	POST/PUT

Deverá performar a requisição passando os campos referentes a tabela para incluir/alterar um registro.

/salesForce/cutsMadeOrders	PCRECEBIMENTOFV
orderIdPalm	NUMPEDRCA
sellerId	CODUSUR
invoiceTtransaction	NUMTRANSVENDA
receiptNumber	NUMRECEBIMENTO
customerId	CODCLI
installmentNumber	PREST
invoiceNumber	DUPLIC
installmentPrice	VALOR
chargingId	CODCOB
branchId	CODFILIAL
bankNumber	NUMBANCO
agencyNumber	NUMAGENCIA
checkNumber	NUMCHEQUE
note	OBS
note1	OBS2
employeId	CODFUNCINC
bankId	CODBANCO
currentAccountNumber	NUMCONTACORRENTE
personIdNumberCheckIssuer	CGCCPFCH
agencyCheckDigit	DVAGENCIA
checkDigitChecker	DVCHEQUE
accountCheckDigit	DVCONTA
inclusionDate	DTINCLUSAO
issueDate	DTEMISSAO
dueDate	DTVENC
ourBankNumber	NOSSONUMBANCO
barCode	CODBARRA
digitableLine	LINHADIG
validationControl	VERIFICADO
notePackage	OBSERVACAO_PC
carrierId	NUMCAR
bankCheckClearing	COMPENSACAOBCO
interestRate	TXPERM
canceled	CANCELADO

Expandir

title	DEL

Para excluir um registro deverá performar a requisição passando o(s) campo(s):

/salesForce/cutsMadeOrders	PCRECEBIMENTOFV
orderIdPalm	NUMPEDRCA
sellerId	CODUSUR
installmentNumber	PREST
receiptNumber	NUMRECEBIMENTO

Expandir

title	message

/api/wholesale/v1/salesForce/message

Ao performar a requisição será preenchida a tabela temporária PCRECFUNCFV.

Expandir

title	POST/PUT

Deverá performar a requisição passando os campos referentes a tabela para incluir/alterar um registro.

/salesForce/message	PCRECFUNCFV
imported	IMPORTADO
destinationEmployeeId	CODFUNCDEST
subject	ASSUNTO
scrapText	TEXTORECADO
messageNumber	NUMRECADOFV
sellerId	CODUSUR
notePackage	OBSERVACAO_PC
dateIncluded	DTINCLUSAO
dateUpdate	DTALTERACAO

Expandir

title	DEL

Para excluir um registro deverá performar a requisição passando o(s) campo(s):

/salesForce/message	PCRECFUNCFV
messageNumber	NUMRECADOFV

Expandir

title	visit

/api/wholesale/v1/salesForce/visit

Ao performar a requisição será preenchida a tabela temporária PCVISITAFV.

Expandir

title	POST/PUT

Deverá performar a requisição passando os campos referentes a tabela para incluir/alterar um registro.

/salesForce/visit	PCVISITAFV
reasonCode	CODMOTIVO
date	DATA
startTime	HORAINICIAL
initialMinute	MINUTOINICIAL
finalHour	HORAFINAL
finalMinute	MINUTOFINAL
subjectMatter	ASSUNTO
personIdentificationNumber	CGCCLI
sellerId	CODUSUR
notePackage	OBSERVACAO_PC
imported	IMPORTADO
dateInclusion	DTINCLUSAO
customerId	CODCLI
lastChange	DTALTERACAO
routeId	CODROTA

Expandir

title	DEL

Para excluir um registro deverá performar a requisição passando o(s) campo(s):

/salesForce/visit	PCVISITAFV
sellerId	CODUSUR
personIdentificationNumber	CGCCLI

Expandir

title	giftOrderItem

Ao performar a requisição será preenchida a tabela temporária PCRETORNOITV5FV./api/wholesale/v1/salesForce/giftOrderItem

Expandir

title	POST/PUT

Deverá performar a requisição passando os campos referentes a tabela para incluir/alterar um registro.

/salesForce/giftOrderItem	PCRETORNOITV5FV
orderIdPalm	NUMPEDRCA
fullOrderDatePalm	DTABERTURAPEDPALM
rcaCode	CODUSUR
personIdentificationNumber	CGCCLI
orderNumber	NUMPEDORIGEM
orderNumberTV5	NUMPEDTV5
customerId	CODCLI
productId	CODPROD
barCode	CODAUXILIAR
quantity	QT
currentQuantity	QT_FATURADA
warehouseBranchId	CODFILIALRETIRA
listPrice	PTABELA
sequence	NUMSEQ
dateInclusion	DTINCLUSAO
dateUpdate	DTALTERACAO

Expandir

title	DEL

Para excluir um registro deverá performar a requisição passando o(s) campo(s):

/salesForce/giftOrderItem/	PCRETORNOITV5FV
orderIdPalm	NUMPEDRCA
fullOrderDatePalm	DTABERTURAPEDPALM
rcaCode	CODUSUR
productId	CODPROD
orderNumber	NUMPEDORIGEM

Expandir

title	order		formOfPayment

Ao performar a requisição será preenchida a tabela temporária PCFORMAPGTOPEDIDOFVMANIF.

Expandir

title	POST/PUT

Deverá performar a requisição passando os campos referentes a tabela para incluir/alterar um registro.

/salesForce/formOfPayment	PCFORMAPGTOPEDIDOFVMANIF
sellerOrderNumber	NUMPEDRCA
userId	CODUSUR
dateInclusion	DTINCLUSAO
billingCode	CODCOB
paymentPlanCode	CODPLPAG
dueDate	DTVENC
value	VALOR
integrationType	TIPOINTEGRACAO
creditCardCnpj	CNPJCREDCARTAO
authorizationNumber	NUMAUTORIZACAO
changeValue	VLRTROCO
inputValue	VLENTRADA

Expandir

title	DEL

Para excluir um registro deverá performar a requisição passando o(s) campo(s):

/salesForce/formOfPayment/	PCFORMAPGTOPEDIDOFVMANIF
sellerOrderNumber	NUMPEDRCA

Expandir

title	order

Ao performar a requisição será preenchida a tabela temporária

/api/wholesale/v1/salesForce/order

Expandir

title	POST/PUT

Deverá performar a requisição passando os campos referentes a tabela para incluir/alterar um registro.

Expandir

title	DEL

Para excluir um registro deverá performar a requisição passando o(s) campo(s):

Expandir

title	orderDetailSaleForce

Ao performar a requisição será preenchida a tabela temporária /api/wholesale/v1/salesForce/orderDetailSaleForce

Expandir

title	POST/PUT

Deverá performar a requisição passando os campos referentes a tabela para incluir/alterar um registro.

Expandir

title	DEL

Para excluir um registro deverá performar a requisição passando o(s) campo(s):

Expandir

title	formOfPayment	orderDetailPromptDelivery

Ao performar a requisição será preenchida a tabela temporária PCPEDCFVMANIF referente a Cadastro pedidos Pronta Entrega - TV14.

/api/wholesale/v1/salesForce/formOfPayment

Expandir

title	POST/PUT

Deverá performar a requisição passando os campos referentes a tabela para incluir/alterar um registro.

/salesForce/formOfPayment

PCFORMAPGTOPEDIDOFVMANIF

sellerOrderNumber

NUMPEDRCA

userId

CODUSUR

dateInclusion

DTINCLUSAO

billingCode

CODCOB

paymentPlanCode

CODPLPAG

dueDate

DTVENC

value

VALOR

integrationType

TIPOINTEGRACAO

creditCardCnpj

CNPJCREDCARTAO

authorizationNumber

NUMAUTORIZACAO

changeValue

VLRTROCO

inputValue

VLENTRADA

Expandir

title	DEL

Para excluir um registro deverá performar a requisição passando o(s) campo(s):

Expandir

title	orderItemPromptDelivery

Ao performar a requisição será preenchida a tabela temporária PCPEDIFVMANIF referente a Cadastro de itens de pedidos Pronta Entrega - TV14.

Expandir

title	POST/PUT

Deverá performar a requisição passando os campos referentes a tabela para incluir/alterar um registro.

Expandir

title	DEL

Para excluir um registro deverá performar a requisição passando o(s) campo(s):

Expandir

title	orderItemExchangePromptDelivery

Ao performar a requisição será preenchida a tabela temporária PCTROCAMANIF, com os itens de Troca pedidos Pronta Entrega - TV14

Expandir

title	POST/PUT

Deverá performar a requisição passando os campos referentes a tabela para incluir/alterar um registro.

Expandir

title	DEL

Para excluir um registro deverá performar a requisição passando o(s) campo(s):

Informações sobre a Integradora: Layout Padrão Para Integradoras.

...

Páginas filhas

Versões comparadas

Versão antiga 55

Nova versão 56

Chave

Sobre as requisições à API

Cabeçalho das requisições

Autenticação/Autorização

Erros & Respostas

URI Parameters

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 55

Nova versão 56

Chave

Sobre as requisições à API

Cabeçalho das requisições

Autenticação/Autorização

Erros & Respostas

URI Parameters