Histórico da Página

Objetivo

Este documento tem como objetivo explicar o funcionamento da integração do Pedido de Venda.

Pré-Requisitos e Restrições

• Necessário a instalação do  serviço winthor-pedido-venda. 
• Definir o "Caso o atributo "seller" não seja enviado na requisição, a API consultará o RCA definido no parâmetro "4012 - Código do RCA para cadastro de clientes na Ciashop"  na opção 4012-CODRCACIASHOP da rotina 132- Parâmetros da Presidência.
• A região padrão de preço deverá ser informada na opção 4257-CODREGIAOPRECOCIASHOP da rotina 132- Parâmetros da Presidência.
• A precificação deverá ser realizada por Filial no parâmetro 2277 - Tipo de precificação selecionando o tipo de precificação conforme necessidade.
• A tabela PCLOGPEDIDOAP PCLOGPEDIDOAPI, é responsável por guardar os retornos dos pedidos importados via integração, sendo sendo Operação (I - inclusão, A - alteração, C - cancelamento) e Status (A - Aceito, R - Rejeitado, P - Processando).
• Através da lista de pedidos é possível pesquisar por Filial ou Multifiliais (separado por vírgula) para obter os dados.
• Os dados de Razão social do intermediador e CNPJ do intermediador serão representados pelos campos, "intermediaryCompanyName" e  "idIntermediaryEmployer" respectivamente.
• Considera-se na totalização do pedido frete e outras despesas.
• Ao inserir um pedido através da API, o campo "PCPEDI.PBASERCA" gravará de acordo com o campo “PCPEDI.PTABELA”, não é necessário enviá-lo pela API.
• Será persistidos os dados de cartão que a operadora do cartão retorna como o NSU e DTNSU (data de aprovação do cartão).
• No envio do JSON deve-se enviar no campo productSKUERPReferenceKey o código auxiliar seguido do código do produto. Exemplo: 100-1 
• Ao inserir um pedido, será considerado a figura tributária correspondente deverá enviar a informação do atributo  acceptOrderWithoutTax. As figuras tributárias consideradas são referente a rotina 271 ou rotina 514 em caso de tributação por estado estado (parâmetro 1092 - Usar tributação por estado (UF), rotina 132) para o item. Caso não tenha a informação da figura tributária em alguma das rotinas e o atributo "acceptOrderWithoutTax" esteja sendo enviado com "false" , o pedido será rejeitado, do contrário se o parâmetro não for enviado, ou for enviado como "true", mesmo que não haja tributação vinculada o pedido será registrado, porém com o valor "0" na coluna PCPEDI.CODST e demais colunas de imposto.

 Integração

• Caso o processo de desconto por item seja utilizado, o valor do desconto deve ser informado no campo listOfOrderItem.discountValue no body do json de envio do pedido. O campo sellPrice deve conter o valor correspondente ao valor tabela - valor do desconto. O preço tabela corresponderá ao preço de venda + o valor do desconto, e o percentual do desconto será calculado automaticamente. É necessário que haja uma política de desconto cadastrada na Rotina 561 para o conjunto de dados que serão enviados, de forma a controlar o percentual de desconto aplicado. Caso não haja política cadastrada, o pedido será integrado com a posição "Bloqueado".
• Ainda sobre o processo de desconto por item, a API está validando o parâmetro 1463 - % Máximo de desconto Médio nos Orçamentos e Pedidos de Venda da Rotina 132, de forma que mesmo havendo política de desconto que permita o percentual informado, o pedido não será integrado se o percentual for superior ao informado no parâmetro. Caso o parâmetro esteja com o valor "0", essa validação será desconsiderada e o pedido será integrado bloqueado.
• Ao enviar os atributos "deductionsCmv": {"discountsCofins": 0,"discountsIcms":  0,"discountsPis": 0}  no corpo da requisição, será reduzido o valor do CMV considerando os descontos de: PIS, COFINS e ISENÇÃO de ICMS  (Rotina 514- Figura triutária) os valores enviados serão apenas gravados. Esses mesmos dados serão retornados na API de consulta de pedido.
• Sugestão do time de produto modificar o parâmetro(4591) para não permitir alterar o Código Auxiliar ver Link DDRET-6481 DT Criar Parâmetro para Edição de CODAUXILIAR
• Para o processo de múltiplas cobranças, o mesmo só poderá ser utilizado caso o parâmetro 3968 - Permite incluir multiplas cobranças? da Rotina 132 esteja marcado como "Sim". Para cobranças do tipo cartão, o envio do campo "nsu" é obrigatório.
• Ao enviar um item no pedido que seja bonificado/brinde o campo "gift" precisa está como "true", além disso o parâmetro 3045 da rotina 132 deve esta liberado (marcado igual a Sim).
• Ao inserir um pedido, é possível passar o parâmetro booleano "acceptSearchAutomaticFreightType" para permitir ou não a definição automática do tipo de frete baseado no que foi cadastrado para o fornecedor daquela venda. Caso você não informe o tipo de frete (parâmetro "freightDispatch"), e você informe o campo do fornecedor (parâmetro "carrierId"), ele consulte qual o tipo de envio é o padrão para aquele fornecedor, e faça a definição da venda com o mesmo tipo.
• Para validar se o pedido já existe, a api utiliza os campos orderIdHube e orderIdMktplace da requisição (correspondente aos campos pcpedc.numpedhube e pcpedc.numpedmktplace do banco). É utilizada a combinação dos dois campos para validar se o pedido já existe, portanto só serão integrados os pedidos se os dois campos forem distintos de algum registro já existente no banco.

