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 | otherExpenses | pcpedc.vloutrasdesp | Outras despesas | Numérico | 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 RequestResponse |
---|
| {
"createData": "2020-03-23T13:24:36.955102+13:24",
"orderIdHube": "string",
"orderIdMktplacebranchId": "string",
"orderStatuscarrierId": "string"0,
"chargingId": "string",
"carrierIdcreateData": 0"2021-08-06T15:40:00.000000+15:40",
"paymentPlanIdcustomer": 0,
{
"saleTypeactivityId": 0,
"freightDispatch": "string",
"branchId": "string",
"TotalPrice": 0,
"saleOriginaddressInfo": "W",
"uniqueSequentialNumber": "string",
"dateUniqueSequentialNumberbillingAddress": "string",
"intermediaryCompanyNamebillingZipCode": "string",
"idIntermediaryEmployerbusinessDistrict": "string",
"valueFreightcityId": 0,
"CustomerVendorInternalId "commercialAddress": "string",
"position "commercialZipCode": 0"",
"otherExpenses": 0
"customercorporate": {false,
"idcorporatePhone": 0
"",
},
"permissionscountryId": {0,
"acceptOrderWithoutTaxemail": true"",
},
"listOfOrderItemfinalCostumer": [false,
{
"id": 0,
"productSKUERPReferenceKeypaymentPlanId": "string"0,
"sellPricesellerId":0,
"discountValue": 0,
"quantitysquareId": 0.0,
"realCoststateInscription": 0.0"",
"warehouseBranchIdtradeName": "string",
},
"giftlastChange": true"2021-08-06T15:40:00",
/** Somente retornado em caso de utilização do cenário de múltiplas cobranças **/
"giftPricelistPayment": 0,[
{
"taxFigureId": 0
"chargingId" : }"string",
"deductionsCmvpaymentPlanId" : {0,
"expirationDate" "discountsCofins": 0,
: "0000-00-00T00:00:00",
"discountsIcmsvalue" : 0.0,
"discountsPisnsu" : 0
}
], }
"listOfOrderItem": [
]
} | Bloco de código |
---|
language | js |
---|
title | Body Response |
---|
| {
"branchId": "string", {
"carrierId": 0,
"chargingId": "string",
"createDataaccountingCost": "2021-08-06T15:40:00.000000+15:40"0.0,
"customer": {
"activityIdbasePriceRCA": 0.0,
"addressInfocomissionPercent": 0,
"discountPercentage": 0,
"billingAddress
"fecp": ""0,
"billingZipCodefinancialCost": ""0.0,
"businessDistrictgift": ""false,
"cityIdgiftPrice": 0,
"commercialAddresspackingId": ""0,
"commercialZipCodeposition": ""0,
"corporateproductId": false0,
"corporatePhoneproductSKUERPReferenceKey": "00000-00",
"countryIdquantity": 0.0,
"emailrealCost": ""0.0,
"finalCostumer": false,
"idreplacementCost": 0.0,
"paymentPlanIdresourceValueCMV": 0,
"sellerIdresourceValueCustumerCMV": 0,
"squareIdsellPrice": 0.0,
"stateInscriptionsellPriceBaseST": ""0,
"tradeName": ""
},
"lastChangesellPriceIPI": "2021-08-06T15:40:00"0,
"listOfOrderItem": [
{"sellPriceST": 0,
"accountingCoststGNRE": 0.0,
"basePriceRCAtablePrice": 0.0,
"comissionPercenttablePriceIPI": 0,
"discountPercentage": 0,
"fecp "tablePriceST": 0,
"financialCosttaxFigureId": 0.0,
"gifttruncItem": false,
"giftPricewantageQuantity": 0,
"packingIdwarehouseBranchId": 0"string",
"positiondeliveryType": 0"RI",
"productIddeliveryStatus": 0, "R"
}
"productSKUERPReferenceKey": "00000-00",
],
"permissions": {
"quantityacceptOrderWithoutTax": 0.0true,
"acceptSearchAutomaticFreightType": false
},
"realCostorderId": 0.0"string",
"orderIdHube": "string",
"orderIdMktplace: "string",
"replacementCostorderStatus": 0.0"string",
"otherExpenses": 0,
"resourceValueCMVpaymentPlanId": 0,
"saleOrigin": "W",
"resourceValueCustumerCMVsaleType": 0,
"saleTypePayment": "string",
"sellPricetotalValue": "0.0",
"observation": "string",
"shippingTrackingCodeSale": "sellPriceBaseST": 0,
"sellPriceIPI": 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 "sellPriceST": 0,
"stGNRE": 0,
"tablePrice": 0.0,
: 0 - Código da "tablePriceIPI": 0,
Filial **requerido
daysOfSearch : 0 - Dias de Pesquisa "tablePriceST": 0,
(Se não informado, o padrão será 15 dias)
orderId "taxFigureId": 0,
- Número Pedido
lastChange : "truncItem": false,
"wantageQuantity": 0,
"warehouseBranchId": "string"
}
],
"permissions": {
"acceptOrderWithoutTax": true
},
"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 |
---|
| 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.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 | ParamsBody Response |
---|
| branchId{
"branchId": "string",
"carrierId": 0 - Código da Filial **requerido
daysOfSearch,
: 0 - Dias de Pesquisa
orderId : 0 - Número Pedido
lastChange"chargingId": "string",
"createData": "2021-08-06T15:40:00.000000+15:40",
"customer": {
: 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": {"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": "",
"activityIdtradeName": 0,""
},
"addressInfodocument": "",{
"billingAddresscreateData": "1900-01-01T00:00:00",
"billingZipCodedocumentNumber": ""0,
"businessDistrictkeyDocument": "",
"cityIdlastChange": 0,"1900-01-01T00:00:00"
},
"commercialAddresslastChange": "2021-08-06T15:40:00",
/** Somente retornado em caso de utilização do cenário de múltiplas cobranças **/
"commercialZipCodelistPayment": "",[
{
"corporate": false,
"corporatePhonechargingId" : "string",
"countryIdpaymentPlanId" : 0,
"emailexpirationDate" : "0000-00-00T00:00:00",
"finalCostumervalue" : false0.0,
"idnsu" : 0,
"paymentPlanId": 0,}
],
"sellerIdlistOfOrderItem": 0,
[
{
"squareId": 0,
"stateInscriptionaccountingCost": ""0.0,
"tradeName": ""
}"basePriceRCA": 0.0,
"document": {
"createDatacomissionPercent": "1900-01-01T00:00:00",
0,
"discountPercentage": 0,
"documentNumberfecp": 0,
"keyDocument": "",
"lastChangefinancialCost": "1900-01-01T00:00:00"
0.0,
},
"lastChangegift": "2021-08-06T15:40:00"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,
"sellPriceIcmsPartwantageQuantity": 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) |
|
|