Get batch inventory status
Retrieves the current processing status and progress information for a batch inventory job. Use this endpoint to poll the batch status and track processing progress.
ℹ️ This feature is in early access, which means that we are working to improve it. If you want to use this feature, please contact our Support Center.
This endpoint is part of the Batch operations section for high-throughput inventory updates. Learn more about inventory management at VTEX.
Permissions
Any user or API key must have at least one of the appropriate License Manager resources to be able to successfully run this request. Otherwise, they will receive a status code 403 error. These are the applicable resources for this endpoint:
| Product | Category | Resource |
|---|---|---|
| Logistics | Logistics access | Logistics - Full access |
You can create a custom role with that resource or use one of the following predefined roles:
| Role | Resource |
|---|---|
| Logistics - Full access | Logistics - Full access |
| OMS - Full access | Logistics - Full access |
❗ Assigning a predefined role to users or API keys usually grants permission to multiple License Manager resources. If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see Best practices for using API keys.
To learn more about machine authentication at VTEX, see Authentication overview.
Path parameters
Unique identifier for the batch job, returned by the Create batch inventory job endpoint.
Headers
HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.
Response
OK