Histórico da Página

...

Totvs custom tabs box

tabs	Dados integrados c/ Winthor, Gravação Pedido/Retorno, Consulta de Pedido, Cancelar Pedido
ids	passo1,passo2,passo3,passo4

A integração consiste em receber e enviar dados do pedido que serão utilizados no E-Commerce.

Totvs custom tabs box items

default	yes
referencia	passo1

Os dados integrados são:

"

API	PCPEDC	PCPEDI	Descrição	Tipo	Obrigatório
createData	pcpedc.data	pcpedi.data	Data de criação do pedido	Data (DD/MM/YYYY)	Sim
id	pcpedc.codcli	pcpedi.codcli	Identificador do Cliente	Numérico	Sim
orderId	pcpedc.numped	pcpedi.numped	Identificador do pedido	Numérico	Não
orderStatus	pcpedc.posicao		Estado do pedido - Veja mais	Texto	Não
chargingId	pcpedc.codcob		Identificador de cobrança. Caso não informada no cabeçalho do pedido, será gravada a cobrança padrão "BK";	Texto	Não
TotalPrice	pcpedc.vltotal		Preço total do pedido	Numérico	Não
paymentPlanId	pcpedc.codplpag		Identificador do plano de pagamento	Texto	Sim
saleType	pcpedc.condvenda

Tipo de venda

1

" "

- Venda normal

5

""

- Bonificação ou brinde.*

7

" "

- Venda para Entrega Futura*

8

"

- Simples Remessa de Venda para Entrega Futura* Para uso futuro.	Numérico	Sim
branchId	pcpedc.codfilial		Código da Filial	Texto	Sim
saleOrigin	pcpedc.origemped		Origem do pedido do Winthor ex: B=Balcão R=Balcão Reserva K=Venda Broker C=Callcenter F=Força de Venda T=Telemarketing W=Venda WEB A=Auto Serviço (Varejo)	Texto	Não
comissionPercent		pcpedi.percom	Percentual de comissão	Numérico	Não
productSKUERPReferenceKey		pcpedi.codprod	Embalagem do produto	Texto	Sim
sellPrice		pcpedi.pvenda	Preço do produto	Numérico	Sim
quantity		pcpedi.qt	Quantidade do produto	Numérico	Sim
realCost		pcpedi.vlcustoreal	Custo Real	Numérico	Não
warehouseBranchId		pcpedi.codfilialretira	Filial Retira, Caso não informado assume a filial do pedido branchId	Texto	Sim
position		pcpedi.numseq	Sequência de registro do item no pedido	Numérico	Não
taxFigureId		pcpedi.codst	Figura tributária da rotina 514	Numérico	Não
discountValue		pcpedi.perdesc	Percentual de desconto aplicado no item	Numérico	Não
valueFreight	pcpedc.vlfrete		Valor de frete	Numérico	Não
	pcpedc.dtcalcfrete		Caso seja enviado o valor de frete (valueFreight) maior que zero, o campo (DTCALCFRETE) será preenchido.	Data (DD/MM/YYYY)	Não
intermediaryCompanyName	pcpedc.descintermediador		Razão Social do Intermediador marketplace ou e-commerce	Texto	Não
idIntermediaryEmployer	pcpedc.cnpjintermediador		CNPJ do Intermediador marketplace ou e-commerce	Texto	Não
carrierId	pcpedc.codfornecfrete		Identificado da transportadora	Numérico	Não
seller	pcpedc.codusur	pcpedi.codusur	Código do RCA, caso não enviado será utilizado o definido no parâmetro "4012 - Código do RCA para cadastro de clientes na Ciashop" da rotina 132- Parâmetros da Presidência	Numérico	Não
lastChange	pcpedc.dtfat (prioridade 1)		Data de faturamento do pedido	Data (DD/MM/YYYY)	Não
lastChange	pcpedc.data (prioridade 2)		Data de emissão do pedido	Data (DD/MM/YYYY)	Não
orderIdHube	pcpedc.numpedhube		Número do pedido realizado via hube ou conector	Texto	Não
orderIdMktplace	pcpedc.numpedmktplace		Número do pedido realizado via marketplace	Texto	Não
freightDispatch	pcpedc.fretedespacho		Utiliza despacho de frete (freteiros) Valores: "C" - CIF - Contratação do Frete por conta do Remetente ( Tag ModFrete Nfe= 0) "F" - FOB - Contratação do Frete por conta do Destinatário ( Tag ModFrete Nfe= 1) "T" - Contratação do Frete por conta de Terceiros ( Tag ModFrete Nfe= 2) "R" - Transporte Próprio por conta do Remetente ( Tag ModFrete Nfe= 3) "D" - Transporte Próprio por conta do Destinatário ( Tag ModFrete Nfe= 4) "G" - Gratuito - Sem Ocorrência de Transporte ( Tag ModFrete Nfe= 9)	Texto	Não
uniqueSequentialNumber	pcpedc.nsu		NSUTEF - Apenas para forma de pagamento