• Sobre o preenchimento do campo de percentual de IPI, esse valor é preenchido quando o método da API busca as informações do produto, com valores cadastrados na rotina 271.
  A partir da versão 1.2.14.4, ao passar pela rotina de cálculo de IPI, será verificado o valor do parâmetro 4753 - Define o valor do percentual do IPI configurado no produto (BUSCAVALORPERCENTUALIPIAPIPEDIDO) , que tem o valor padrão "Sim". Se mantido como "Sim", o sistema continuará definindo o valor preenchido para o percentual de IPI na rotina 271. Caso seja definido como "Não", o sistema atribuirá o valor do percentual de IPI como 0.

• Para recalculo do valor do IPI o parâmetro  4681 - Habilita cálculo reverso para impostos dos itens de valor agregado no pedido de venda deve está marcado igual a sim, o valor de IPI será calculado caso o campo sellPriceIPI não seja informado. 

• Importante:

  • Para que seja calculado o valor do IPI, é necessário as seguintes condições:
    • Não tenha valor de IPI já calculado ou enviado no JSON pelo campo sellPriceIPI.
    • Tenha percentual de IPI Venda, isso é cadastrado na rotina 271.
    • Tenha preço de venda.
    • O parâmetro 4681 - Habilita cálculo reverso para impostos dos itens de valor agregado no pedido de venda (FIL_CALCREVERSOPEDIDOVENDA) esteja com valor "Sim".
  • Se for enviado valor de IPI pelo campo sellPriceIPI na API, esse valor será gravado na tabela normalmente.
• Observação sobre a utilização do processo de múltiplas cobranças:
  • Mesmo enviando a lista de múltiplas cobranças (listPayment) faz-se necessário o envio dos atributos chargingId e paymentPlanId no cabeçalho do pedido. Essas informações serão gravadas na tabela PCPEDC, mas no momento de faturar o pedido serão desconsideradas, pois será considerado o que está gravado na tabela PCFORMAPGTOPEDIDO.
• Será inserido a data atual no campo PCPEDC.DTCALCFRETE sempre que o valor de frete PCPEDC.VLFRETE referente ao campo do JSON "valueFreight" for maior que zero.

 Integração

method: 'POST',
url: '/api/wholesale/v1/orders/'

{
    "createData": "2020-03-23T13:24:36.955102+13:24",
    "orderIdHube": "string",
    "orderIdMktplace": "string",
    "orderStatus": "string",
    "chargingId": "string",
    "carrierId": 0,
	"seller": 0,
    "paymentPlanId": 0,
	"observation": 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
	"deliveryAddressId":0,
    "shippingTrackingCodeSale": "AA1234567892",    

    "customer": {
        "id": 0
    },
	"permissions": {
        "acceptOrderWithoutTax": true,
	 	"acceptSearchAutomaticFreightType": false
    },
	/** Somente enviado para a utilização do cenário de múltiplas cobranças **/
	"listPayment": [
        {
            "chargingId" : "string",
            "paymentPlanId" : 0,
            "expirationDate" : "0000-00-00T00:00:00",
            "value" : 0.0,
            "nsu" : 0
        }
    ],
	"listOfOrderItem": [
        {
            "productSKUERPReferenceKey": "string",
            "sellPrice":0,
			"discountValue":0,
            "quantity": 0.0,
            "realCost": 0.0,
            "warehouseBranchId": "string",
            "gift": true,
            "giftPrice": 0,
            "taxFigureId": 0,                   
            "deliveryType": "RI"
             "deductionsCmv": {
                "discountsCofins": 0,
                "discountsIcms":  0,
                "discountsPis": 0
            
             }    
        }
   ]
}

