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,
"saleTypesellerId": 0,
"branchIdsquareId": "string"0,
"saleOriginstateInscription": "W",
"uniqueSequentialNumbertradeName": "string"
},
"dateUniqueSequentialNumberlastChange": "string2021-08-06T15:40:00",
"intermediaryCompanyName": "string",
"idIntermediaryEmployer": "string",
"valueFreight": 0, /** Somente retornado em caso de utilização do cenário de múltiplas cobranças **/
"listPayment": [
"otherExpenses": 0
"customer": {
"id": 0
},
"permissionschargingId" : {"string",
"acceptOrderWithoutTax": true
"paymentPlanId" : }0,
"listOfOrderItem": [
"expirationDate" {: "0000-00-00T00:00:00",
"productSKUERPReferenceKeyvalue" : "string"0.0,
"sellPricensu" : 0,
}
],
"quantitylistOfOrderItem": 0.0, [
{
"realCostaccountingCost": 0.0,
"warehouseBranchId": "string"basePriceRCA": 0.0,
"giftcomissionPercent": true0,
"discountPercentage": 0, "giftPrice
"fecp": 0,
"taxFigureIdfinancialCost": 0.0,
}
]
} | Bloco de código |
---|
language | js |
---|
title | Body Response |
---|
| {
"gift": false,
"branchId": "string",
"carrierIdgiftPrice": 0,
"chargingId": "string",
"createDatapackingId": "2021-08-06T15:40:00.000000+15:40"0,
"customer": {
"activityIdposition": 0,
"addressInfoproductId": ""0,
"billingAddressproductSKUERPReferenceKey": "00000-00",
"billingZipCodequantity": ""0.0,
"businessDistrictrealCost": ""0.0,
"cityIdreplacementCost": 0.0,
"commercialAddressresourceValueCMV": ""0,
"commercialZipCoderesourceValueCustumerCMV": ""0,
"corporatesellPrice": false0.0,
"corporatePhonesellPriceBaseST": ""0,
"countryIdsellPriceIPI": 0,
"emailsellPriceST": ""0,
"finalCostumerstGNRE": false0,
"idtablePrice": 0.0,
"paymentPlanIdtablePriceIPI": 0,
"sellerIdtablePriceST": 0,
"squareIdtaxFigureId": 0,
"stateInscriptiontruncItem": ""false,
"tradeName": ""
},
"lastChange"wantageQuantity": "2021-08-06T15:40:00"0,
"listOfOrderItem": [
{"warehouseBranchId": "string",
"accountingCostdeliveryType": 0.0"RI",
"basePriceRCAdeliveryStatus": 0.0, "R"
}
],
"comissionPercentpermissions": 0,{
"fecpacceptOrderWithoutTax": 0true,
"acceptSearchAutomaticFreightType": false
},
"financialCostorderId": 0.0"string",
"orderIdHube": "string",
"orderIdMktplace: "string",
"giftorderStatus": false"string",
"giftPriceotherExpenses": 0,
"packingIdpaymentPlanId": 0,
"saleOrigin": "W",
"positionsaleType": 0,
"saleTypePayment": "string",
"productIdtotalValue": "0.0",
"productSKUERPReferenceKey "observation": "00000-00string",
"quantity": 0.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"realCost": 0.0,
"replacementCost": 0.0,
"resourceValueCMV": 0,
- Código da Filial **requerido
daysOfSearch "resourceValueCustumerCMV": 0,
"sellPrice": 0.0,
- Dias de Pesquisa (Se não informado, o padrão será 15 dias)
orderId : 0 - Número Pedido
lastChange "sellPriceBaseST": 0,
: 2021-03-02T16:43:00 - Última alteração
viewDocument : "sellPriceIPI": 0,
true/ false - Dados da nota fiscal
saleOrigin : T - Origem "sellPriceST": 0,
"stGNRE": 0,
"tablePrice": 0.0,
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 : "tablePriceIPI": 0,
"tablePriceST": 0,
"taxFigureId": 0,
"truncItem": false,
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 |
---|
| {"wantageQuantity": 0,
"warehouseBranchId": "string"
}
],
"permissionsbranchId": {"string",
"acceptOrderWithoutTaxcarrierId": true
}0,
"orderIdchargingId": "string",
"orderIdHubecreateData": "string",
"orderIdMktplace: "string"2021-08-06T15:40:00.000000+15:40",
"orderStatuscustomer": "string",{
"otherExpenses": 0,
"paymentPlanIdactivityId": 0,
"saleOriginaddressInfo": "W",
"saleType": 0,
"saleTypePaymentbillingAddress": "string",
"totalValue": "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/' "billingZipCode": "",
-> 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 "businessDistrict": "",
"cityId": 0,
"commercialAddress": "",
"commercialZipCode": "",
: 0 - Código da Filial **requerido
daysOfSearch "corporate": false,
: 0 - Dias de Pesquisa
orderId "corporatePhone": "",
"countryId": 0 - Número Pedido
lastChange,
"email": "",
: 2021-03-02T16:43:00 - Última alteração
viewDocument "finalCostumer": 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 - Retorna apenas produtos que contenham id de Hube
hasPedidoMktplace : true/ false - Retorna apenas produtos que contenham id de Marketplace
| Bloco de código |
---|
language | js |
---|
title | Body Response |
---|
| {
"branchId": "string",
"carrierId": 0,
"chargingId": "string"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+15:40",
/** Somente retornado "customer": {
"activityId": 0,em caso de utilização do cenário de múltiplas cobranças **/
"listPayment": [
"addressInfo": "",{
"billingAddress": "",
"billingZipCodechargingId" : "string",
"businessDistrict": "",
"cityIdpaymentPlanId" : 0,
"commercialAddress": "",
"commercialZipCodeexpirationDate" : "0000-00-00T00:00:00",
"corporatevalue" : false0.0,
"corporatePhonensu" : "",0
"countryId": 0,}
],
"emaillistOfOrderItem": "",[
{
"finalCostumer": false,
"idaccountingCost": 0,
.0,
"paymentPlanIdbasePriceRCA": 0.0,
"comissionPercent": "sellerId0,
"discountPercentage": 0,
"squareIdfecp": 0,
"stateInscriptionfinancialCost": ""0.0,
"tradeName": ""
"gift": }false,
"document": {
"createDatagiftPrice": "1900-01-01T00:00:00",
0,
"documentNumberpackingId": 0,
"keyDocumentposition": ""0,
"lastChangeproductId": "1900-01-01T00:00:00"0,
},
"lastChangeproductSKUERPReferenceKey": "2021-08-06T15:40:00000-00",
"listOfOrderItem "quantity": [0.0,
{ "realCost": 0.0,
"accountingCostreplacementCost": 0.0,
"basePriceRCAresourceValueCMV": 0.0,
"comissionPercentresourceValueCustumerCMV": 0,
"fecpsellPrice": 0.0,
"financialCostsellPriceBaseST": 0.0,
"giftsellPriceIPI": false0,
"giftPricesellPriceST": 0,
"sellPriceIcmsPart": 0,
"packingIdstGNRE": 0,
"positiontablePrice": 0.0,
"productIdtablePriceIPI": 0,
"productSKUERPReferenceKeytablePriceST": "00000-00"0,
"quantitytaxFigureId": 0.0,
"realCosttruncItem": 0.0false,
"replacementCostwantageQuantity": 0.0,
"warehouseBranchId": "string"
"resourceValueCMV": 0,}
"resourceValueCustumerCMVdeductionsCmv": 0,{
"sellPricediscountsCofins": 0.0,
"sellPriceBaseSTdiscountsIcms": 0,
"sellPriceIPIdiscountsPis": 0,
"sellPriceST": 0,}
],
"permissions": {
"stGNREacceptOrderWithoutTax": 0true,
"acceptSearchAutomaticFreightType": false
},
"tablePriceorderId": 0.0"string",
"orderIdHube": "string",
"orderIdMktplace: "string",
"tablePriceIPIorderStatus": 0"string",
"tablePriceST"otherExpenses": 0,
"taxFigureId"paymentPlanId": 0,
"saleOrigin": "W",
"truncItemsaleType": false0,
"wantageQuantitysaleTypePayment": 0"string",
"totalValue": "0.0",
"observation": "string",
"warehouseBranchIdshippingTrackingCodeSale": "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) |
|
|