cartão

Numérico

String	Não
dateUniqueSequentialNumber	pcpedc.dtnsu		Data do número sequencial único do cartão de crédito	Data (DD/MM/YYYY)	Não
otherExpenses	pcpedc.vloutrasdesp		Outras despesas	Numérico	Não
gift		pcpedi.bonific	Item bonificado/brinde	Boolean	Não
observation	pcpedc.obs		Observação do pedido	String	Não
deliveryType		pcpedi.tipoentrega

Tipo de entrega
Valores:

RP - Retira Posterior

| RI - Retira Imediata

| EN - Entrega Normal

Valores:

| EF - Encomenda

*Obs: disponível a partir da versão: 1.2.0.1078

String

Não

deliveryStatus

Status Entrega

A:

Aguardando

Aguardando | R: Pronto Retirada

\| E: Entregue *Obs: disponível a partir da versão: 1.2.0.1078	String	Não
deliveryAddressId	pcpedc.codendentcli		Código do endereço de entrega Obs: disponível a partir da versão: 1.2.0.1097*	Numérico	Não
sellPriceIPI	pcpedi.vlipi		Valor do IPI	Numérico	Não
shippingTrackingCodeSale	pcpedc.codigorastreiofretevenda		Código de rastreio do frete para uma venda	String	Não

Totvs custom tabs box items

default	no
referencia	passo2

Exemplo do envio da requisição:

Bloco de código

language	js
title	URI

method: 'POST',
url: '/api/wholesale/v1/orders/'

Bloco de código

language	js
title	Body Request

{
    "createData": "2020-03-23T13:24:36.955102+13:24",
    "orderIdHube": "string",
    "orderIdMktplace": "string",
    "orderStatus": "string",
    "chargingId": "string",
    "carrierId": 0,
	"seller": 0,
    "paymentPlanId": 0,
	"observation": 0,
    "saleType": 0,
	"freightDispatch": "string",
    "branchId": "string",
	"TotalPrice": 0,
    "saleOrigin": "W",
    "uniqueSequentialNumber": "string",
    "dateUniqueSequentialNumber": "string",
    "intermediaryCompanyName": "string",
    "idIntermediaryEmployer": "string",
    "valueFreight": 0,
	"CustomerVendorInternalId": "string",
	"position": 0,
    "otherExpenses": 0
	"deliveryAddressId":0,
    "shippingTrackingCodeSale": "AA1234567892",    

    "customer": {
        "id": 0
    },
	"permissions": {
        "acceptOrderWithoutTax": true,
	 	"acceptSearchAutomaticFreightType": false
    },
	/** Somente enviado para a utilização do cenário de múltiplas cobranças **/
	"listPayment": [
        {
            "chargingId" : "string",
            "paymentPlanId" : 0,
            "expirationDate" : "0000-00-00T00:00:00",
            "value" : 0.0,
            "nsu" : 0
        }
    ],
	"listOfOrderItem": [
        {
            "productSKUERPReferenceKey": "string",
            "sellPrice":0,
			"discountValue":0,
            "quantity": 0.0,
            "realCost": 0.0,
            "warehouseBranchId": "string",
            "gift": true,
            "giftPrice": 0,
            "taxFigureId": 0,                   
            "deliveryType": "RI"
             "deductionsCmv": {
                "discountsCofins": 0,
                "discountsIcms":  0,
                "discountsPis": 0
            
             }    
        }
   ]
}

