Páginas filhas
  • APIs Integrações - Pedido

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Totvs custom tabs box
tabsDados integrados c/ Winthor, Gravação Pedido/Retorno, Consulta de Pedido
idspasso1,passo2,passo3

A integração consiste em receber e enviar dados do pedido que serão utilizados no E-Commerce.

Totvs custom tabs box items
defaultyes
referenciapasso1

Os dados integrados são: 

APIPCPEDCPCPEDIDescriçãoTipoObrigatório
createDatapcpedc.datapcpedi.dataData de criação do pedido

Data (DD/MM/YYYY)

Não
idpcpedc.codclipcpedi.codcliIdentificador do ClienteNuméricoSim
orderIdpcpedc.numpedpcpedi.numpedIdentificador do pedidoNuméricoNão
orderStatuspcpedc.posicao
Estado do pedidoTextoNão
chargingIdpcpedc.codcob
Identificador de cobrançaTextoNão
TotalPricepcpedc.vltotal
Preço total do pedidoNuméricoNão
paymentPlanIdpcpedc.codplpag
Identificador do plano de pagamentoTextoSim
saleTypepcpedc.condvenda
Tipo de venda

     "1"  - Venda normal

     "5" - Bonificação ou brinde.*

     "7" - Venda para Entrega Futura*

     "8" - Simples Remessa de Venda para Entrega Futura*

  • Para uso futuro.
NuméricoSim
branchIdpcpedc.codfilial
Código da FilialTextoSim
saleOriginpcpedc.origemped
Origem do pedidoTextoNão
productSKUERPReferenceKey
pcpedi.codprodEmbalagem do produtoTextoSim
sellPrice
pcpedi.pvendaPreço do produtoNuméricoSim
quantity
pcpedi.qtQuantidade do produtoNuméricoSim
realCost
pcpedi.vlcustorealCusto RealNuméricoNão
warehouseBranchId
pcpedi.codfilialretiraCódigo de praçaTextoSim
position
pcpedi.numseqSequência do pedidoNuméricoNão
taxFigureId
pcpedi.codstFigura tributária da rotina 514NuméricoNão
discountValue
pcpedi.perdescPercentual de desconto aplicado no itemNuméricoNão
valueFreightpcpedc.vlfrete
Valor de freteNuméricoNão
intermediaryCompanyNamepcpedc.descintermediador
Razão Social do Intermediador marketplace ou e-commerceTextoNão
idIntermediaryEmployerpcpedc.cnpjintermediador
CNPJ do Intermediador marketplace ou e-commerceTextoNão
carrierIdpcpedc.codfornecfrete
Identificado da transportadoraNuméricoNão
sellerpcpedc.codusurpcpedi.codusurCódigo do RCA, caso não enviado será utilizado o definido no parâmetro "4012 - Código do RCA para cadastro de clientes na Ciashop" da rotina 132- Parâmetros da PresidênciaNuméricoNão
lastChangepcpedc.dtfat (prioridade 1)
Data de faturamento do pedidoData (DD/MM/YYYY)Não
lastChangepcpedc.data (prioridade 2)
Data de emissão do pedidoData (DD/MM/YYYY)Não
orderIdHubepcpedc.numpedhube
Número do pedido realizado via hube ou conectorTextoNão
orderIdMktplacepcpedc.numpedmktplace
Número do pedido realizado via marketplaceTextoNão
freightDispatchpcpedc.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)

    

   

TextoNão
uniqueSequentialNumberpcpedc.nsu
NSUTEF - Apenas para forma de pagamento cartãoNuméricoNão
dateUniqueSequentialNumberpcpedc.dtnsu
Data do número sequencial único do cartão de créditoData (DD/MM/YYYY)Não
otherExpensespcpedc.vloutrasdesp
Outras despesas Numérico

Não


gift
pcpedi.bonificItem bonificado/brindeBoolean

Não

observationpcpedc.obs
Observação do pedidoStringNão
deliveryType
 pcpedi.tipoentrega

Tipo de entrega

Valores:
   RP - Retira Posterior
   RI  - Retira Imediata
   EN - Entrega Normal
   EF  - Encomenda


*Obs: disponível a partir da versão: 1.2.0.1078

StringNão
deliveryStatus

Status Entrega


Valores:
   A: Aguardando 
   R: Pronto Retirada
   E: Entregue


*Obs: disponível a partir da versão: 1.2.0.1078

StringNão
deliveryAddressIdpcpedc.codendentcli

Código do endereço de entrega

*Obs: disponível a partir da versão: 1.2.0.1097

NuméricoNão

sellPriceIPI






Totvs custom tabs box items
defaultno
referenciapasso2

Exemplo do envio da requisição:

Bloco de código
languagejs
titleURI
method: 'POST',
url: '/api/wholesale/v1/orders/'
Bloco de código
languagejs
titleBody Request
{
    "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,
    "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
            
             }    
        }
   ]
}
Bloco de código
languagejs
titleBody 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": "",
        "tradeName": ""
    },
    "lastChange": "2021-08-06T15:40:00",
	/** Somente retornado em caso de 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": [
        {
            "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,
            "stGNRE": 0,
            "tablePrice": 0.0,
            "tablePriceIPI": 0,
            "tablePriceST": 0,
            "taxFigureId": 0,
            "truncItem": false,
            "wantageQuantity": 0,
            "warehouseBranchId": "string",
            "deliveryType": "RI",
            "deliveryStatus": "R"         
        }
    ],
	"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",
	"observation": "string"
}
Totvs custom tabs box items
defaultno
referenciapasso3

As consultas referente aos pedido, apresentam o JSON na resposta da requisição:  

Bloco de código
languagejs
titleURI
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
languagejs
titleParams
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
languagejs
titleBody 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": "",
        "tradeName": ""
    },
    "document": {
        "createData": "1900-01-01T00:00:00",
        "documentNumber": 0,
        "keyDocument": "",
        "lastChange": "1900-01-01T00:00:00"
    },
    "lastChange": "2021-08-06T15:40:00",
	/** Somente retornado em caso de 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": [
        {
            "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,
	 	"acceptSearchAutomaticFreightType": false
    },
    "orderId": "string",
    "orderIdHube": "string",
	"orderIdMktplace: "string",
    "orderStatus": "string",
    "otherExpenses": 0,
    "paymentPlanId": 0,
    "saleOrigin": "W",
    "saleType": 0,
    "saleTypePayment": "string",
    "totalValue": "0.0",
	"observation": "string"
}