VTEX

Order items

GET
/v1/vtex/orders/items

Retrieve VTEX order line items with SKU, pricing, brand, and commission data.

Authorization

ClientIdAuthClientSecretAuth
headerx-client-id<token>

Client ID

headerx-client-secret<token>

Client secret

Query Parameters

organizationId*string

Organization identifier (required)

userId?string

User identifier

integrationName?string

VTEX integration name

orderId?string

Filter by VTEX order id

dateStart?string

Filter rows with inserted_at on or after this date (YYYY-MM-DD)

Formatdate
dateEnd?string

Filter rows with inserted_at on or before this date (YYYY-MM-DD)

Formatdate
page?integer

Page number (default 1)

Default1
limit?integer

Items per page (default 500, max 5000)

Rangevalue <= 5000
Default500

Response Body

VTEX order items response

application/json
  1. response
data?array<>
meta?
curl -X GET "https://example.com/v1/vtex/orders/items?organizationId=org_123"
{  "data": [    {      "order_id": "string",      "unique_id": "string",      "id": "string",      "product_id": "string",      "ean": "string",      "quantity": 0,      "seller": "string",      "name": "string",      "price": 0,      "selling_price": 0,      "brand_name": "string",      "brand_id": "string",      "measurement_unit": "string",      "unit_multiplier": 0,      "image_url": "string",      "detail_url": "string",      "commission": 0,      "tax": 0,      "cost_price": 0,      "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"    }  ],  "meta": {    "page": 0,    "limit": 0,    "hasNextPage": true,    "hasPreviousPage": true  }}