Bloco de código

language	js
title	Body Response

{
    "branchId": "string",
    "carrierId": 0,
    "chargingId": "string",
    "createData": "2021-08-06T15:40:00.000000+15:40",
    "customer": {
        "activityId": 0,
        "addressInfo": "",
        "billingAddress": "",
        "billingZipCode": "",
        "businessDistrict": "",
        "cityId": 0,
        "commercialAddress": "",
        "commercialZipCode": "",
        "corporate": false,
        "corporatePhone": "",
        "countryId": 0,
        "email": "",
        "finalCostumer": false,
        "id": 0,
        "paymentPlanId": 0,
        "sellerId": 0,
        "squareId": 0,
        "stateInscription": "",
        "tradeName": ""
    },
    "lastChange": "2021-08-06T15:40:00",
	/** Somente retornado em caso de utilização do cenário de múltiplas cobranças **/
	"listPayment": [
        {
            "chargingId" : "string",
            "paymentPlanId" : 0,
            "expirationDate" : "0000-00-00T00:00:00",
            "value" : 0.0,
            "nsu" : 0
        }
    ],     
	"listOfOrderItem": [
        {
            "accountingCost": 0.0,
            "basePriceRCA": 0.0,
            "comissionPercent": 0,
			"discountPercentage": 0,             
			"fecp": 0,
            "financialCost": 0.0,
            "gift": false,
            "giftPrice": 0,
            "packingId": 0,
            "position": 0,
            "productId": 0,
            "productSKUERPReferenceKey": "00000-00",
            "quantity": 0.0,
            "realCost": 0.0,
            "replacementCost": 0.0,
            "resourceValueCMV": 0,
            "resourceValueCustumerCMV": 0,
            "sellPrice": 0.0,
            "sellPriceBaseST": 0,
            "sellPriceIPI": 0,
            "sellPriceST": 0,
            "stGNRE": 0,
            "tablePrice": 0.0,
            "tablePriceIPI": 0,
            "tablePriceST": 0,
            "taxFigureId": 0,
            "truncItem": false,
            "wantageQuantity": 0,
            "warehouseBranchId": "string",
            "deliveryType": "RI",
            "deliveryStatus": "R"         
        }
    ],
	"permissions": {
        "acceptOrderWithoutTax": true,
	 	"acceptSearchAutomaticFreightType": false
    },
    "orderId": "string",
    "orderIdHube": "string",
	"orderIdMktplace: "string",
    "orderStatus": "string",
    "otherExpenses": 0,
    "paymentPlanId": 0,
    "saleOrigin": "W",
    "saleType": 0,
    "saleTypePayment": "string",
    "totalValue": "0.0",
	"observation": "string",
    "shippingTrackingCodeSale": "string" }

Totvs custom tabs box items

default	no
referencia	passo3

As consultas referente aos pedido, apresentam o JSON na resposta da requisição:

Bloco de código

language	js
title	URI

method: 'GET',
url: '/api/wholesale/v1/orders/'      -> Passar no Parms o campo orderId, para obter dados do pedido.

OU 

url: '/api/wholesale/v1/orders/list'  -> Passar na requisição os dados do Parms abaixo.

Bloco de código

language	js
title	Params

branchId          : 0					- Código da Filial **requerido
daysOfSearch      : 0					- Dias de Pesquisa (Se não informado, o padrão será 15 dias)
orderId		      : 0					- Número Pedido
lastChange        : 2021-03-02T16:43:00	- Última alteração
viewDocument  	  : true/ false			- Dados da nota fiscal 
saleOrigin   	  : T					- Origem Venda (Todas existentes no Winthor) Padrão W
order		 	  : lastChange			- Ordenação de busca 
orderStatus  	  : C					- Status do Pedido
page		 	  : 1					- Número Página
pageSize     	  : 10					- Tamanho da página
hasOrderIdHube	  : true/ false			- Pedidos que com id de Hube - Disponível a partir da versão 1.0.84.229(Winthor-pedido-venda) 
hasOrderIdMktplace: true/ false			- Pedidos que com id de Marketplace  - Disponível a partir da versão 1.0.84.229(Winthor-pedido-venda)   
integrationOrigin :             		- Filtra pela coluna ORIGEMINTEGRACAO - Disponível a partir da versão 1.3.0.40(Winthor-pedido-venda)

