VTEX
Orders
GET
Retrieve VTEX sales orders with status, totals breakdown, payment, shipping, and marketing attribution (UTMs, coupon).
ClientIdAuthClientSecretAuthheader
x-client-id<token>Client ID
header
x-client-secret<token>Client secret
organizationId*stringOrganization identifier (required)
userId?stringUser identifier
integrationName?stringVTEX integration name
orderId?stringFilter by VTEX order id
status?stringFilter by VTEX order status (e.g. invoiced, canceled)
dateStart?stringFilter orders with creation_date on or after this date (YYYY-MM-DD)
Format
datedateEnd?stringFilter orders with creation_date on or before this date (YYYY-MM-DD)
Format
datepage?integerPage number (default 1)
Default
1limit?integerItems per page (default 500, max 5000)
Range
value <= 5000Default
500VTEX orders response
application/json- response
data?array<>meta?curl -X GET "https://example.com/v1/vtex/orders?organizationId=org_123"{ "data": [ { "order_id": "string", "sequence": "string", "seller_order_id": "string", "origin": "string", "affiliate_id": "string", "sales_channel": "string", "merchant_name": "string", "status": "string", "status_description": "string", "value": 0, "creation_date": "2019-08-24T14:15:22Z", "last_change": "2019-08-24T14:15:22Z", "order_group": "string", "follow_up_email": "string", "last_message": "string", "is_completed": true, "order_form_id": "string", "authorized_date": "2019-08-24T14:15:22Z", "invoiced_date": "2019-08-24T14:15:22Z", "cancel_reason": "string", "tracking_id": "string", "courier_name": "string", "tracking_url": "string", "tracking_labels": "string", "utm_source": "string", "utm_medium": "string", "utm_campaign": "string", "utmi_campaign": "string", "coupon_code": "string", "marketing_tags": "string", "total_items_value": 0, "total_discounts": 0, "total_shipping": 0, "total_tax": 0, "payment_method": "string", "payment_method_group": "string", "installments": 0, "shipping_city": "string", "shipping_state": "string", "shipping_country": "string", "shipping_postal_code": "string", "integration_id": "string", "organization_id": "string", "organization_id_legacy": "string", "user_id": "string", "document_id": "string", "inserted_at": "2019-08-24T14:15:22Z", "integration_name": "string", "net_revenue": 0, "retained_cogs": 0, "margin": 0, "margin_nd_reason": "incomplete_gross_value", "cost_coverage_ratio": 0 } ], "meta": { "page": 0, "limit": 0, "hasNextPage": true, "hasPreviousPage": true }}