List affected shipments for a brief

Returns your organization's active shipments affected by a brief, with every identifier Vizion holds for each reference. The organization is resolved from your API key, so a brief only ever exposes your own shipments.

An unknown brief_id returns an empty list rather than a 404.

A 403 is returned when Risk Briefs is not enabled for your organization, and a 422 when a query parameter fails validation.

Related docs:

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Id of a risk brief, as returned in brief_id by the list endpoint

Query Params
boolean
Defaults to false

Include pagination metadata in response. See pagination.

integer
≥ 1
Defaults to 1

Requested paginated page

integer
1 to 100
Defaults to 25

Requested limit per paginated page (1-100).

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json