Bloco de código

language	js
title	Body Response

{
    "branchId": "string",
    "carrierId": 0,
    "chargingId": "string",
    "createData": "2021-08-06T15:40:00.000000+15:40",
    "customer": {
        "activityId": 0,
        "addressInfo": "",
        "billingAddress": "",
        "billingZipCode": "",
        "businessDistrict": "",
        "cityId": 0,
        "commercialAddress": "",
        "commercialZipCode": "",
        "corporate": false,
        "corporatePhone": "",
        "countryId": 0,
        "email": "",
        "finalCostumer": false,
        "id": 0,
        "paymentPlanId": 0,
        "sellerId": 0,
        "squareId": 0,
        "stateInscription": "",
        "tradeName": ""
    },
    "document": {
        "createData": "1900-01-01T00:00:00",
        "documentNumber": 0,
        "keyDocument": "",
        "lastChange": "1900-01-01T00:00:00"
    },
    "lastChange": "2021-08-06T15:40:00",
	/** Somente retornado em caso de utilização do cenário de múltiplas cobranças **/
	"listPayment": [
        {
            "chargingId" : "string",
            "paymentPlanId" : 0,
            "expirationDate" : "0000-00-00T00:00:00",
            "value" : 0.0,
            "nsu" : 0
        }
    ],
     "listOfOrderItem": [
        {
            "accountingCost": 0.0,
            "basePriceRCA": 0.0,
            "comissionPercent": 0,
			"discountPercentage": 0,
            "fecp": 0,
            "financialCost": 0.0,
            "gift": false,
            "giftPrice": 0,
            "packingId": 0,
            "position": 0,
            "productId": 0,
            "productSKUERPReferenceKey": "00000-00",
            "quantity": 0.0,
            "realCost": 0.0,
            "replacementCost": 0.0,
            "resourceValueCMV": 0,
            "resourceValueCustumerCMV": 0,
            "sellPrice": 0.0,
            "sellPriceBaseST": 0,
            "sellPriceIPI": 0,
            "sellPriceST": 0,
			"sellPriceIcmsPart": 0,
            "stGNRE": 0,
            "tablePrice": 0.0,
            "tablePriceIPI": 0,
            "tablePriceST": 0,
            "taxFigureId": 0,
            "truncItem": false,
            "wantageQuantity": 0,
            "warehouseBranchId": "string"
        }
            "deductionsCmv": {
                "discountsCofins": 0,
                "discountsIcms":  0,
                "discountsPis": 0
            }     
   ],
	"permissions": {
        "acceptOrderWithoutTax": true,
	 	"acceptSearchAutomaticFreightType": false
    },
    "orderId": "string",
    "orderIdHube": "string",
	"orderIdMktplace: "string",
    "orderStatus": "string",
    "otherExpenses": 0,
    "paymentPlanId": 0,
    "saleOrigin": "W",
    "saleType": 0,
    "saleTypePayment": "string",
    "totalValue": "0.0",
	"observation": "string",
    "shippingTrackingCodeSale": "string" }

Totvs custom tabs box items

default	no
referencia	passo4

As requisições de Cancelamento referente aos pedido, apresentam o JSON na resposta da requisição:

Bloco de código

language	js
title	URI

method: 'DELETE',
url: '/api/wholesale/v1/orders/'      -> Passar no Parms o campo id e Motivo para cancelar o pedido

Bloco de código

language	js
title	Params

Id		            : 0					- ID/Número Pedido (Obrigatório)
sendMessageRca      : true/ false		- Enviar mensagem pro RCA? 
reasonCancellation  : C					- Motivo Cancelamento (Obrigatório)

...

Páginas filhas

Versões comparadas

Versão antiga 84

Nova versão Atual

Chave