vtex.local

Endpoints that deal with order management. New version of the orders API.

🔑 apikey 6 endpoints
📄 Docs 📋 OpenAPI spec 🔬 Try in Swagger UI

SDKs by language (10 total)

lever-sdk ✓ Official
npm install lever-sdk
ads-js ✓ Official
npm install ads-js
npm install vtex-node-sdk
physical-payments-sdk ✓ Official
# Maven: see https://github.com/vtex-apps/physical-payments-sdk
dotnet add package VTEX-SDK-dotnet
composer require vtex-sdk
composer require vtex-sdk-php
composer require vtex-api
# See https://github.com/ksetoue/vtex-kotlin-sdk
vtex.js ✓ Official
# See https://github.com/vtex/vtex.js
curl examples
Get order
curl \
  -H "VtexIdclientAutCookie: $API_KEY" \
  https://vtex.local/api/orders/pvt/document/{orderId}
Endpoints (6 total)
GET
/api/orders/pvt/document/{orderId}
Get order
POST
/api/orders/extendsearch/orders
List orders
POST
/api/orders/pvt/document/{orderId}/cancel
Cancel order
POST
/api/orders/pvt/document/{orderId}/invoices
Order invoice notification
POST
/api/orders/pvt/document/{orderId}/actions/start-handling
Start handling order
POST
/api/orders/pvt/document/{orderId}/payment/{paymentId}/notify-payment
Send payment notification
At a glance
Total SDKs10
Languages6
Endpoints6
Authapikey
https://vtex.local