Get Inventory Events by Request ID

Retrieves all inventory events that were submitted as part of a specific bulk import request.

Use this endpoint to:

  • Verify that all events in a batch were processed successfully
  • Check the overall batch status (COMPLETED or PROCESSING)
  • Troubleshoot individual events

Response

The response includes:

  • status: Overall batch status
    • COMPLETED - All events have been processed
    • PROCESSING - Some events are still being processed
  • inventory_events: List of events sorted by sequence number
SecurityOAuth2-Production or OAuth2-Demo
Request
path Parameters
request-id
required
string

The request ID returned from the bulk import operation.

header Parameters
x-api-key
required
string

Your Carriyo API key for authentication.

Content-Type
string
Default: application/json
Responses
200

Successfully retrieved inventory events for the request.

404

No events found for the specified request ID.

get/inventory-events/request-id/{request-id}
Request samples
Response samples
application/json
{
  • "status": "COMPLETED",
  • "inventory_events": [
    ]
}