Nuvemshop
Orders
GET
One row per order: status, payment and shipping status, totals, discounts, coupons, promotions, shipping and UTM attribution.
dateFrom and dateTo filter by created_at (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.
ClientIdAuthClientSecretAuthheader
x-client-id<token>Client ID
header
x-client-secret<token>Client secret
organizationId*stringOrganization that owns the connected accounts.
Format
uuidintegrationId?stringOne connected account of this integration (integration_id of the rows). Omit it to read every account of the organization.
Length
length <= 255dateFrom?stringFirst day (inclusive) of created_at, YYYY-MM-DD.
Format
datedateTo?stringLast day (inclusive) of created_at, YYYY-MM-DD. Must not be before dateFrom.
Format
datepage?integerPage number, starting at 1.
Range
1 <= value <= 1000000Default
1limit?integerRows per page (max 5000).
Range
1 <= value <= 5000Default
500One page of rows
application/json- response
data*array<>meta*curl -X GET "https://example.com/v1/nuvemshop/orders?organizationId=3f2b8c1e-5d4a-4e6f-9a7b-1c2d3e4f5a6b&dateFrom=2026-10-01&dateTo=2026-10-31"{ "data": [ { "id": "123456", "number": "example", "status": "example", "payment_status": "example", "shipping_status": "example", "cancel_reason": "example", "created_at": "2026-10-01T12:00:00.000Z", "updated_at": "2026-10-01T12:00:00.000Z", "paid_at": "2026-10-01T12:00:00.000Z", "closed_at": "2026-10-01T12:00:00.000Z", "cancelled_at": "2026-10-01T12:00:00.000Z", "completed_at": "2026-10-01T12:00:00.000Z", "shipped_at": "2026-10-01T12:00:00.000Z", "currency": "example", "language": "example", "gateway": "example", "gateway_name": "example", "payment_count": 10, "subtotal": "125.50", "discount": "125.50", "discount_coupon": "125.50", "discount_gateway": "125.50", "promotional_discount_total": "125.50", "total": "125.50", "total_usd": "125.50", "total_paid": "125.50", "shipping_cost_customer": "125.50", "shipping_cost_owner": "125.50", "shipping_option": "example", "shipping_option_code": "example", "shipping_carrier_name": "example", "shipping_min_days": 10, "shipping_max_days": 10, "has_shippable_products": true, "weight": "125.50", "coupon_codes": "example", "coupon_ids": "example", "promotions_applied": "example", "item_count": 10, "quantity_total": "125.50", "customer_id": "123456", "contact_email": "name@example.com", "region": "example", "storefront": "example", "order_origin": "example", "app_id": "123456", "is_subscription": true, "initiated_by": "example", "landing_host": "example", "utm_source": "example", "utm_medium": "example", "utm_campaign": "example", "utm_term": "example", "utm_content": "example", "store_key": "example", "store_domain": "example", "integration_id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d", "organization_id": "3f2b8c1e-5d4a-4e6f-9a7b-1c2d3e4f5a6b", "organization_id_legacy": "example", "user_id": "123456", "document_id": "123456", "inserted_at": "2026-10-01T12:00:00.000Z", "integration_name": "example" } ], "meta": { "page": 1, "limit": 500, "hasNextPage": false, "hasPreviousPage": false }}