VTEX Pick and Pack is a solution to streamline stores’ fulfillment processes by optimizing orders’ picking and packing, and the last-mile delivery. The solution is composed of the VTEX Fulfillment and the Last Mile modules.

This documentation explains how to make a request to the Get order status and information REST API to retrieve the status and details of an order in the VTEX Pick and Pack context. If you use this API to retrieve orders from other contexts, you will receive 404 error messages.

The order statuses in VTEX Pick and Pack do not correspond to the order flow and status of the Order Management System (OMS).

Before making the request, you will need the following:

• Basic authentication
• JSON Web Token (JWT)

Basic Authentication is a method for an HTTP user agent to provide a username and password when making a request. The system doesn't store API keys, they need to be generated every time there's a new request.

Below, you will find an Api-Key for the Development environment that you can use. To find the Api-Key of the environment in Production, Admin users can generate an API Key in the users section of their Pick and Pack settings.

Production (Prod)

JSON Web Token (JWT) is an open standard (RFC 7519) that defines a compact and self-contained way for securely transmitting information as a JSON object between parties.

In order to authorize the API request, you will have to generate a JWT. For that, you will use the Api-Key from the previous section.

The first step is to create a token of authentication with the endpoint below. No authentication is required:

Endpoint

Request body example

Response body example

Status codes

Headers

After you have created the token of authentication, make the request to the endpoint once again, this time sending in the headers the following object:

In order to get the VTEX Pick and Pack status and details of a given order, use the endpoint below:

The orderId is the order's unique code and is the same used in OMS and all VTEX modules.

Use the authorization retrieved from the steps listed in Before you begin and insert it in the call's header.

You will need to create a webhook to receive the response of the request, used for receiving notifications for invoicing purposes, for example.

Your webhook may have your desired setting for URL, path, method, and authentication, it is flexible.

The order’s information and status change notifications received will be an object like the following example:

Example

In the table below, you will find the possible order statuses in the VTEX Pick and Pack context:

The statuses above are related to VTEX Pick and Pack only, and do not correspond to the order flow and status of the Order Management System (OMS).