Orders
One row per B2B order: number, customer, status, billing status, total, freight, payment terms and items. Field names follow the Mercos API (Portuguese).
dateFrom and dateTo filter by data_emissao (inclusive days, YYYY-MM-DD).
Rows are sorted by id, integration_id, inserted_at and paginated with page/limit; meta.hasNextPage says whether another page exists.
Responses are cached for 30 minutes.
ClientIdAuthClientSecretAuthx-client-id<token>Client ID
x-client-secret<token>Client secret
organizationId*stringOrganization that owns the connected accounts.
uuidintegrationId?stringOne connected account of this integration (integration_id of the rows). Omit it to read every account of the organization.
length <= 255dateFrom?stringFirst day (inclusive) of data_emissao, YYYY-MM-DD.
datedateTo?stringLast day (inclusive) of data_emissao, YYYY-MM-DD. Must not be before dateFrom.
datepage?integerPage number, starting at 1.
1 <= value <= 10000001limit?integerRows per page (max 5000).
1 <= value <= 5000500One page of rows
application/json- response
data*array<>meta*curl -X GET "https://example.com/v1/mercos/orders?organizationId=3f2b8c1e-5d4a-4e6f-9a7b-1c2d3e4f5a6b&dateFrom=2026-10-01&dateTo=2026-10-31"{ "data": [ { "organization_id": "3f2b8c1e-5d4a-4e6f-9a7b-1c2d3e4f5a6b", "integration_id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d", "user_id": "123456", "document_id": "123456", "integration_name": "example", "id": "123456", "numero": "1250", "cliente_id": "123456", "status": "example", "status_faturamento": "example", "status_custom_id": "123456", "status_b2b": "1250", "total": "125.50", "valor_frete": "125.50", "condicao_pagamento": "example", "forma_pagamento_id": "123456", "tipo_pedido_id": "123456", "criador_id": "123456", "representada_id": "123456", "pedido_origem_id": "123456", "items": "example", "data_emissao": "2026-10-01T12:00:00.000Z", "data_criacao": "2026-10-01T12:00:00.000Z", "ultima_alteracao": "2026-10-01T12:00:00.000Z", "inserted_at": "2026-10-01T12:00:00.000Z" } ], "meta": { "page": 1, "limit": 500, "hasNextPage": false, "hasPreviousPage": false }}