Skip to main content
GET
List vault line items

Authorizations

x-api-key
string
header
required

API key for authentication

Query Parameters

vaultIntakeShipmentId
string<uuid>

Filter by vault intake shipment ID

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
productId
string<uuid>

Filter by product ID

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
fulfillmentStatus
enum<string>

Filter by fulfillment status

Available options:
available,
locked,
fulfilled
limit
integer
default:20

Maximum number of records to return (default 20, max 100)

Required range: 1 <= x <= 100
offset
integer
default:0

Number of records to skip (for pagination)

Required range: 0 <= x <= 9007199254740991

Response

200 - application/json

Default Response

data
object[]
required
total
number
required