Orders API (PII version)
Endpoints that deal with order management. New version of the orders API.
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Endpoints that deal with order management. New version of the orders API.
Endpoints 6
Orders
- POSTList orders
/api/orders/extendsearch/orders?f_hasInputInvoice=falseRetrieves a list of orders according to the filters described below. > This endpoint returns masked order data. > This should not be used for integrations.… - GETGet order
/api/orders/pvt/document/:orderId?reason=data-validationRetrieves order details by searching a specific order ID. >If you wish to retrieve unmasked data, use the reason parameter. > The View order resource is… - POSTStart handling order
/api/orders/pvt/document/:orderId/actions/start-handlingChange the status of an order to indicate that is is in handling. > Expect a status 204 response with no content in case of a successful request. > The Change… - POSTCancel order
/api/orders/pvt/document/:orderId/cancelYou should use this endpoint to cancel an order by its orderId. A common scenario is one where the seller has a problem with the order fulfillment and needs…
Invoice
- POSTOrder invoice notification
/api/orders/pvt/document/:orderId/invoicesOnce the order is invoiced, the seller should use this request to send the invoice information to the marketplace. We strongly recommend that you always send…
Payment
- POSTSend payment notification
/api/orders/pvt/document/:orderId/payment/:paymentId/notify-paymentSend a payment notification of a given order, by order ID and payment ID. > The Notify payment resource is needed to use this API request. This is included in…
API details
- Base URL
https://vtex.localhttps://{accountName}.{environment}.com.br- Authentication
- An API key in the VtexIdclientAutCookie header
An API key in the X-VTEX-API-AppKey header
An API key in the X-VTEX-API-AppToken header - Operations
- 6 operations on 6 pathsPOST 5GET 1
- Main resources
- Orders 4Invoice 1Payment 1
- Response formats
application/jsonapplication/json; charset=utf-8- Description format
- OpenAPI 3.0.0, API version
1.0 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Orders API (PII version) in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Orders API (PII version) collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the VtexIdclientAutCookie header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “List orders” (POST /api/orders/extendsearch/orders?f_hasInputInvoice=false), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Orders API (PII version)?
Endpoints that deal with order management. New version of the orders API. It is listed under Other and has 6 endpoints.
Who publishes the Orders API (PII version)?
It is listed from VTEX's public API description (an OpenAPI document), not published by VTEX on Swastik Codes. Anyone who controls vtex.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Orders API (PII version)?
Its description lists 2 base URLs: https://vtex.local, https://{accountName}.{environment}.com.br. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the Orders API (PII version)?
It accepts 3 methods: an API key in the VtexIdclientAutCookie header; an API key in the X-VTEX-API-AppKey header; an API key in the X-VTEX-API-AppToken header.
How many endpoints does the Orders API (PII version) have?
6 operations on 6 paths (5 POST, 1 GET). The largest groups are Orders, Invoice, Payment.
Is forking the Orders API (PII version) free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.