method: 'POST',
url: '/api/wholesale/v1/orders/'

{
    "branchId": "string",
    "carrierId": 0,
    "chargingId": "string",{
    "createData": "20202021-0308-23T1306T15:2440:3600.955102000000+13:24",15:40",
    "customer": {
        "orderIdHubeactivityId": "string"0,
        "orderIdMktplaceaddressInfo": "string",
        "orderStatusbillingAddress": "string",
        "chargingIdbillingZipCode": "string",
        "DiscountValuebusinessDistrict": 0.0"",
        "carrierIdcityId": 0,
        "paymentPlanIdcommercialAddress": 0"",
        "saleTypecommercialZipCode": 0"",
        "branchIdcorporate": "string"false,
        "saleOrigincorporatePhone": "W",
        "uniqueSequentialNumbercountryId": "string"0,
        "dateUniqueSequentialNumberemail": "string",
        "intermediaryCompanyNamefinalCostumer": "string"false,
        "idIntermediaryEmployerid": "string"0,
        "valueFreightpaymentPlanId": 0,
        "otherExpensessellerId": 0,
        "customersquareId": {0,
        "idstateInscription": 0
"",
        },
	"permissionstradeName": {""
    },
    "acceptOrderWithoutTaxlastChange": true
    },
    "listOfOrderItem"2021-08-06T15:40:00",
	/** Somente retornado em caso de utilização do cenário de múltiplas cobranças **/
	"listPayment": [
        {
            "productSKUERPReferenceKeychargingId" : "string",
            "sellPricepaymentPlanId" : 0,
            "quantity": 0.0"expirationDate" : "0000-00-00T00:00:00",
            "realCostvalue" : 0.0,
            "warehouseBranchIdnsu" : "string",0
        }
    ],     
	"giftlistOfOrderItem": true,[
            "giftPrice": 0,{
            "taxFigureIdaccountingCost": 0
    .0,
    }
    ]
}

{
      "branchIdbasePriceRCA": "string"0.0,
            "carrierIdcomissionPercent": 0,
			"discountPercentage": 0,             
			"chargingIdfecp": "string"0,
    "createData": "2021-08-06T15:40:00.000000+15:40",
        "customerfinancialCost": {0.0,
            "activityIdgift": 0false,
            "addressInfogiftPrice": ""0,
            "billingAddresspackingId": ""0,
            "billingZipCodeposition": ""0,
            "businessDistrictproductId": ""0,
            "cityIdproductSKUERPReferenceKey": 0"00000-00",
            "commercialAddressquantity": ""0.0,
            "commercialZipCoderealCost": ""0.0,
            "corporatereplacementCost": false0.0,
            "corporatePhoneresourceValueCMV": ""0,
            "countryIdresourceValueCustumerCMV": 0,
            "emailsellPrice": ""0.0,
            "finalCostumersellPriceBaseST": false0,
            "idsellPriceIPI": 0,
            "paymentPlanIdsellPriceST": 0,
            "sellerIdstGNRE": 0,
            "squareIdtablePrice": 0.0,
            "stateInscriptiontablePriceIPI": ""0,
        "tradeName": ""
    },
    "lastChangetablePriceST": "2021-08-06T15:40:00"0,
    "listOfOrderItem": [
        {"taxFigureId": 0,
            "accountingCosttruncItem": 0.0false,
            "basePriceRCAwantageQuantity": 0.0,
            "comissionPercentwarehouseBranchId": 0"string",
            "fecpdeliveryType": 0"RI",
            "financialCostdeliveryStatus": 0.0, "R"         
        }
    ],
	"giftpermissions": false,{
            "giftPriceacceptOrderWithoutTax": 0true,
	 	"acceptSearchAutomaticFreightType": false
    },
      "packingIdorderId": 0"string",
    "orderIdHube":   "string",
	"orderIdMktplace: "string",
     "positionorderStatus": 0"string",
    "otherExpenses": 0,
       "productIdpaymentPlanId": 0,
            "productSKUERPReferenceKeysaleOrigin": "00000-00W",
            "quantitysaleType": 0.0,
        "saleTypePayment": "string",
    "realCosttotalValue": "0.0",
            "replacementCost	"observation": 0.0"string",
            "resourceValueCMV": 0,
    "shippingTrackingCodeSale": "string" }

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.

branchId"resourceValueCustumerCMV": 0,
            "sellPrice": 0.0,
            "sellPriceBaseST": 0,
    					- Código da Filial **requerido
daysOfSearch        "sellPriceIPI": 0,
            "sellPriceST": 0,
     					- Dias de Pesquisa (Se não informado, o padrão será 15 dias)
orderId		       "stGNRE": 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)   
 

