get https://{environment}.neomode.com.br/cp/management/commerce/orders/?&&&&
Retorna todos os pedidos de acordo com o filtro utilizado
| Field | Type | Required? | Description |
|---|---|---|---|
| "enviroment" | String | Yes | "api" for production environment, dev-api for development environment |
| "sellerParam" | String | Yes | Id (GUID) or document (CNPJ) |
| "since" | String AAAA-mm-DDT00:00:00.000Z | No | Start Date |
| "until" | String AAAA-mm-DDT00:00:00.000Z | No | End Date |
root.status
root.status| Int Value | Enum Value | Display Name | Descrição técnica / Quando é aplicado |
|---|---|---|---|
| 0 | None | Não informado | Status padrão ou inicial quando o estado do pedido ainda não foi definido. |
| 1 | AwaitingCreation | Aguardando criação do pedido | Pedido aguardando criação ou confirmação inicial no ponto de venda. |
| 2 | CreatedInternal | Pedido criado na Neomode | Pedido foi criado internamente no sistema Neomode (antes de ser enviado ao PDV). |
| 3 | CreatedExternal | Pedido criado pelo ponto de venda | Pedido foi criado com sucesso no PDV. |
| 4 | InProgress | Em andamento | Pedido está sendo processado, atualizado ou aguardando alguma ação intermediária. |
| 5 | AwaitingInvoiceCreation | Em faturamento | Pedido está em processo de faturamento ou geração de nota fiscal. |
| 6 | InvoiceCreated | Faturado | Nota fiscal foi emitida e vinculada ao pedido. |
| 7 | Separated | Produto(s) separado(s) | Itens do pedido foram separados e estão prontos para o envio. |
| 8 | ReadyForPickup | Pronto para retirada | Pedido preparado e disponível para retirada pelo cliente. |
| 9 | Shipping | Em transporte | Pedido saiu para entrega e encontra-se em trânsito. |
| 10 | Finalized | Pedido finalizado | Pedido entregue ou concluído com sucesso. |
| 11 | Canceled | Pedido cancelado | Pedido cancelado por qualquer motivo (cliente, PDV ou sistema). |
| 12 | Error | Pedido com erro | Ocorreu um erro durante o processamento do pedido. |
| 13 | WaitingCreateShippingLabel | Aguardando geração da etiqueta de postagem | Pedido pronto, aguardando a criação da etiqueta de envio. |
| 14 | ReadyForShipping | Pedido pronto para transporte | Pedido embalado e pronto para ser despachado. |
| 15 | CreateShippingLabel | Etiqueta de postagem gerada | Etiqueta de envio foi criada e vinculada ao pedido. |
| 16 | WaitingCancellationDecision | Aguardando decisão sobre cancelamento | Pedido em análise, aguardando confirmação ou recusa do cancelamento. |
Dados gerais do pedido no retorno
| Field | Type | Description |
|---|---|---|
| "id" | String | Identificador do pedido na plataforma de integração |
| "createDate" | Date | Data de criação |
| "externalId" | String | Id do pedido no canal de venda (marketplce ou app) |
| "channel" | String | Canal de Vendas |
| "friendlyCode" | String | Código amigável do pedido |
| "cpfPickUp" | String | CPF de retirada do pedido (para modalidade "retire na loja") |
| "cpfInvoice" | String | CPF de Cobrança\Fatura |
| "invoiceUrl" | String | URL da fatura |
| "bonusAmount" | Float | Valor de desconto do CRM bônus |
| "isDelivery" | Boolean | Quando "true" indica que a modelidade é "Receba em casa" , quando "false" indica "Retire na loja" |
| "maxPickUpTime" | Boolean | Tempo máximo de entrega |
| "status" | Int | Id da situação do pedido |
Dados do consumidor
| Campo | Tipo de dado | Descrição |
|---|---|---|
| "buyer" | Objeto | Objeto com dados do comprador |
| "cpf" | String | CPF do comprador |
| "phoneNumber" | String | Telefone |
| "deviceToken" | String | Token do dispositivo |
| "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 |
| "latitude" | String | Latitude |
| "longitude" | String | Latitude |
| "reference" | String | Referência |
| "fullAddress" | String | Endereço completo |
| "id" | String | id do comprador na plataforma de integração |
| "clientId" | String | Id no ponto de venda |
| "createDate" | Date | Data de criação |
| "lastUpdate" | Date | Data de última atualização |
| "fullName" | String | Nome completo do comprador |
| "email" | String | e-mail dom comprador |
| "id" | String | id do comprador na plataforma de integração |
| "clientId" | String | Id do ponto de venda |
| "createDate" | Date | Data de criação |
| "lastUpdate" | Date | Data de atualização |
| "invoice" | Objeto | Objeto de Fatura (nota fiscal) |
| "key" | String | Chave da nota fiscal |
| "number" | String | Número da nota |
| "serieNumber" | Number | Série da nota fiscal |
| "totalAmount" | Number | Valor total da nota |
Dados do vendedor
| Campo | Tipo de dado | Descrição |
|---|---|---|
| "seller" | Objeto | Objeto Loja |
| "cnpj" | String | CNPJ da Loja |
| "pointSaleId" | String | Canal de venda |
| "dealerCode" | Number | Código do vendedor na loja física |
Dados do frete
| Campo | Tipo de dado | Descrição |
|---|---|---|
| "deliveryTime" | Number | Tempo para entrega (dias) |
| "amount" | String | 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 |
| "fullAddress" | String | Endereço completo |
| "clientId" | String | Id do vendedor |
| "createDate" | Date | Data de criação do registro |
| "lastUpdate" | Date | data de atualização |
Itens dos pedidos
| 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 |
| "sku" | Objeto | Objeto do SKU |
| "code" | String | Código do SKU |
| "auxCode" | String | Código auxiliar do SKU |
| "barcode" | String | Código de barras |
| "name" | String | Nome complementar do SKU (para ser concatenado com produto principal) |
| "productSku" | String | Nome completo do SKU |
| "productCode" | String | Código do produto principal |
| "attributes" | Array | Atributos do SKU |
| "product" | Objeto | Objeto produto |
| "code" | String | Código do produto |
| "name" | String | Nome do produto |
| "complementaryName" | String | Nome complementar |
| "unitPrice" | Number | Preço unitário |
| "unitOldPrice" | Number | Último preço |
| "id" | String | Id do produto na biblioteca de integração |
Status do pedido
Para se capturar o atual status do pedido, deve ser verificado o campo "status" no pedido.
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 |
| "quantityInstallments" | Number | Quantidade de parcelas |
| "paymentStatus" | Number | Status do pagamento |
| "paymentMethod" | Objeto | Objeto com dados do método de pagamento |
| "info" | String | Descrição do método de pagamento |
| "createDate" | Date | Data do registro do pagamento |
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 do pedido |
| "totalWithoutFeeAmount" | Number | Total sem o frete |
| "totalAmount" | Number | Total (itens + frete) |
Exemplo de retorno:
[
{
"id":"04a271fd-ba93-4393-bddd-4c5b69b473ec", -->id do pedido na plataforma de integração
"createDate":"2021-05-06T18:14:11.1523482Z", -->data de criação
"externalId":"1130180812765-01", --> id do pedido no martetplace
"channel":"marketplace", --> canal de vendas
"friendlyCode":"PD-JLC9FZ", --> Código amigável do pedido
"cpfPickUp":null, --> CPF de retirada
"cpfInvoice":"88119377515", -> CPF para fatura
"invoiceUrl":null,
"dealerCode":null,
"feeAmount":0.0,
"bonusAmount": 0.0,
"isDelivery":true,--> Campo de definição se é entrega ou não (quando sim recebe true)
"isCvvValidated":false,
"maxPickUpTime":null,
"status":2, --> Id do Status do pedido
"buyer":{
"cpf":"88119377515",
"phoneNumber":"0000-0000",
"deviceToken":null,
"imageUrl":null,
"gender":0,
"dateOfBirth":null,
"address":
{
"street":"Rua Juá",
"number":"197",
"complement":"ap 31",
"neighborhood":"Saúde",
"cep":"04138-020",
"city":"São Paulo",
"state":"SP",
"latitude":null,
"longitude":null,
"reference":null,
"label":null,
"fullAddress":"Rua Juá, 157 ap 391 - Saúde - 04138-020 | São Paulo - SP",
"id":"84ff853e-df72-4bc7-8271-cac98b83a653",
"clientId":null,
"createDate":"2021-05-06T18:14:11.1554661Z",
"lastUpdate":"2021-05-06T18:14:11.1554661Z"
},
"fullName":"Implantacao Neomode",
"email":"[email protected]",
"id":"55a098af-5f45-4822-bea4-95c0b20c3532",
"clientId":null,
"createDate":"2021-05-06T18:14:11.1552374Z",
"lastUpdate":"2021-05-06T18:14:11.1552374Z"},
"invoice":
{
"key":null,
"number":null,
"serieNumber":0,
"totalAmount":0.0,
"xmlUrl":null,
"fileUrl":null,
"issuanceDate":"0001-01-01T00:00:00",
"id":"050e74dc-ddad-43c2-9f86-59d62cae3394",
"clientId":null,
"createDate":"2021-05-06T18:14:11.1527435Z",
"lastUpdate":"2021-05-06T18:14:11.1527435Z"
},
"modality":null,
"seller":
{
"cnpj":"01098883568879",
"companyName":"CNPJ = 01098883568879",
"pointSaleId":"marketplace",
"whatsappPhoneNumber":null,
"isEcommerce":false,
"gatewayId":null,
"credentialsString":"[email protected]",
"distance":0.0,
"processId":null,
"hasFullCartStockAvailable":false,
"integrationConfig":null,
"workingHours":null,
"address":
{
"street":null,
"number":null,
"complement":null,
"neighborhood":null,
"cep":null,
"city":null,
"state":null,
"latitude":-20.4630729,
"longitude":-54.6192893,
"reference":null,
"label":null,
"fullAddress":", - - | - ",
"id":"fc464623-7729-4628-bef3-aa4528d4a61f",
"clientId":null,
"createDate":"2020-11-19T11:45:36.7510524",
"lastUpdate":null},
"fullName":"Loja Balneário do Sul",
"email":"[email protected]",
"id":"1afddece-9e39-4583-a903-da3cb2788435",
"clientId":"saj-baln-sul",
"createDate":"2020-11-19T11:45:36.761738",
"lastUpdate":"2021-05-06T18:14:11.1532158Z"
},
"freight":
{
"deliveryTime":0,--> Tempo de entrega em dias
"calculationKey":null,
"reference":null,
"description":null,
"amount":0.0,
"id":"7d2d4c7a-dd7d-4f10-8093-e02f0c301b7e",
"clientId":null,
"createDate":"2021-05-06T18:14:11.1558289Z",
"lastUpdate":"2021-05-06T18:14:11.155829Z"
},
"voucher":null,
"deliveryAddress":--> Dados de entrega
{
"street":"Rua Juá",
"number":"197",
"complement":"ap 31",
"neighborhood":"Saúde",
"cep":"04138-020",
"city":"São Paulo",
"state":"SP",
"latitude":null,
"longitude":null,
"reference":null,
"label":null,
"fullAddress":"Rua Juá, 197 ap 31 - Saúde - 04138-020 | São Paulo - SP",
"id":"15823a9d-b421-4d42-bd16-0a52e4a2565b",
"clientId":null,
"createDate":"2021-05-06T18:14:11.1565285Z",
"lastUpdate":"2021-05-06T18:14:11.1565285Z"
},
"paymentInfo":
{
"externalOrderId":null,
"externalFraudId":null,
"externalRefundId":null,
"externalCaptureId":null,
"externalReversalId":null,
"externalTransactionId":null,
"nsu":null,
"acquirerApprovalCode":null,
"isCaptured":true,
"isReversed":false,
"isRefunded":false,
"isAuthorized":true,
"invoiceUrl":null,
"acquirerMessage":"Pagamento assumido pela Yami",
"bankCode":null,
"bankSlipUrl":null,
"bankSlipLine":null,
"bankSlipExpirationDate":null,
"statusMessage":null,
"fraudStatusMessage":null,
"amount":0.0,
"quantityInstallments":1,
"fraudStatus":0,
"paymentStatus":6,
"paymentMethod":
{
"info":"Pagamento externo",
"cardHolder":null,
"brand":null,
"finalNumber":null,
"binNumber":null,
"type":4,
"expiration":null,
"cvvHash":null,
"cvvEncrypted":null,
"number":null,
"token":null,
"externalId":null,
"externalCustomerId":null,
"modality":0,"id":"e69ff934-fff3-4f37-879a-024764e473ca",
"clientId":null,
"createDate":"2021-05-06T18:16:11.1763426Z",
"lastUpdate":"2021-05-06T18:16:11.1763426Z"
},
"retryCount":0,
"hasChangedProgrammatically":false,
"receivingMethod":null,
"splits":null,
"id":"99bea3bf-dffb-4c0c-a39b-0dae6ac7921d",
"clientId":null,
"createDate":"2021-05-06T18:14:11.1561987Z",
"lastUpdate":"2021-05-06T18:14:11.1561988Z"
},
"dealer":null,
"items":--Dados dos Itens
[
{
"quantity":2,
"discountPrice":0.0,
"sku":
{
"code":"366814",
"auxCode":"7891186101185",
"barcode":"7891186101185",
"name":"Único",
"imageUrl":null,
"productSku":"Meia Lupo Preta - Único",
"productCode":"419898",
"attributes":
[],
"product":
{
"code":"419898",
"name":"Meia Lupo Preta",
"complementaryName":null,
"imageUrl":null,
"unitPrice":14.99,
"unitOldPrice":14.99,
"unitWholesalePrice":0.0,
"wholesaleQuantity":0,
"defaultMaxInstallments":0,
"voucherMaxInstallments":null,
"maxInstallments":0,
"isRepriceProduct":false,
"id":"48949d45-37dd-4b25-b745-997f150a7361",
"clientId":"saj-baln-paqueta",
"createDate":"2021-05-06T18:14:11.2724467Z",
"lastUpdate":"2021-05-06T18:14:11.2724468Z"
},
"id":"e597b502-8137-4706-9b46-e7e4bc6328f1",
"clientId":"saj-baln-sul",
"createDate":"2021-01-25T19:39:43.93",
"lastUpdate":"2021-01-25T19:39:43.9666667"
},
"isGift":false,
"unitPrice":14.99,
"subTotalAmount":29.98,
"totalAmount":29.98,
"price":29.98,
"totalPrice":29.98,
"id":"c8c0f6d4-e706-41fa-a549-f0b29e45ea9f",
"clientId":null,
"createDate":"2021-05-06T18:14:11.273168Z",
"lastUpdate":"2021-05-06T18:14:11.273168Z"}],
"steps":-->Histórico de status registrados do pedido
[
{
"description":"Pedido realizado",
"action":null,
"actionUrl":null,
"actionText":null,
"position":1.0,
"level":3,
"status":0,
"id":"1a9727ff-9023-48d4-888e-0d5ba4e94466",
"clientId":null,
"createDate":"2021-05-06T18:14:11.5737844Z",
"lastUpdate":"2021-05-06T18:14:11.5737846Z"
},
{
"description":"Pagamento confirmado",
"action":null,
"actionUrl":null,
"actionText":null,
"position":2.0,
"level":3,
"status":1,
"id":"fce576b5-0f38-4f2c-9ad4-334c83f75854",
"clientId":null,
"createDate":"2021-05-06T18:14:11.5738862Z",
"lastUpdate":"2021-05-06T18:14:11.5738862Z"
},
{
"description":"Aguardando nota fiscal",
"action":null,
"actionUrl":null,
"actionText":null,
"position":3.0,
"level":1,
"status":2,
"id":"8c7f0cb6-aafd-4a3b-b981-0f864fbdc5c2",
"clientId":null,
"createDate":"2021-05-06T18:14:11.5738951Z",
"lastUpdate":"2021-05-06T18:14:11.5738952Z"},
{
"description":"Em transporte",
"action":null,
"actionUrl":null,
"actionText":null,
"position":4.0,
"level":1,
"status":3,
"id":"32ff01ca-72be-491b-a029-877c3148dab4",
"clientId":null,
"createDate":"2021-05-06T18:14:11.5738964Z",
"lastUpdate":"2021-05-06T18:14:11.5738964Z"
},
{
"description":"Pedido finalizado",
"action":null,"actionUrl":null,
"actionText":null,
"position":5.0,
"level":1,
"status":4,
"id":"953f23fc-14f4-4684-90e9-6a412116f485",
"clientId":null,
"createDate":"2021-05-06T18:14:11.5738976Z",
"lastUpdate":"2021-05-06T18:14:11.5738976Z"
}
],
"actionLogs":
[
{
"title":null,
"displayMessage":"Pedido recebido na Lori",
"internalMessage":"order: 04a271fd-ba93-4393-bddd-4c5b69b473ec order create at Lori successful",
"issuer":null,
"urlLog":null,
"type":1,
"level":0,
"specificActionType":0,
"id":"ee3746e6-b414-4d6f-b2be-e0593c5f8956",
"clientId":null,
"createDate":"2021-05-06T18:14:11.5739745Z",
"lastUpdate":"2021-05-06T18:14:11.5739743Z"
},
{
"title":"Pagamento",
"displayMessage":"O pagamento será processado pelo parceiro externo",
"internalMessage":"order: 04a271fd-ba93-4393-bddd-4c5b69b473ec will be external payment",
"issuer":"Parceiro externo",
"urlLog":null,
"type":2,
"level":1,
"specificActionType":0,
"id":"211c6139-1306-4a82-b536-82d9c653c4d8",
"clientId":null,
"createDate":"2021-05-06T18:14:11.5841394Z",
"lastUpdate":"2021-05-06T18:14:11.574083Z"
}
],
"buttons":
[],
"hasFeeInstallment":false,
"maxInstallmentsWithTax":1,
"maxVoucherInstallmentsWithoutTax":null,
"maxProductInstallmentsWithoutTax":null,
"maxInstallmentsWithoutTax":1,
"discountAmount":0.0,
"subTotalAmount":29.98,
"freightAmount":0.0,
"totalWithoutFeeAmount":29.98,
"totalAmount":29.98
}
]