get https://{environment}.neomode.com.br/cp/management/commerce/sellers//orders
Retorna os pedidos de uma loja específica
Explicação dos parâmetros de path e query:
path
path
Valor cadastrado em Seller.Cnpj
query
:
query
:Parâmetro | Tipo | Obrigatório | Descrição |
---|---|---|---|
date | date | Sim | Fixo. Data de corte inicial. Sempre enviar com o valor 2020-01-01T00:01:01 . (ISO 8601) |
lastUpdateSince | date | Sim | Retorna dados atualizados a partir de uma determinada data. Ex: 2025-07-13T23:59:00 . (ISO 8601) |
lastUpdateUntil | date | Sim | Retorna dados atualizados até uma determinada data. Ex: 2025-07-14T18:32:59 . (ISO 8601) |
status | int | Sim | Status inicial dos pedidos pagos: 2 |
Dados gerais do pedido no retorno
🔄 Pedido
Campo | Tipo | Descrição |
---|---|---|
id | string | Identificador único do pedido (UUID). |
externalId | string | Identificador externo do pedido. |
friendlyCode | string | Código amigável exibido ao cliente. |
sellerOrderID | string | Identificador ERP do pedido. |
createDate | datetime | Data de criação do pedido (ISO 8601). |
lastUpdate | datetime | Última atualização do pedido (ISO 8601). |
status | string | Status interno do pedido (ex: CreatedInternal ). |
canonicalStatus | string | Status canônico (padronizado). |
channel | string | Canal de origem do pedido (ex: app , ecommerce , padrão: Neomode ). |
isDelivery | boolean | Indica se o pedido é para entrega. |
subTotalAmount | number | Valor total dos itens (sem frete). |
totalAmount | number | Valor total do pedido (itens + frete). |
quantity | int | Quantidade total de itens no pedido. |
🛒 Itens do Pedido (order.items[]
)
order.items[]
)Campo | Tipo | Descrição |
---|---|---|
quantity | int | Quantidade solicitada. |
unitPrice | number | Preço unitário do SKU (sem desconto). |
totalAmount | number | Valor total do SKU (com descontos aplicados). |
discountPrice | number | Valor total de desconto aplicado (não unitário). |
sku.code | string | Código principal cadastrado (ERP). |
sku.barcode | string | Código de barras (GTIN / EAN). |
sku.productSku | string | Nome do produto e variação. |
sku.name | string | Nome da variação (ex: tamanho). |
isGift | boolean | Indica se o item é um presente. |
coupon | string | Código do cupom aplicado (se houver). |
usingWholesalePrice | boolean | Indica se usou preço de atacado. |
price | number | Preço unitário (sem desconto). |
subTotalAmount | number | Subtotal do item (sem descontos). |
totalPrice | number | Preço total considerando a quantidade. |
👤 Cliente
Campo | Tipo | Descrição |
---|---|---|
documentType | int | Tipo de documento: 1 = Pessoa Física, 2 = Pessoa Jurídica |
cpfBuyer | string | CPF do comprador. |
cnpjBuyer | string | CNPJ do comprador, se aplicável. |
fullName | string | Nome completo do comprador. |
companyName | string | Nome da empresa do comprador, se aplicável. |
📍 Endereço de Entrega (order.seller.address
)
order.seller.address
)Campo | Tipo | Descrição |
---|---|---|
street | string | Rua do endereço. |
number | string | Número do endereço. |
neighborhood | string | Bairro. |
cep | string | Código postal (CEP). |
city | string | Cidade. |
state | string | Estado. |
fullAddress | string | Endereço completo formatado. |
🛍️ Informações do Vendedor (order.seller
)
order.seller
)Campo | Tipo | Descrição |
---|---|---|
dealerCode | string | Código do vendedor ou loja. |
cnpj | string | CNPJ do vendedor. |
companyName | string | Nome da empresa vendedora. |
fullName | string | Nome completo do ponto de venda. |
pointSaleId | string | Identificador do ponto de venda. |
email | string | E-mail de contato do ponto de venda. |
🎟️ Cupom de Desconto
Campo | Tipo | Descrição |
---|---|---|
coupon | string | Código do cupom de desconto aplicado. |
📦 Logística e Nota Fiscal
Campo | Tipo | Descrição |
---|---|---|
invoice.key | string | Chave da nota fiscal. |
invoice.number | string | Número da nota fiscal. |
invoice.serieNumber | int | Série da nota fiscal. |
invoice.totalAmount | number | Valor total da nota fiscal. |
invoice.issuanceDate | datetime | Data de emissão da NF-e. |
orderPackageId | string | Identificador do pacote (se houver). |
🚚 Informações de Frete (order.freight
)
order.freight
)Campo | Tipo | Descrição |
---|---|---|
reference | string | Nome ou código da transportadora. |
deliveryTime | int | Prazo de entrega (em dias). |
estimateDate | datetime | Data estimada de entrega. |
amount | number | Valor do frete. |
💳 Informações de Pagamento (order.paymentList[]
)
order.paymentList[]
)Campo | Tipo | Descrição |
---|---|---|
nsu | string | Número sequencial da transação. |
acquirerApprovalCode | string | Código de aprovação do adquirente. |
externalTransactionId | string | ID externo da transação. |
quantityInstallments | int | Quantidade de parcelas. |
amount | number | Valor total do pagamento. |
paymentStatus | int | 0 = Não pago, 5 = Pré-aprovado, 6 = Pago |
paymentMethod.type | int | 1 = Cartão de Crédito, 6 = Pix, 3 = Boleto |
paymentMethod.brand | string | Bandeira do cartão (se aplicável). |
paymentCode | string | Código Pix ou Boleto. |
expirationDate | datetime | Data de expiração do pagamento. |
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
}
]