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 | createData | pcpedc.data | pcpedi.data | id | pcpedc.codcli | pcpedi.codcli | orderId | pcpedc.numped | pcpedi.numped | orderStatus | pcpedc.posicao | chargingId | pcpedc.codcob | TotalPrice | pcpedc.vltotal | paymentPlanId | pcpedc.codplpag | saleType | pcpedc.condvenda | branchId | pcpedc.codfilial | saleOrigin | pcpedc.origemped | productSKUERPReferenceKey | pcpedi.codprod | sellPrice | pcpedi.pvenda | quantity | pcpedi.qt | realCost | pcpedi.vlcustoreal | warehouseBranchId | pcpedi.codfilialretira | position | pcpedi.numseq | taxFigureId | pcpedi.codst | valueFreight | pcpedc.vlfrete | intermediaryCompanyName | pcpedc.descintermediador | idIntermediaryEmployer | pcpedc.cnpjintermediador | carrierId | pcpedc.codfornecfrete | lastChange | pcpedc.dtfat (prioridade 1) | lastChange | pcpedc.data (prioridade 2) | orderIdHube | pcpedc.numpedhube | orderIdMktplace | pcpedc.numpedmktplace | saleOrigin | pcpedc.origemped | freightDispatch | pcpedc.fretedespacho | uniqueSequentialNumber | pcpedc.nsu | dateUniqueSequentialNumber | pcpedc.dtnsu | 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": "2020-03-23T13:24:36.955102+13:24",
"orderIdHube": "string",
"orderIdMktplace": "string",
"orderStatus": "string",
"chargingId": "string",
"DiscountValue": 0.0,
"carrierId": 0,
"paymentPlanId": 0,
"saleType": 0,
"branchId": "string",
"saleOrigin": "W",
"uniqueSequentialNumber": "string",
"dateUniqueSequentialNumber": "string",
"intermediaryCompanyName": "string",
"idIntermediaryEmployer": "string",
"valueFreight": 0,
"otherExpenses": 0
"customer": {
"id": 0
},
"listOfOrderItem": [
{
"productSKUERPReferenceKeyposition": "string"0,
"sellPriceproductId": 0,
"quantityproductSKUERPReferenceKey": 0.0"00000-00",
"realCostquantity": 0.0,
"warehouseBranchIdrealCost": "string"0.0,
"giftreplacementCost": true0.0,
"giftPriceresourceValueCMV": 0,
"taxFigureIdresourceValueCustumerCMV": 0,
}
]
} | Bloco de código |
---|
language | js |
---|
title | Body Response |
---|
| {
"branchId": "string",
"carrierIdsellPrice": 0.0,
"chargingId": "string",
"createDatasellPriceBaseST": "2021-08-06T15:40:00.000000+15:40"0,
"customer": {
"activityIdsellPriceIPI": 0,
"addressInfosellPriceST": ""0,
"billingAddressstGNRE": ""0,
"billingZipCodetablePrice": ""0.0,
"businessDistricttablePriceIPI": ""0,
"cityIdtablePriceST": 0,
"commercialAddresstaxFigureId": ""0,
"commercialZipCodetruncItem": ""false,
"corporatewantageQuantity": false0,
"corporatePhonewarehouseBranchId": "string",
"countryId": 0,
"emaildeliveryType": "RI",
"finalCostumerdeliveryStatus": false,
"R"
"id": 0,
}
],
"paymentPlanIdpermissions": 0,{
"sellerIdacceptOrderWithoutTax": 0true,
"squareId "acceptSearchAutomaticFreightType": 0,false
},
"stateInscriptionorderId": "string",
"tradeNameorderIdHube": "string",
} "orderIdMktplace: "string",
"lastChangeorderStatus": "2021-08-06T15:40:00string",
"listOfOrderItemotherExpenses": [0,
{"paymentPlanId": 0,
"saleOrigin": "W",
"accountingCostsaleType": 0.0,
"saleTypePayment": "string",
"basePriceRCAtotalValue": "0.0",
"comissionPercent "observation": 0"string",
"fecp": 0,
"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 |
---|
| 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 "financialCost": 0.0,
"gift": false,
"giftPrice": 0,
- Código da Filial **requerido
daysOfSearch "packingId": 0,
"position": 0,
- Dias de Pesquisa (Se não informado, o padrão será 15 dias)
orderId "productId": 0,
- Número Pedido
lastChange "productSKUERPReferenceKey": "00000-00",
"quantity": 0.0,
"realCost": 0.0,
"replacementCost": 0.0,
"resourceValueCMV": 0,
"resourceValueCustumerCMV": 0,
"sellPrice": 0.0,
"sellPriceBaseST": 0,
"sellPriceIPI": 0,
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 : "sellPriceST": 0,
- Filtra pela coluna ORIGEMINTEGRACAO - Disponível "stGNRE": 0,
a partir da versão 1.3.0.40(Winthor-pedido-venda)
|
Bloco de código |
---|
language | js |
---|
title | Body Response |
---|
| {
"tablePricebranchId": 0.0"string",
"tablePriceIPI"carrierId": 0,
"tablePriceSTchargingId": 0"string",
"taxFigureId"createData": 0,
"2021-08-06T15:40:00.000000+15:40",
"truncItemcustomer": false,{
"wantageQuantityactivityId": 0,
"warehouseBranchIdaddressInfo": "string",
}
],
"orderIdbillingAddress": "string",
"orderIdHube": "string",
"orderStatusbillingZipCode": "string",
"otherExpenses": 0,
"paymentPlanId": 0,
"saleOriginbusinessDistrict": "W",
"saleTypecityId": 0,
"saleTypePaymentcommercialAddress": "string",
"totalValuecommercialZipCode": "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 : 0 - Código da Filial **requerido
daysOfSearch : 0 - Dias de Pesquisa
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
order : lastChange - Ordenação de busca
orderStatus : C - Status do Pedido
page : 1 - Número Página
pageSize : 10 - Tamanho da página
|
Bloco de código |
---|
language | js |
---|
title | Body Response |
---|
| {
"branchId": "string",
"carrierId": 0,
"chargingId": "string",
"createData,
"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.000000+15:40",
/** 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
}
],
"commercialZipCodelistOfOrderItem": "",[
{
"corporate": false,
"corporatePhoneaccountingCost": ""0.0,
"countryIdbasePriceRCA": 0.0,
"emailcomissionPercent": 0,
"discountPercentage": 0,
"finalCostumerfecp": false0,
"idfinancialCost": 0.0,
"paymentPlanIdgift": 0false,
"sellerIdgiftPrice": 0,
"squareIdpackingId": 0,
"stateInscriptionposition": ""0,
"tradeName": ""
"productId": }0,
"document": {
"createDataproductSKUERPReferenceKey": "1900-01-01T00:00:00000-00",
"documentNumberquantity": 0.0,
"keyDocumentrealCost": ""0.0,
"lastChange": "1900-01-01T00:00:00"
},
"lastChangereplacementCost": "2021-08-06T15:40:00"0.0,
"listOfOrderItem": [
{"resourceValueCMV": 0,
"accountingCostresourceValueCustumerCMV": 0.0,
"basePriceRCAsellPrice": 0.0,
"comissionPercentsellPriceBaseST": 0,
"fecpsellPriceIPI": 0,
"financialCostsellPriceST": 0.,
"sellPriceIcmsPart": 0,
"giftstGNRE": false0,
"giftPricetablePrice": 0.0,
"packingIdtablePriceIPI": 0,
"positiontablePriceST": 0,
"productIdtaxFigureId": 0,
"productSKUERPReferenceKeytruncItem": "00000-00"false,
"quantitywantageQuantity": 0.0,
"realCost": 0.0,
"warehouseBranchId": "string"
"replacementCost": 0.0, }
"resourceValueCMVdeductionsCmv": 0,{
"resourceValueCustumerCMVdiscountsCofins": 0,
"sellPricediscountsIcms": 0.0,
"sellPriceBaseSTdiscountsPis": 0,
"sellPriceIPI": 0,}
],
"permissions": {
"sellPriceSTacceptOrderWithoutTax": 0true,
"acceptSearchAutomaticFreightType": false
},
"stGNREorderId": 0"string",
"orderIdHube": "string",
"orderIdMktplace: "string",
"tablePriceorderStatus": 0.0"string",
"otherExpenses": 0,
"tablePriceIPIpaymentPlanId": 0,
"saleOrigin": "W",
"tablePriceSTsaleType": 0,
"saleTypePayment": "string",
"taxFigureIdtotalValue": "0.0",
"truncItem "observation": false"string",
"shippingTrackingCodeSale": "string" "wantageQuantity": 0,
"warehouseBranchId": "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 |
---|
| method: 'DELETE',
url: '/api/wholesale/v1/orders/' -> Passar }
no Parms o campo ],
id e Motivo "orderId": "string",
"orderIdHube": "string",
para cancelar o pedido
|
Bloco de código |
---|
| Id "orderStatus": "string",
"otherExpenses": 0,
"paymentPlanId": 0,
- ID/Número Pedido (Obrigatório)
sendMessageRca "saleOrigin": "W",
"saleType": 0,
"saleTypePayment": "string",
"totalValue": "0.0"
}
true/ false - Enviar mensagem pro RCA?
reasonCancellation : C - Motivo Cancelamento (Obrigatório) |
|
|