VTEX Shipping Network API
VTEX Shipping Network is a solution that connects carriers and merchants for deliveries at better freight costs and smarter logistics operations.
VTEX Shipping Network is available exclusively in Brazil.
The tracking process has two main parts:
- Notification: The carrier is notified that a package is being dispatched.
- Tracking: The package being delivered by the carrier is tracked from the start of its journey to its final destination.
To integrate with the VTEX Shipping Network hub, carriers must develop VTEX IO apps and associate them with specific endpoints. Once integrated with the hub, these carrier apps will be connected to other VTEX systems, ensuring seamless execution of the necessary steps for the tracking process.
For detailed instructions, see the VTEX Shipping Network integration guide.
VTEX Shipping Network API Index
Notification
Tracking
Common parameters
| Parameter name | Description | Type |
|---|---|---|
{{accountName}} |
Name of the VTEX account. Used as part of the URL. | Server variable. |
{{environment}} |
Environment to use. Used as part of the URL. The default value is vtexcommercestable. |
Server variable. |
X-VTEX-API-AppKey |
Unique identifier of the API key. | Authentication header. Must be used together with X-VTEX-API-AppToken. Not necessary when using VtexIdclientAutCookie. |
X-VTEX-API-AppToken |
Secret token of the API key. | Authentication header. Must be used together with X-VTEX-API-AppKey. Not necessary when using VtexIdclientAutCookie. |
VtexIdclientAutCookie |
User token, valid for 24 hours. | Authentication header. Not necessary when using X-VTEX-API-AppKey and X-VTEX-API-AppToken. |
Endpoints
Notification
| Summary | Method | Path |
|---|---|---|
| Notify carrier with app | POST | /{app_name}/v{app_version}/{account}/{workspace}/notify |
Tracking
| Summary | Method | Path |
|---|---|---|
| Tracking events with app | POST | /{app_name}/v{app_version}/{account}/{workspace}/tracking |