post https://{environment}.neomode.com.br/management/commerce/orders
Registra pedidos na LORI.
Exemplo de envio
{
"createDate": "", //date
"externalId": "0000582633", //string
"channel": "marketplace", //string
"cpfPickUp": "", //string
"dealerCode": "", //string
"isDelivery": true, //bool
"status": "",
"orderNote" : "", //string
"buyer": {
"fullName": "Silvia Muller Kauffman",
"email": "[email protected]",
"cpf": "38725567881",
"phoneNumber": "99999999999",
"gender": 0,
"dateOfBirth": null, //date
"address": {
"street": "Rua Doutor Albuquerque Lins",
"number": "993",
"complement": "ap. 111 ",
"neighborhood": "Santa Cecília",
"cep": "01230-001",
"city": "São Paulo",
"state": "SP",
"reference": null, //string
"label": null //Nome do endereço - string
}
},
"seller": {
"cnpj": "95736210000159",
"pointSaleId": "95736210000159"
},
"freight": {
"deliveryTime": 3,
"deliveryTimeUnit" : "",
"estimateDate": "",
"reference": "Motoboy",
"description": "Motoboy",
"amount": 0.0
},
"deliveryAddress": {
"street": "Rua Avenida Alameda",
"number": "100",
"complement": "ap. 111 ",
"neighborhood": "Santa Cecília",
"cep": "01230-001",
"city": "São Paulo",
"state": "SP",
"latitude": null, //opcional
"longitude": null, //opcional
"reference": null,
"label": null
},
"paymentInfo": {
"externalTransactionId": "333040819",
"nsu": "333040819",
"acquirerApprovalCode": "038893",
"acquirerMessage": "Mastercard",
"statusMessage": null,
"feeAmount": 0.0,
"amount": 264.0,
"quantityInstallments": 2,
"paymentMethod": {
"type": 1,
"info": "Mastercard - **** **** **** 6455",
//Cartão Crédito ou Débito
"cardHolder": null,
"brand": "mastercard",
"number": null, //opcional
"finalNumber": "6455",
"binNumber": "549167",
"expiration": null, //opcional
//Boleto
"bankCode": null,
"bankSlipUrl": null,
"bankSlipLine": null,
"bankSlipExpirationDate": null
}
},
"items": [
{
"quantity": 1,
"unitPrice": 79.0,
"subTotalAmount": 79.0,
"discountPrice": 0.0,
"totalAmount": 79.0,
"itemNote" : "",
"sku": {
"code": "7721",
"auxCode": null,
"barcode": "7909300239857",
"productCode": "2724"
"product":{
" unitPrice":220.00
}
},
"isGift": false,
"giftMessage" : "",
"coupon" : ""
}
],
"discountAmount": 0.0,
"subTotalAmount": 264.0,
"freightAmount": 0.0,
"totalAmount": 264.0
}
Listagem de campos do pedido
Dados gerais do pedido
| Campo | Tipo de dado | Descrição |
|---|---|---|
| "createDate" | Date | Data de criação |
| "externalId" | String | Id do pedido no canal de venda (marketplce ou app) |
| "channel" | String | Canal de vendas (exemplo "Marketplace") |
| "cpfPickUp" | String | CPF de retirada do pedido (para modalidade "retire na loja") |
| "dealerCode" | String | Código do vendedor |
| "isDelivery" | Boolean | Quando "true" indica que a modelidade é "Receba em casa" , quando "false" indica "Retire na loja" |
| "status" | Int | Id da situação do pedido |
| "orderNote" | String | Descrição informativa do pedido |
Dados do consumidor
| Campo | Tipo de dado | Descrição |
|---|---|---|
| "buyer" | Objeto | Objeto com dados do comprador |
| "fullName" | String | Nome completo do comprador |
| "email" | String | E-mail do comprador |
| "cpf" | String | CPF do comprador |
| "phoneNumber" | String | Telefone |
| "gender" | Inteiro | Quando "0" masculino, quando "1" feminino |
| "dateOfBirth" | date | Data de aniversário |
| "address" | Objeto | Objeto de endereço |
| "street" | String | Rua |
| "number" | String | Número |
| "complement" | String | Complemento |
| "neighborhood" | String | Bairro |
| "cep" | String | CEP |
| "city" | String | Cidade |
| "state" | String | Estado |
| "reference" | String | Referência |
| "label" | String | Nome do endereço (exemplo: casa, trabalho e etc ) |
Dados do vendedor
| Campo | Tipo de dado | Descrição |
|---|---|---|
| "seller" | Objeto | Objeto Loja |
| "cnpj" | String | CNPJ da Loja |
| "pointSaleId" | String | Canal de venda |
Dados do frete
| Campo | Tipo de dado | Descrição |
|---|---|---|
| "deliveryTime" | Number | Tempo para entrega (dias) |
| "deliveryTimeUnit" | String | Unidade de tempo de entrega |
| "estimateDate" | Date | Data prevista de entrega |
| "reference" | String | Referência do tipo de frete (exemplo motoboy) |
| "description" | String | Descrição do frete |
| "amount" | Number | Valor total do frete |
Endereço de entrega
| Campo | Tipo de dado | Descrição |
|---|---|---|
| "deliveryAddress" | Objeto | Objeto de endereço de entrega |
| "street" | String | Rua |
| "number" | String | Número |
| "complement" | String | Complemento |
| "neighborhood" | String | Bairro |
| "cep" | String | CEP |
| "city" | String | Cidade |
| "state" | String | Estado |
| "latitude" | String | Latitude |
| "longitude" | String | Longitude |
| "label" | String | Nome do endereço (exemplo: casa, trabalho e etc ) |
Itens do pedido
| Campo | Tipo de dado | Descrição |
|---|---|---|
| Itens | Array | Array com produtos que fazem parte do pedido |
| "quantity" | Number | Quantidade do item no pedido |
| "discountPrice" | Number | Valor de desconto aplicado para o item |
| "subTotalAmount" | Number | unitprice * quantity |
| "discountPrice" | Number | Valor de desconto |
| "totalAmount" | Number | subTotalAmount - discountPrice |
| "itemNote" | String | Observação do item |
| "sku" | Objeto | Objeto do SKU |
| "code" | String | Código do SKU |
| "auxCode" | String | Código auxiliar do SKU |
| "barcode" | String | Código de barras |
| "productCode" | String | Código do produto principal |
| isGift | Boolean | Caso item seja um presente deve estar marcado como true, se não, false. |
| "giftMessage" | String | Mensagem de presente |
| "coupon" | String | Código do cupom aplicado no item |
Dados de pagamento são retornados no objeto "paymentInfo". A seguir os principais campos.
| Campo | Tipo de dado | Descrição |
|---|---|---|
| "paymentInfo" | Objeto | Objeto com dados de pagamento |
| "externalTransactionId" | String | Id externo da transação |
| "nsu" | String | Número sequencial único retornado em uma operação de venda realizada com cartões |
| "acquirerApprovalCode" | String | Código de aprovação de adquirente |
| "acquirerMessage" | String | Mensagem de retorno do adquirente (exemplo: Mastercard) |
| "statusMessage" | String | status da mensagem |
| "feeAmount" | Number | Total de taxa |
| "amount" | Number | Total pago |
| "quantityInstallments" | Number | Quantidade de parcelas |
| "paymentMethod" | Objeto | Objeto com dados do método de pagamento |
| "type" | Number | Tipo do método de pagamento. *ver listagem de tipos a seguir |
| "info" | String | Descrição do método de pagamento |
Listagem de tipos de pagamento
| Código do tipo | Aplicação |
|---|---|
| 1 | Cartão Crédito |
| 2 | Cartão de débito |
| 3 | Boleto bancário |
| 4 | Voucher |
| 5 | Pix |
Campos para pagamento com tipo 1 e 2 (cartão de crédito e débito)
| Campo | Tipo de dado | Obrigatório | Descrição |
|---|---|---|---|
| cardHolder | String | Não | Titular do cartão |
| "brand" | String | Sim | Bandeira do cartão |
| "number" | Cartão | Não | Número do cartão |
| "finalNumber" | Número final do cartão | Sim | Número final do cartão |
| "binNumber" | String | Sim | Número de identificação bancária |
| "expiration" | string | Não | Data de expiração do cartão. |
Totais do pedido
| Campo | Tipo de dado | Descrição |
|---|---|---|
| "subTotalAmount": | Number | Valor dos itens do pedido, sem aplicar descontos e encargos |
| "freightAmount" | Number | Valor dos encargos de frete do pedido |
| "discountAmount" | Number | Total de descontos do pedido |
| "totalAmount" | Number | Total (itens + frete) |