Orders API Skill
vtex-local-orders-api
vtex-local-orders-api
| Method | Path | Description |
|---|---|---|
GET | /api/oms/pvt/orders/{orderId} | |
GET | /api/oms/pvt/orders/order-group/{orderGroup} | Get order |
GET | /api/oms/pvt/orders | Get orders by order group ID |
POST | /api/oms/pvt/orders/{orderId}/start-handling | List orders |
POST | /api/oms/pvt/orders/{orderId}/cancel | Start handling order |
POST | /api/oms/pvt/orders/{orderId}/changes | Cancel order |
POST | /api/oms/pvt/orders/{orderId}/interactions | Register modifications on order |
POST | /api/oms/pvt/orders/{orderId}/invoice | Add log in orders |
PATCH | /api/oms/pvt/orders/{orderId}/invoice/{invoiceNumber} | Order invoice notification |
PUT | /api/oms/pvt/orders/{orderId}/invoice/{invoiceNumber}/tracking | Update order's partial invoice (send tracking number) |
GET | /api/oms/pvt/orders/{orderId}/conversation-message | Update order tracking status |
GET | /api/oms/pvt/orders/{orderId}/payment-transaction | Retrieve order conversation |
POST | /api/oms/pvt/orders/{orderId}/payments/{paymentId}/payment-notification | Retrieve payment transaction |
GET | /api/oms/pvt/feed/orders/status | Send payment notification |
GET | /api/orders/feed/config | Get feed order status |
POST | /api/orders/feed/config | Get feed configuration |
DELETE | /api/orders/feed/config | Create or update feed configuration |
GET | /api/orders/feed | Delete feed configuration |
POST | /api/orders/feed | Retrieve feed items |
GET | /api/orders/hook/config | Commit feed items |
POST | /api/orders/hook/config | Get hook configuration |
DELETE | /api/orders/hook/config | Create or update hook configuration |
GET | /api/orders/pvt/document/{orderId}/change-summary | Delete hook configuration |
GET | /api/oms/user/orders | Get order modifications summary |
GET | /api/oms/user/orders/{orderId} | Retrieve user's orders |
POST | /api/orders/expressions/jsonata | Retrieve user order details |
GET | /api/checkout/pvt/configuration/window-to-change-seller | Test JSONata expression |
POST | /api/checkout/pvt/configuration/window-to-change-seller | Get window to change seller |
PATCH | /api/order-system/orders/{changeOrderId}/changes | Update window to change seller |
GET | /api/order-system/orders/{changeOrderId}/changes | Create order modifications |
Use this API as a Claude Code skill for instant agent access.
lapsh skill-install vtex-local-orders-api
Downloads and installs to ~/.claude/skills/vtex-local-orders-api/
1.0 (2026-06-27)