Orders API - PII data architecture
VTEX stores using the PII data architecture from Data Protection Plus must use this adapted version of the Orders API. Learn more about the modified behavior at Changes in VTEX features behavior to handle PII data.
The Orders API - PII data architecture is only compatible with stores using the PII data architecture from Data Protection Plus, which is in closed beta phase, only available in selected regions.
This feature is part of VTEX Shield. If you are already a VTEX customer and want to adopt VTEX Shield for your business, please contact Commercial Support. Additional fees may apply. If you are not yet a customer but are interested in this solution, please complete our contact form.
Endpoints
Orders
| Summary | Method | Path |
|---|---|---|
| Get order | GET | /api/orders/pvt/document/{orderId} |
| List orders | POST | /api/orders/extendsearch/orders |
| Start handling order | POST | /api/orders/pvt/document/{orderId}/actions/start-handling |
| Cancel order | POST | /api/orders/pvt/document/{orderId}/cancel |
Invoice
| Summary | Method | Path |
|---|---|---|
| Order invoice notification | POST | /api/orders/pvt/document/{orderId}/invoices |
Payment
| Summary | Method | Path |
|---|---|---|
| Send payment notification | POST | /api/orders/pvt/document/{orderId}/payment/{paymentId}/notify-payment |