--- name: orders-api description: "Orders API skill. Use when working with Orders for api. Covers 36 endpoints." version: 1.0.0 generator: lapsh --- # Orders API API version: 1.0 ## Auth ApiKey X-VTEX-API-AppKey in header | ApiKey X-VTEX-API-AppToken in header | ApiKey VtexIdclientAutCookie in header ## Base URL https://apiexamples.vtexcommercestable.com.br ## Setup 1. Set your API key in the appropriate header 2. GET /api/oms/pvt/orders -- verify access 3. POST /api/oms/pvt/orders/{orderId}/start-handling -- create first start-handling ## Endpoints 36 endpoints across 1 groups. See references/api-spec.lap for full details. ### api | Method | Path | Description | |--------|------|-------------| | GET | /api/oms/pvt/orders/{orderId} | Get order | | GET | /api/oms/pvt/orders/order-group/{orderGroup} | Get orders by order group ID | | GET | /api/oms/pvt/orders | List orders | | POST | /api/oms/pvt/orders/{orderId}/start-handling | Start handling order | | POST | /api/oms/pvt/orders/{orderId}/cancel | Cancel order | | POST | /api/oms/pvt/orders/{orderId}/changes | Register modifications on order | | POST | /api/oms/pvt/orders/{orderId}/interactions | Add log in orders | | POST | /api/oms/pvt/orders/{orderId}/invoice | Order invoice notification | | PATCH | /api/oms/pvt/orders/{orderId}/invoice/{invoiceNumber} | Update order's partial invoice (send tracking number) | | PUT | /api/oms/pvt/orders/{orderId}/invoice/{invoiceNumber}/tracking | Update order tracking status | | GET | /api/oms/pvt/orders/{orderId}/conversation-message | Retrieve order conversation | | GET | /api/oms/pvt/orders/{orderId}/payment-transaction | Retrieve payment transaction | | POST | /api/oms/pvt/orders/{orderId}/payments/{paymentId}/payment-notification | Send payment notification | | GET | /api/oms/pvt/feed/orders/status | Get feed order status | | GET | /api/orders/feed/config | Get feed configuration | | POST | /api/orders/feed/config | Create or update feed configuration | | DELETE | /api/orders/feed/config | Delete feed configuration | | GET | /api/orders/feed | Retrieve feed items | | POST | /api/orders/feed | Commit feed items | | GET | /api/orders/hook/config | Get hook configuration | | POST | /api/orders/hook/config | Create or update hook configuration | | DELETE | /api/orders/hook/config | Delete hook configuration | | GET | /api/orders/pvt/document/{orderId}/change-summary | Get order modifications summary | | GET | /api/oms/user/orders | Retrieve user's orders | | GET | /api/oms/user/orders/{orderId} | Retrieve user order details | | POST | /api/orders/expressions/jsonata | Test JSONata expression | | GET | /api/checkout/pvt/configuration/window-to-change-seller | Get window to change seller | | POST | /api/checkout/pvt/configuration/window-to-change-seller | Update window to change seller | | PATCH | /api/order-system/orders/{changeOrderId}/changes | Create order modifications | | GET | /api/order-system/orders/{changeOrderId}/changes | Get order modifications history | | GET | /api/order-system/orders/{changeOrderId}/changes/{changeRequestId} | Get order modifications details | | POST | /api/order-system/orders/{changeOrderId}/changes/preview | Preview order modifications | | POST | /api/order-system/orders/{changeOrderId}/changes/{changeRequestId}/retry | Retry order modifications | | POST | /api/order-system/orders/{changeOrderId}/changes/{changeRequestId}/cancel | Cancel order modifications | | PUT | /api/order-system/orders/changes/settings | Update Order modifications settings | | GET | /api/order-system/orders/changes/settings | Get Order modifications settings | ## Common Questions Match user requests to endpoints in references/api-spec.lap. Key patterns: - "Get order details?" -> GET /api/oms/pvt/orders/{orderId} - "Get order-group details?" -> GET /api/oms/pvt/orders/order-group/{orderGroup} - "Search orders?" -> GET /api/oms/pvt/orders - "Create a start-handling?" -> POST /api/oms/pvt/orders/{orderId}/start-handling - "Create a cancel?" -> POST /api/oms/pvt/orders/{orderId}/cancel - "Create a change?" -> POST /api/oms/pvt/orders/{orderId}/changes - "Create a interaction?" -> POST /api/oms/pvt/orders/{orderId}/interactions - "Create a invoice?" -> POST /api/oms/pvt/orders/{orderId}/invoice - "Partially update a invoice?" -> PATCH /api/oms/pvt/orders/{orderId}/invoice/{invoiceNumber} - "List all conversation-message?" -> GET /api/oms/pvt/orders/{orderId}/conversation-message - "List all payment-transaction?" -> GET /api/oms/pvt/orders/{orderId}/payment-transaction - "Create a payment-notification?" -> POST /api/oms/pvt/orders/{orderId}/payments/{paymentId}/payment-notification - "List all status?" -> GET /api/oms/pvt/feed/orders/status - "List all config?" -> GET /api/orders/feed/config - "Create a config?" -> POST /api/orders/feed/config - "List all feed?" -> GET /api/orders/feed - "Create a feed?" -> POST /api/orders/feed - "List all config?" -> GET /api/orders/hook/config - "Create a config?" -> POST /api/orders/hook/config - "List all change-summary?" -> GET /api/orders/pvt/document/{orderId}/change-summary - "List all orders?" -> GET /api/oms/user/orders - "Get order details?" -> GET /api/oms/user/orders/{orderId} - "Create a jsonata?" -> POST /api/orders/expressions/jsonata - "List all window-to-change-seller?" -> GET /api/checkout/pvt/configuration/window-to-change-seller - "Create a window-to-change-seller?" -> POST /api/checkout/pvt/configuration/window-to-change-seller - "List all changes?" -> GET /api/order-system/orders/{changeOrderId}/changes - "Get change details?" -> GET /api/order-system/orders/{changeOrderId}/changes/{changeRequestId} - "Create a preview?" -> POST /api/order-system/orders/{changeOrderId}/changes/preview - "Create a retry?" -> POST /api/order-system/orders/{changeOrderId}/changes/{changeRequestId}/retry - "Create a cancel?" -> POST /api/order-system/orders/{changeOrderId}/changes/{changeRequestId}/cancel - "List all settings?" -> GET /api/order-system/orders/changes/settings - "How to authenticate?" -> See Auth section ## Response Tips - Check response schemas in references/api-spec.lap for field details - List endpoints may support pagination; check for limit, offset, or cursor params - Create/update endpoints typically return the created/updated object ## CLI ```bash # Update this spec to the latest version npx @lap-platform/lapsh get orders-api -o references/api-spec.lap # Search for related APIs npx @lap-platform/lapsh search orders-api ``` ## References - Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas > Generated from the official API spec by [LAP](https://lap.sh)