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 | Não | 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 | Texto | Não | chargingId | pcpedc.codcob | Identificador de cobrança | 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 | Numérico | Sim | branchId | pcpedc.codfilial | Código da Filial | Texto | Sim | saleOrigin | pcpedc.origemped | Origem do pedido | Texto | 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 | Código de praça | Texto | Sim | position | pcpedi.numseq | Sequência do 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 | 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 | lastChange | pcpedc.dtfat (prioridade 1) | Data de faturamento do pedido | Data | Não | lastChange | pcpedc.data (prioridade 2) | Data de emissão do pedido | Data | 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) | Texto | Não | uniqueSequentialNumber | pcpedc.nsu | NSUTEF | Texto | Não | dateUniqueSequentialNumber | pcpedc.dtnsu | Data do número sequencial único do cartão de crédito | Data | Não | Totvs custom tabs box items |
---|
default | no |
---|
referencia | passo2 |
---|
| Exemplo do envio da requisição: Bloco de código |
---|
| method: 'POST',
url: '/api/wholesale/v1/orders/' |
Bloco de código |
---|
language | js |
---|
title | Body Request |
---|
| {
"createData": "20202021-0308-23T1306T15:2440:3600.955102000000+1315:2440",
"orderIdHubecustomer": {
"stringactivityId": 0,
"orderIdMktplaceaddressInfo": "string",
"orderStatusbillingAddress": "string",
"chargingIdbillingZipCode": "string",
"carrierIdbusinessDistrict": 0"",
"paymentPlanIdcityId": 0,
"saleType": 0,
"freightDispatch "commercialAddress": "string",
"branchIdcommercialZipCode": "string",
"TotalPrice "corporate": 0false,
"saleOrigincorporatePhone": "W",
"uniqueSequentialNumbercountryId": "string"0,
"dateUniqueSequentialNumberemail": "string",
"intermediaryCompanyNamefinalCostumer": "string"false,
"idIntermediaryEmployerid": "string"0,
"valueFreightpaymentPlanId": 0,
"CustomerVendorInternalId": "string",
"position "sellerId": 0,
"otherExpensessquareId": 0,
"customerstateInscription": {"",
"idtradeName": 0""
},
"permissions "lastChange": {
"acceptOrderWithoutTax": true
},
"listOfOrderItem"2021-08-06T15:40:00",
/** Somente retornado em caso de utilização do cenário de múltiplas cobranças **/
"listPayment": [
{
"productSKUERPReferenceKeychargingId" : "string",
"sellPricepaymentPlanId":0,
"discountValue": : 0,
"quantityexpirationDate" : 0.0"0000-00-00T00:00:00",
"realCostvalue" : 0.0,
"warehouseBranchIdnsu" : "string",0
}
],
"giftlistOfOrderItem": true,[
"giftPrice": 0,{
"taxFigureIdaccountingCost": 0.0,
}
]
} | Bloco de código |
---|
language | js |
---|
title | Body Response |
---|
| {
"branchIdbasePriceRCA": "string"0.0,
"carrierId": 0,
"chargingId": "string",
"createDatacomissionPercent": "2021-08-06T15:40:00.000000+15:40",
"customer": {
"activityId0,
"discountPercentage": 0,
"fecp": 0,
"addressInfofinancialCost": ""0.0,
"billingAddressgift": ""false,
"billingZipCodegiftPrice": ""0,
"businessDistrictpackingId": ""0,
"cityIdposition": 0,
"commercialAddressproductId": "",
0,
"commercialZipCodeproductSKUERPReferenceKey": "00000-00",
"corporatequantity": false0.0,
"corporatePhonerealCost": ""0.0,
"countryIdreplacementCost": 0.0,
"emailresourceValueCMV": ""0,
"finalCostumerresourceValueCustumerCMV": false0,
"idsellPrice": 0.0,
"paymentPlanIdsellPriceBaseST": 0,
"sellerIdsellPriceIPI": 0,
"squareIdsellPriceST": 0,
"stateInscriptionstGNRE": ""0,
"tradeNametablePrice": ""
0.0,
},
"lastChangetablePriceIPI": "2021-08-06T15:40:00"0,
"listOfOrderItem": [
{"tablePriceST": 0,
"accountingCosttaxFigureId": 0.0,
"basePriceRCAtruncItem": 0.0false,
"comissionPercent": 0,
"discountPercentage"wantageQuantity": 0,
"fecp": 0
"warehouseBranchId": "string",
"financialCostdeliveryType": 0.0"RI",
"giftdeliveryStatus": false, "R"
}
],
"giftPricepermissions": 0,{
"acceptOrderWithoutTax": true,
"acceptSearchAutomaticFreightType": false
},
"packingIdorderId": 0"string",
"orderIdHube": "string",
"orderIdMktplace: "string",
"positionorderStatus": 0"string",
"otherExpenses": 0,
"productIdpaymentPlanId": 0,
"saleOrigin": "W",
"productSKUERPReferenceKeysaleType": "00000-00"0,
"saleTypePayment": "string",
"quantitytotalValue": "0.0",
"observation": "string",
"shippingTrackingCodeSale": "realCost": 0.0,
"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 |
---|
| 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 |
---|
| branchId"replacementCost": 0.0,
"resourceValueCMV": 0,
"resourceValueCustumerCMV": 0,
- Código da Filial **requerido
daysOfSearch "sellPrice": 0.0,
"sellPriceBaseST": 0,
- Dias de Pesquisa (Se não informado, o padrão será 15 dias)
orderId "sellPriceIPI": 0,
- Número Pedido
lastChange : "sellPriceST": 0,
"stGNRE": 0,
"tablePrice": 0.0,
"tablePriceIPI": 0,
"tablePriceST": 0,
"taxFigureId": 0,
"truncItem": false,
"wantageQuantity": 0,
"warehouseBranchId": "string"
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 |
---|
| { ],
"permissions": {
"acceptOrderWithoutTax": true
},
"orderIdbranchId": "string",
"orderIdHubecarrierId": "string"0,
"orderIdMktplace "chargingId": "string",
"orderStatuscreateData": "string2021-08-06T15:40:00.000000+15:40",
"otherExpensescustomer": 0,{
"paymentPlanIdactivityId": 0,
"saleOrigin": "W",
"saleTypeaddressInfo": 0"",
"saleTypePayment": "string",
"totalValuebillingAddress": "0.0"
}
|
| 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 |
---|
| 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 |
---|
| branchId "billingZipCode": "",
"businessDistrict": "",
"cityId": 0,
: 0 - Código da Filial **requerido
daysOfSearch"commercialAddress": "",
"commercialZipCode": 0 - Dias de Pesquisa
orderId "",
: 0 - Número Pedido
lastChange"corporate": false,
: 2021-03-02T16:43:00 - Última alteração
viewDocument : true/ false - Dados da nota fiscal
saleOrigin : T - Origem Venda (Todas existentes no
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) | Bloco de código |
---|
language | js |
---|
title | Body Response |
---|
| {
"branchId": "string",
"carrierId": 0,
"chargingId": "string""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"
},
"createDatalastChange": "2021-08-06T15:40:00.000000+1506T15:40:00",
/** Somente retornado em "customer": {
"activityId": 0,caso de utilização do cenário de múltiplas cobranças **/
"listPayment": [
"addressInfo": "",
{
"billingAddresschargingId" : "string",
"billingZipCodepaymentPlanId" : ""0,
"businessDistrictexpirationDate" : "0000-00-00T00:00:00",
"cityIdvalue" : 0.0,
"commercialAddressnsu" : "",0
"commercialZipCode": "",}
],
"corporatelistOfOrderItem": false,[
"corporatePhone": "",
{
"countryIdaccountingCost": 0.0,
"emailbasePriceRCA": ""0.0,
"finalCostumer": false,
"comissionPercent": "id0,
"discountPercentage": 0,
"paymentPlanIdfecp": 0,
"sellerIdfinancialCost": 0.0,
"squareIdgift": 0false,
"stateInscriptiongiftPrice": ""0,
"tradeName": ""
"packingId": }0,
"document": {
"createDataposition": "1900-01-01T00:00:00"0,
"documentNumberproductId": 0,
"keyDocumentproductSKUERPReferenceKey": "00000-00",
"lastChangequantity": "1900-01-01T00:00:00"0.0,
},
"lastChangerealCost": "2021-08-06T15:40:00"0.0,
"listOfOrderItem": [
{"replacementCost": 0.0,
"accountingCostresourceValueCMV": 0.0,
"basePriceRCAresourceValueCustumerCMV": 0.0,
"comissionPercentsellPrice": 0,
"discountPercentage": .0,
"fecpsellPriceBaseST": 0,
"financialCostsellPriceIPI": 0.0,
"sellPriceST": "gift0,
"sellPriceIcmsPart": false0,
"giftPricestGNRE": 0,
"packingIdtablePrice": 0.0,
"positiontablePriceIPI": 0,
"productIdtablePriceST": 0,
"productSKUERPReferenceKeytaxFigureId": "00000-00"0,
"quantitytruncItem": 0.0false,
"realCostwantageQuantity": 0.0,
"replacementCostwarehouseBranchId": 0.0,
"string"
"resourceValueCMV": 0, }
"resourceValueCustumerCMVdeductionsCmv": 0,
{
"sellPricediscountsCofins": 0.0,
"sellPriceBaseSTdiscountsIcms": 0,
"sellPriceIPIdiscountsPis": 0,
"sellPriceST": 0,
"sellPriceIcmsPart}
],
"permissions": 0,{
"stGNREacceptOrderWithoutTax": 0true,
"tablePrice "acceptSearchAutomaticFreightType": 0.0,false
},
"orderId": "string",
"tablePriceIPIorderIdHube": 0"string",
"orderIdMktplace: "string",
"orderStatus": "string",
"tablePriceSTotherExpenses": 0,
"taxFigureIdpaymentPlanId": 0,
"saleOrigin": "W",
"truncItemsaleType": false0,
"saleTypePayment": "string",
"wantageQuantitytotalValue": "0.0",
"observation": "string",
"shippingTrackingCodeSale": "string" "warehouseBranchId": "string"
}
],
"permissions": {
} |
|
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 |
---|
| method: 'DELETE',
url: '/api/wholesale/v1/orders/' -> Passar "acceptOrderWithoutTax": true
},
"orderId": "string",
"orderIdHube": "string",
"orderIdMktplace: "string",
"orderStatus": "string",
"otherExpenses": 0,
"paymentPlanId": 0,
"saleOrigin": "W",
"saleType": 0,
"saleTypePayment": "string",
"totalValue": "0.0"
} no Parms o campo id e Motivo para cancelar o pedido
|
Bloco de código |
---|
| Id : 0 - ID/Número Pedido (Obrigatório)
sendMessageRca : true/ false - Enviar mensagem pro RCA?
reasonCancellation : C - Motivo Cancelamento (Obrigatório) |
|
|