Get Orders of All Seller Resumed

GET https://{environment}.neomode.com.br/cp/management/commerce/orders/?{since}&{until}&{status}&{sortAscending}&{sortField}

Retrieves a summarized list of orders with pagination and multiple filters such as date range, status, channel, and payment type.

Request

Query Parameters

Parameter	Type	Example	Description
since	string (ISO 8601)	2020-01-01T00:01:01	Defines the start datetime for filtering results. Usually used to retrieve records created after this timestamp.
until	string (ISO 8601)	2024-12-27T23:59:00Z	Defines the end datetime for filtering results. Limits the data returned up to this point in time.
lastUpdateSince	string (ISO 8601)	2025-07-01T23:59:00	Filters records updated after the specified datetime.
lastUpdateUntil	string (ISO 8601)	2025-07-14T18:32:59	Filters records updated until the specified datetime.
page	integer	1	Specifies the current page number in the paginated result set.
perPage	integer	10	Sets the maximum number of records to be returned per page.
sortAscending	boolean	false	Defines the sorting order of results. true = ascending, false = descending.
sortField	string	lastUpdate	Field used to sort the result set.
useCanonicalStatus	boolean	true	(Optional) When true, applies internal canonical status mapping before returning results.
status	string	PendingCreate	Filters results by specific status (comma-separated list supported).
channel	string	ã ç_%	Identifies or filters by the source channel. Supports special characters and wildcards (%).
paymentType	string (list)	Voucher	Filters results by payment methods, separated by commas. Examples: Voucher, CreditCard, Pix, Bankslip

Status summary: 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.

Response

❗️

Notice: The provided order object is incomplete. Retrieve full order details if needed.

Root Object

Field	Type	Description
page	integer	Current page number.
perPage	integer	Number of records per page.
maxCount	integer	Total number of matching records.
maxPage	integer	Total number of pages.
orders	array	List of order summaries.

Order Object

Field	Type	Description
id	string (UUID)	Unique internal order ID.
externalId	string	External order ID (e.g., from ERP or eCommerce).
sellerOrderId	string	Order ID in seller system.
friendlyCode	string	Friendly order code (if available).
createDate	string (ISO8601)	Date/time when the order was created.
status	string	Internal order status (e.g., CreatedInternal, PendingCreate).
canonicalStatus	string	Unified status across systems.
isDelivery	boolean	Whether the order requires delivery.
salePointName	string	Sales point or store name.
subTotalAmount	number	Order subtotal amount.
totalAmount	number	Order total amount (including freight).
fullName	string	Buyer’s full name.
cpfBuyer	string	Buyer’s CPF (Brazilian taxpayer ID).
cnpjBuyer	string	Buyer’s CNPJ (if corporate order).
documentType	integer	Document type (1 = CPF, 2 = CNPJ).
lastUpdate	string (ISO8601)	Last modification timestamp.
quantity	integer	Total number of items in the order.
channel	string	Origin channel (e.g., ecommerce, store).
paymentInfo	object	Main payment data.
paymentList	array	List of all payments associated to the order.
freight	object	Freight/shipping details.
seller	object	Seller (store or franchise) information.
invoice	object	Invoice metadata (if issued).
items	array	List of ordered items.

Item Object

Field	Type	Description
quantity	integer	Quantity of the item.
unitPrice	number	Unit price.
discountPrice	number	Discount amount.
totalAmount	number	Total amount for this item.
sku	object	SKU information (code, name, product data).

Freight Object

Field	Type	Description
reference	string	Freight name (e.g., “Sedex - Correios”).
description	string	Freight description.
amount	number	Freight amount.
deliveryTime	integer	Estimated delivery time.

Seller Object

Field	Type	Description
pointSaleId	string	Store or sales point ID.
cnpj	string	Seller’s CNPJ.
email	string	Seller’s contact email.
fullName	string	Seller’s display name.
address	object	Seller address (street, number, city, state, etc.).

Payment Object

Field	Type	Description
amount	number	Payment amount.
quantityInstallments	integer	Number of installments.
acquirerMessage	string	Message or response from acquirer.
paymentMethod	object	Payment method details.
isCaptured	boolean	Whether the payment was captured.
isRefunded	boolean	Whether the payment was refunded.
isAuthorized	boolean	Whether the payment was authorized.

Payment Method Object:

Field	Type	Description
info	string	Payment method name (e.g., “Credit Card”).
brand	string	Card brand (e.g., Visa, Mastercard).
type	integer	Internal payment type code.
modality	integer	Payment modality code.