vtex.local

>Check the new Orders onboarding guide. We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Orders and is organized by focusing on the developer'

🔑 apikey 28 endpoints

📄 Docs 📋 OpenAPI spec 🔬 Try in Swagger UI

SDKs by language (10 total)

lever-sdk ✓ Official

npm install lever-sdk

GitHub integration →

ads-js ✓ Official

npm install ads-js

GitHub integration →

vtex-node-sdk

npm install vtex-node-sdk

GitHub integration →

physical-payments-sdk ✓ Official

# Maven: see https://github.com/vtex-apps/physical-payments-sdk

GitHub integration →

VTEX-SDK-dotnet

dotnet add package VTEX-SDK-dotnet

GitHub integration →

vtex-sdk

composer require vtex-sdk

GitHub integration →

vtex-sdk-php

composer require vtex-sdk-php

GitHub integration →

vtex-api

composer require vtex-api

GitHub integration →

vtex-kotlin-sdk

# See https://github.com/ksetoue/vtex-kotlin-sdk

GitHub integration →

vtex.js ✓ Official

# See https://github.com/vtex/vtex.js

GitHub integration →

curl examples

Retrieve feed items

curl \
  -H "X-VTEX-API-AppKey: $API_KEY" \
  https://vtex.local/api/orders/feed

List orders

curl \
  -H "X-VTEX-API-AppKey: $API_KEY" \
  https://vtex.local/api/oms/pvt/orders

Retrieve user's orders

curl \
  -H "X-VTEX-API-AppKey: $API_KEY" \
  https://vtex.local/api/oms/user/orders

Endpoints (28 total)

GET

/api/orders/feed

Retrieve feed items

GET

/api/oms/pvt/orders

List orders

GET

/api/oms/user/orders

Retrieve user's orders

GET

/api/orders/feed/config

Get feed configuration

GET

/api/orders/hook/config

Get hook configuration

GET

/api/oms/pvt/orders/{orderId}

Get order

GET

/api/oms/user/orders/{orderId}

Retrieve user order details

GET

/api/oms/pvt/feed/orders/status

Get feed order status

GET

/api/oms/pvt/admin/reports/completed

Export order report with status 'Completed'

GET

/api/oms/pvt/admin/reports/inprogress

Export order report with status 'In Progress'

GET

/api/oms/pvt/orders/{orderId}/payment-transaction

Retrieve payment transaction

GET

/api/oms/pvt/orders/{orderId}/conversation-message

Retrieve order conversation