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) 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 | Não | dateUniqueSequentialNumber | pcpedc.dtnsu | Data do número sequencial único do cartão de crédito | Data | Não | otherExpenses | pcpedc.vloutrasdesp | Outras despesas | Numérico | Não gift | pcpedi.bonific | Item bonificado/brinde | Boolean | 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": "2020-03-23T13:24:36.955102+13:24",
"orderIdHube": "string",
"orderIdMktplace": "string",
"orderStatus": "string",
"chargingId": "string",
"carrierId": 0,
"paymentPlanId" : 0,
"saleType": 0,
"freightDispatch": "string",
"branchIdexpirationDate" : "string0000-00-00T00:00:00",
"TotalPrice": 0,
"saleOrigin": "W",
"uniqueSequentialNumbervalue" : "string"0.0,
"dateUniqueSequentialNumber": "string",
"intermediaryCompanyNamensu" : "string",
0
"idIntermediaryEmployer": "string", }
"valueFreight": 0],
"CustomerVendorInternalIdlistOfOrderItem": "string",
"position": 0,
[
{
"otherExpenses": 0
"customerproductSKUERPReferenceKey": {"string",
"idsellPrice": 0
},
"permissionsdiscountValue": {
0,
"acceptOrderWithoutTaxquantity": true0.0,
"acceptSearchAutomaticFreightType": false
}"realCost": 0.0,
/** Somente enviado para a utilização do cenário de múltiplas cobranças **/
"listPaymentwarehouseBranchId": [
"string",
{ "gift": true,
"chargingIdgiftPrice" : "string"0,
"paymentPlanIdtaxFigureId" : 0,
"expirationDate" : "0000-00-00T00:00:00",
"valuedeliveryType" : 0.0,"RI"
"nsudeductionsCmv" : 0{
}
],
"listOfOrderItemdiscountsCofins": [0,
{
"productSKUERPReferenceKeydiscountsIcms": "string"0,
"sellPricediscountsPis": 0,
"discountValue":0,
"quantity": 0.0,
} "realCost": 0.0,
}
]
} |
Bloco de código |
---|
language | js |
---|
title | Body Response |
---|
| {
"warehouseBranchIdbranchId": "string",
"carrierId": 0,
"chargingId": "string",
"giftcreateData": true"2021-08-06T15:40:00.000000+15:40",
"customer": {
"giftPriceactivityId": 0,
"taxFigureIdaddressInfo": 0"",
}
"billingAddress": "",
"deductionsCmvbillingZipCode": {"",
"businessDistrict": "",
"discountsCofinscityId": 0,
"commercialAddress": "",
"discountsIcmscommercialZipCode": 0"",
"corporate": false,
"discountsPiscorporatePhone": 0
"",
"countryId": 0,
} "email": "",
]
} | Bloco de código |
---|
language | js |
---|
title | Body Response |
---|
| {
"branchIdfinalCostumer": "string"false,
"carrierIdid": 0,
"chargingIdpaymentPlanId": "string"0,
"createData": "2021-08-06T15:40:00.000000+15:40",
"customersellerId": {0,
"activityIdsquareId": 0,
"addressInfostateInscription": "",
"billingAddresstradeName": "",
},
"billingZipCodelastChange": "2021-08-06T15:40:00",
/** Somente retornado em caso de utilização do cenário de múltiplas cobranças **/
"businessDistrictlistPayment": "",
[
{
"cityIdchargingId" : 0"string",
"commercialAddresspaymentPlanId" : ""0,
"commercialZipCodeexpirationDate" : "0000-00-00T00:00:00",
"corporatevalue" : false0.0,
"corporatePhonensu" : "",0
"countryId": 0,}
],
"emaillistOfOrderItem": "",[
"finalCostumer": false,
{
"idaccountingCost": 0.0,
"paymentPlanIdbasePriceRCA": 0.0,
"sellerIdcomissionPercent": 0,
"discountPercentage": 0,
"squareIdfecp": 0,
"stateInscriptionfinancialCost": ""0.0,
"tradeName": ""
},
"lastChange"gift": "2021-08-06T15:40:00"false,
/** Somente retornado em caso de utilização do cenário de múltiplas cobranças **/
"listPaymentgiftPrice": [0,
{ "packingId": 0,
"chargingIdposition" : "string"0,
"paymentPlanIdproductId" : 0,
"expirationDateproductSKUERPReferenceKey" : "0000-0000000-00T00:00:00",
"valuequantity" : 0.0,
"nsurealCost" : 0.0,
}
],
"listOfOrderItem"replacementCost": [
{0.0,
"accountingCostresourceValueCMV": 0.0,
"basePriceRCAresourceValueCustumerCMV": 0.0,
"comissionPercentsellPrice": 0.0,
"discountPercentage": 0,
"fecp "sellPriceBaseST": 0,
"financialCostsellPriceIPI": 0.0,
"giftsellPriceST": false0,
"giftPricestGNRE": 0,
"packingIdtablePrice": 0.0,
"positiontablePriceIPI": 0,
"productIdtablePriceST": 0,
"productSKUERPReferenceKeytaxFigureId": "00000-00"0,
"quantitytruncItem": 0.0false,
"realCostwantageQuantity": 0.0,
"replacementCostwarehouseBranchId": 0.0"string",
"resourceValueCMVdeliveryType": 0"RI",
"resourceValueCustumerCMVdeliveryStatus": 0,"R"
}
],
"sellPricepermissions": 0.0,{
"sellPriceBaseSTacceptOrderWithoutTax": 0true,
"acceptSearchAutomaticFreightType": false
},
"sellPriceIPIorderId": 0"string",
"orderIdHube": "string",
"orderIdMktplace: "string",
"sellPriceSTorderStatus": 0"string",
"stGNRE"otherExpenses": 0,
"tablePrice"paymentPlanId": 0.0,
"saleOrigin": "W",
"tablePriceIPIsaleType": 0,
"tablePriceST"saleTypePayment": 0"string",
"taxFigureId"totalValue": "0.0",
"truncItem "observation": false"string",
"wantageQuantity": 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 "warehouseBranchId": "string"
}
],
"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"
}
|
| Totvs custom tabs box items |
---|
default | no |
---|
referencia | passo3 |
---|
| 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 (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, |
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
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",
"createData": "2021-08-06T15:40:00.000000+15:40",
"customer": {
"activityIdemail": 0"",
"addressInfofinalCostumer": ""false,
"billingAddressid": ""0,
"billingZipCodepaymentPlanId": ""0,
"businessDistrictsellerId": ""0,
"cityIdsquareId": 0,
"commercialAddressstateInscription": "",
"commercialZipCodetradeName": "",
},
"corporatedocument": false,{
"corporatePhonecreateData": "1900-01-01T00:00:00",
"countryIddocumentNumber": 0,
"emailkeyDocument": "",
"finalCostumerlastChange": false,"1900-01-01T00:00:00"
},
"idlastChange": 0"2021-08-06T15:40:00",
/** Somente retornado em caso de utilização do cenário de múltiplas cobranças **/
"paymentPlanIdlistPayment": 0,[
"sellerId": 0,{
"squareId": 0,
"stateInscriptionchargingId" : "string",
"tradeName": "paymentPlanId"
: }0,
"document": {
"createDataexpirationDate" : "19000000-0100-01T0000T00:00:00",
"documentNumber": 0,
"keyDocumentvalue" : "",
0.0,
"lastChange": "1900-01-01T00:00:00"
},
"lastChangensu" : "2021-08-06T15:40:00",
/** Somente retornado em caso de utilização do cenário de múltiplas cobranças **/
"listPayment0
}
],
"listOfOrderItem": [
{
"chargingIdaccountingCost" : "string"0.0,
"paymentPlanIdbasePriceRCA": : 0.0,
"expirationDatecomissionPercent" : "0000-00-00T00:00:00"0,
"discountPercentage": 0,
"valuefecp" : 0.0,
"nsufinancialCost" : 0.0,
}
"gift": ]false,
"listOfOrderItem": [
{"giftPrice": 0,
"accountingCostpackingId": 0.0,
"basePriceRCAposition": 0.0,
"comissionPercent": 0,
"discountPercentage"productId": 0,
"fecpproductSKUERPReferenceKey": 0"00000-00",
"financialCostquantity": 0.0,
"giftrealCost": false0.0,
"giftPricereplacementCost": 0.0,
"packingIdresourceValueCMV": 0,
"positionresourceValueCustumerCMV": 0,
"productIdsellPrice": 0.0,
"productSKUERPReferenceKeysellPriceBaseST": "00000-00"0,
"quantitysellPriceIPI": 0.0,
"realCostsellPriceST": 0.,
"sellPriceIcmsPart": 0,
"replacementCoststGNRE": 0.0,
"resourceValueCMVtablePrice": 0.0,
"resourceValueCustumerCMVtablePriceIPI": 0,
"sellPricetablePriceST": 0.0,
"sellPriceBaseSTtaxFigureId": 0,
"sellPriceIPItruncItem": 0false,
"sellPriceST": 0,
"sellPriceIcmsPart "wantageQuantity": 0,
"stGNREwarehouseBranchId": 0,"string"
}
"tablePricedeductionsCmv": 0.0,
{
"tablePriceIPIdiscountsCofins": 0,
"tablePriceSTdiscountsIcms": 0,
"taxFigureIddiscountsPis": 0,
"truncItem": false,}
],
"permissions": {
"wantageQuantityacceptOrderWithoutTax": 0true,
"acceptSearchAutomaticFreightType": false
},
"warehouseBranchIdorderId": "string",
"orderIdHube": }"string",
"orderIdMktplace: "string",
"orderStatus": "string",
"deductionsCmvotherExpenses": {0,
"paymentPlanId": 0,
"saleOrigin": "W",
"discountsCofinssaleType": 0,
"saleTypePayment": "string",
"discountsIcmstotalValue": "0.0",
"observation": "string",
"shippingTrackingCodeSale": "string" "discountsPis": 0
}
],
"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) |
|
|