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 |
|
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",
"branchId": "string",
"TotalPrice": 0,
"saleOrigin": "W",
"uniqueSequentialNumber": "string",
"dateUniqueSequentialNumber": "string",
"intermediaryCompanyName": "string",
"idIntermediaryEmployer": "string",
"valueFreight": 0,
"CustomerVendorInternalId": "string",
"position": 0,
"otherExpenses": 0
"customer": {
"id": 0
},
"permissions": {
"acceptOrderWithoutTax": true
},
/** Somente enviado para "listOfOrderItem": [
a 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 "productSKUERPReferenceKey": 0"string",
"taxFigureIdsellPrice": 0
}
,
"discountValue":0,
"deductionsCmvquantity": {0.0,
"discountsCofinsrealCost": 0.0,
"discountsIcmswarehouseBranchId": 0"string",
"discountsPisgift": 0true,
"giftPrice": 0,
} "taxFigureId": 0
]
} | Bloco de código |
---|
language | js |
---|
title | Body Response |
---|
| { }
"branchId "deductionsCmv": "string",
{
"carrierId": 0,
"chargingIddiscountsCofins": "string"0,
"createData": "2021-08-06T15:40:00.000000+15:40",
"customer": {
"activityIddiscountsIcms": 0,
"addressInfo": "",
"billingAddressdiscountsPis": "",0
"billingZipCode": "",
"businessDistrict": "",
}
]
} |
Bloco de código |
---|
language | js |
---|
title | Body Response |
---|
| {
"branchId "cityId": 0"string",
"carrierId": 0,
"commercialAddresschargingId": "string",
"createData": "2021-08-06T15:40:00.000000+15:40",
"commercialZipCodecustomer": "",{
"corporateactivityId": false0,
"corporatePhoneaddressInfo": "",
"countryIdbillingAddress": 0"",
"emailbillingZipCode": "",
"finalCostumerbusinessDistrict": false"",
"idcityId": 0,
"paymentPlanIdcommercialAddress": 0"",
"sellerIdcommercialZipCode": 0"",
"squareIdcorporate": 0false,
"stateInscriptioncorporatePhone": "",
"tradeNamecountryId": ""0,
},
"lastChangeemail": "2021-08-06T15:40:00",
"listOfOrderItemfinalCostumer": [false,
{
"id": 0,
"accountingCostpaymentPlanId": 0.0,
"basePriceRCA": 0.0"sellerId": 0,
"comissionPercentsquareId": 0,
"discountPercentage": 0,
"fecpstateInscription": 0"",
"financialCosttradeName": 0.0,""
},
"giftlastChange": false"2021-08-06T15:40:00",
/** Somente retornado em caso de utilização do cenário de múltiplas "giftPricecobranças **/
"listPayment": 0,[
"packingId": 0,{
"positionchargingId" : 0"string",
"productIdpaymentPlanId" : 0,
"productSKUERPReferenceKeyexpirationDate" : "000000000-00-00T00:00:00",
"quantityvalue" : 0.0,
"realCostnsu" : 0.0,
}
"replacementCost": 0.0,
],
"listOfOrderItem": [
"resourceValueCMV": 0,{
"resourceValueCustumerCMVaccountingCost": 0.0,
"sellPricebasePriceRCA": 0.0,
"sellPriceBaseSTcomissionPercent": 0,
"discountPercentage": 0, "sellPriceIPI
"fecp": 0,
"sellPriceSTfinancialCost": 0.0,
"stGNREgift": 0false,
"tablePricegiftPrice": 0.0,
"tablePriceIPIpackingId": 0,
"tablePriceSTposition": 0,
"taxFigureIdproductId": 0,
"truncItemproductSKUERPReferenceKey": false"00000-00",
"wantageQuantityquantity": 0.0,
"warehouseBranchIdrealCost": "string"0.0,
}
],
"permissionsreplacementCost": {0.0,
"acceptOrderWithoutTaxresourceValueCMV": true0,
},
"orderIdresourceValueCustumerCMV": "string"0,
"orderIdHube "sellPrice": "string"0.0,
"orderIdMktplace: "string",
"orderStatussellPriceBaseST": "string"0,
"otherExpensessellPriceIPI": 0,
"paymentPlanId "sellPriceST": 0,
"saleOrigin": "W",
"saleTypestGNRE": 0,
"saleTypePayment": "string",
"totalValuetablePrice": "0.0"
}
,
"tablePriceIPI": 0,
"tablePriceST": 0,
"taxFigureId": 0,
"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. |
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 |
| 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
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) 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, | 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"
"id": 0},
"paymentPlanIdlastChange": 0"2021-08-06T15:40:00",
/** Somente retornado em caso de utilização do cenário "sellerIdde múltiplas cobranças **/
"listPayment": 0,[
"squareId": 0,
{
"stateInscriptionchargingId" : "string",
"tradeName": "paymentPlanId"
: }0,
"document": {
"createDataexpirationDate" : "19000000-0100-01T0000T00:00:00",
"documentNumbervalue" : 0.0,
"keyDocument": "",
"nsu" : 0
"lastChange": "1900-01-01T00:00:00"
},
"lastChange": "2021-08-06T15:40:00"],
"listOfOrderItem": [
{
"accountingCost": 0.0,
"basePriceRCA": 0.0,
"comissionPercent": 0,
"discountPercentage": 0,
"fecp": 0,
"financialCost": 0.0,
"gift": false,
"giftPrice": 0,
"packingId": 0,
"position": 0,
"productId": 0,
"productSKUERPReferenceKey": "00000-00",
"quantity": 0.0,
"realCost": 0.0,
"replacementCost": 0.0,
"resourceValueCMV": 0,
"resourceValueCustumerCMV": 0,
"sellPrice": 0.0,
"sellPriceBaseST": 0,
"sellPriceIPI": 0,
"sellPriceST": 0,
"sellPriceIcmsPart": 0,
"stGNRE": 0,
"tablePrice": 0.0,
"tablePriceIPI": 0,
"tablePriceST": 0,
"taxFigureId": 0,
"truncItem": false,
"wantageQuantity": 0,
"warehouseBranchId": "string"
}
"deductionsCmv": {
"discountsCofins": 0,
"discountsIcms": 0,
"discountsPis": 0
}
],
"permissions": {
"acceptOrderWithoutTax": true
},
"orderId": "string",
"orderIdHube": "string",
"orderIdMktplace: "string",
"orderStatus": "string",
"otherExpenses": 0,
"paymentPlanId": 0,
"saleOrigin": "W",
"saleType": 0,
"saleTypePayment": "string",
"totalValue": "0.0"
} |
|
|