get https://{environment}.neomode.com.br/cp/management/commerce/sellers//orders
Returns orders from a specific store in determinated interval.
Fetch orders placed on connected channels, including customer, product, payment, and delivery information. Notify the channel that the order has been received and is being processed.
The ERP must query orders by store (defined in the path parameter) at intervals defined by query parameters.
Explanation of path and query parameters:
path
pathValue registered in Seller.Cnpj
query:
query:| Parameter | Type | Required | Description |
|---|---|---|---|
date | date | Yes | Fixed. Initial cutoff date. Always send with the value 2020-01-01T00:01:01. (ISO 8601) |
lastUpdateSince | date | Yes | Returns data updated as of a given date. Ex: 2025-07-13T23:59:00. (ISO 8601) |
lastUpdateUntil | date | Yes | Returns data updated up to a given date. Ex: 2025-07-14T18:32:59. (ISO 8601) |
status | int | Yes | Initial status of paid orders: 2 |
Paid vs. Unpaid Orders
By default, status 2 (PendingCreate) represents paid orders.
You can configure the system to display newly created unpaid orders. Contact our team.
Explanation of a List of Orders return
This GET will return a list of Orders of an Seller.
root
root| Field | Type | Description |
|---|---|---|
id | Guid | Unique order identifier. |
createDate | datetime | Order creation date (ISO 8601 format). |
lastUpdate | datetime | Order last update (ISO 8601 format). |
externalId | string | External order ID (marketplace/ERP). |
sellerOrderId | string | Order ID in the seller's system. |
channel | string | Order origin channel (e.g., ecommerce). |
status | int | Current order status (e.g., 9 = Completed). |
orderNote | string | Note added to the order. |
plp | string | PLP number or logistics identification. |
isDelivery | boolean | Indicates whether the order is for delivery. |
dealerCode | string | A root field that shows the code of a Dealer who sell this order. |
voucher
voucher| Campo | Tipo | Descrição |
|---|---|---|
code | string | Código do cupom aplicado. |
items[]
items[]| Field | Type | Description |
|---|---|---|
code | string | Registered main code (ERP). |
barcode | string | Barcode (GTIN / EAN). |
quantity | int | Quantity requested. |
unitPrice | number | Unit price of the SKU (without discount). |
totalAmount | number | Total value of the SKU (with discounts applied). |
discountPrice | number | Total discount value applied (not unit). |
price | number | Total original value without discount. |
subTotalAmount | number | Total gross value of the item (before discounts). |
isGift | boolean | Indicates whether the item is a gift. |
giftMessage | string | Gift message (if applicable). |
itemNote | string | Note about the item. |
buyer
buyer| Field | Type | Description |
|---|---|---|
documentType | int | Document type: 1 = CPF, 2 = CNPJ. |
cpf | string | Customer's CPF (if an individual). |
cnpj | string | Customer's CNPJ (if a legal entity). |
companyName | string | Corporate name (if a legal entity). |
fullName | string | Customer's full name. |
email | string | Customer's email address. |
phoneNumber | string | Customer's phone number. |
address | object | Billing address. |
deliveryAddress
deliveryAddress| Field | Type | Description |
|---|---|---|
street | string | Street |
number | string | Number |
complement | string | Complement |
neighborhood | string | Neighborhood |
cep | string | Postal Code |
city | string | City |
state | string | State |
fullAddress | string | Full formatted address |
dealer
dealer| Field | Type | Description |
|---|---|---|
dealerCode | string | Vendor or store code. |
fullName | string | Vendor name. |
salesmanCpf | string | Vendor's CPF. |
storeCnpj | string | Store's CNPJ. |
companyName | string | Company or store name. |
freight
freight| Field | Type | Description |
|---|---|---|
reference | string | Carrier name or code. |
deliveryTime | int | Delivery time (in days). |
estimateDate | string (ISO) | Estimated delivery date. |
amount | number | Shipping cost. |
paymentList
paymentList| Field | Type | Description |
|---|---|---|
nsu | string | Unique sequential number of the transaction. |
acquirerApprovalCode | string | Acquirer approval code. |
quantityInstallments | int | Number of installments. |
amount | number | Total payment amount. |
paymentMethod.brand | string | Card brand. |
paymentMethod.type | int | Method type: 1 = Credit, 3 = Boleto, 6 = Pix. |
paymentStatus | int | Status: 0 = Unpaid, 5 = Pre-approved, 6 = Paid. |
invoice
invoice| Field | Type | Description |
|---|---|---|
invoice.key | string | Electronic invoice access code. |
invoice.number | string | Invoice number. |
invoice.xmlUrl | string | XML invoice URL. |
invoice.fileUrl | string | PDF invoice URL. |
tracking
tracking| Field | Type | Description |
|---|---|---|
tracking.trackingCode | string | Tracking code. |
tracking.trackingLink | string | Order tracking link. |
tracking.carrierName | string | Carrier name. |
pickingInfo
pickingInfoPicking feature need be able in Retailer Configurations.
Without picking feature able, this field will be 1 by default.
| Field | Type | Description |
|---|---|---|
pickingInfo.packagesQuantity | int | Quantity of associated volumes/NF-e. |
pickingInfo.packages[]
pickingInfo.packages[]Packages feature need be able in Retailer Configurations.
| Field | Type | Description |
|---|---|---|
id | Guid | Package identifier. |
name | string | Package name/description. |
weightInKg | number | Package weight in kg. |
heightInCm | number | Height in centimeters. |
widthInCm | number | Width in centimeters. |
lengthInCm | number | Length in centimeters. |
isFragile | boolean | Indicates whether the package is fragile. |
isRequiredSignature | boolean | Requires signature upon receipt. |
items[].code | string | Code of the item contained in the package. |
items[].quantity | int | Quantity of items in the package. |
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
}
]