{
    "branchId": "string "tablePrice": 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",
    "saleTypecarrierId": 0,
    "saleTypePaymentchargingId": "string",
    "totalValuecreateData": "0.0"
}

method: 'GET',
url: '/api/wholesale/v1/orders/'2021-08-06T15:40:00.000000+15:40",
    "customer": {
       -> 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.

branchId "activityId": 0,
        "addressInfo": "",
        "billingAddress": "",
        "billingZipCode": "",
   : 0					- Código da Filial **requerido
daysOfSearch     "businessDistrict": "",
        "cityId": 0					- Dias de Pesquisa
orderId		,
        "commercialAddress": "",
      : 0					- Número Pedido
lastChange "commercialZipCode": "",
        : 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			- Retorna apenas produtos que contenham id de Hube
hasPedidoMktplace : true/ false			- Retorna apenas produtos que contenham id de Marketplace

{
    "branchId": "string",
    "carrierId": 0"corporate": false,
        "corporatePhone": "",
        "countryId": 0,
        "email": "",
        "finalCostumer": false,
        "id": 0,
        "paymentPlanId": 0,
        "sellerId": 0,
        "squareId": 0,
        "stateInscription": "",
        "tradeName": ""
    },
    "chargingIddocument": "string",
{
        "createData": "20211900-0801-06T1501T00:40:00.000000+15:40"00:00",
        "documentNumber": 0,
        "customerkeyDocument": {"",
         "activityId": 0, "lastChange": "1900-01-01T00:00:00"
    },
    "addressInfolastChange": "2021-08-06T15:40:00",
	/** Somente retornado em caso de utilização do cenário de múltiplas cobranças **/
	"billingAddresslistPayment": "",[
        {
  "billingZipCode": "",
          "businessDistrictchargingId" : "string",

            "cityIdpaymentPlanId" : 0,
            "commercialAddressexpirationDate" : "0000-00-00T00:00:00",
            "commercialZipCodevalue" : ""0.0,
            "corporatensu" : false,0
        "corporatePhone": "",}
    ],
      "countryIdlistOfOrderItem": 0,[
        "email": "",
     {
   "finalCostumer": false,
        "idaccountingCost": 0.0,
            "paymentPlanIdbasePriceRCA": 0.0,
           "sellerId "comissionPercent": 0,
			"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,
            "accountingCostrealCost": 0.0,
            "basePriceRCAreplacementCost": 0.0,
            "comissionPercentresourceValueCMV": 0,
            "fecpresourceValueCustumerCMV": 0,
            "financialCostsellPrice": 0.0,
            "giftsellPriceBaseST": false0,
            "giftPricesellPriceIPI": 0,
            "packingId"sellPriceST": 0,
			"sellPriceIcmsPart": 0,
            "positionstGNRE": 0,
            "productIdtablePrice": 0.0,
            "productSKUERPReferenceKeytablePriceIPI": "00000-00"0,
            "quantitytablePriceST": 0.0,
            "realCosttaxFigureId": 0.0,
            "replacementCosttruncItem": 0.0false,
            "resourceValueCMVwantageQuantity": 0,

            "warehouseBranchId": "string"
       "resourceValueCustumerCMV": 0, }
            "sellPricedeductionsCmv": 0.0,
{
                "sellPriceBaseSTdiscountsCofins": 0,
                "sellPriceIPIdiscountsIcms":  0,
                "sellPriceSTdiscountsPis": 0,
             "stGNRE": 0,}     
   ],
	"permissions": {
        "tablePriceacceptOrderWithoutTax": 0.0true,
	 	"acceptSearchAutomaticFreightType": false
     },
     "tablePriceIPIorderId": 0"string",
    "orderIdHube": "string",
	"orderIdMktplace: "string",
      "tablePriceSTorderStatus": 0"string",
    "otherExpenses": 0,
       "taxFigureIdpaymentPlanId": 0,
        "saleOrigin": "W",
    "truncItemsaleType": false0,
      "saleTypePayment": "string",
      "wantageQuantitytotalValue": "0.0",
       	"observation": "string",
     "warehouseBranchIdshippingTrackingCodeSale": "string"
        }
    ],
	"permissions": {
} 

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

Id		            : 0					- ID/Número Pedido (Obrigatório)
sendMessageRca      : true/ false		- Enviar mensagem pro RCA? 
reasonCancellation  : C					- Motivo Cancelamento (Obrigatório)   

Observação: Os pedidos com itens do tipomerc = CB (CESTA BASICA) terão os itens da cesta gravados na tabela PCPEDICESTA no campo CODPRODMP.