Skip to main content
GET
Lists facilities for the given sub-supplier.

Headers

X-Delogue-Api
string

Path Parameters

subSupplierId
string
required

Unique identifier of the sub-supplier whose facilities to list, formatted as a GUID.

Query Parameters

SubSupplierId
string

Restricts results to facilities belonging to the sub-supplier with this GUID identifier.

FacilityIds
string[]

Restricts results to facilities whose GUID identifiers are in this list.

ProcessingTypeIds
integer<int64>[]

Restricts results to facilities that have at least one of these process type identifiers assigned.

CountryCodes
string[]

Restricts results to facilities located in any of these countries, given as ISO 3166-1 alpha-2 codes such as CN or PT.

Mid
string

Restricts results to facilities whose Manufacturer Identification Number contains this text.

Free-text search matched against the facility name, Manufacturer Identification Number, address, city, state or region, postal code, and country.

State
enum<string>

Restricts results by lifecycle state; when omitted only active facilities are returned. Deleted facilities are never returned.

Available options:
active,
archived
sort
object[]

Repeat the parameter per sort column: sort[0].property=<column>&sort[0].order=Ascending|Descending, sort[1].... for a secondary column. order accepts asc, desc, ascending or descending (case-insensitive) and may also be spelled direction. Mutually exclusive with cursor. Sortable columns include: Id, Name, Address, Country, CountryCode, Mid, ProcessingType.

pageSize

Number of facilities to return per page. Defaults to 30, maximum 100.

pageNumber

The 1-based page number to return. Defaults to 1.

cursor
string

An opaque keyset pagination token for fetching the next page. Mutually exclusive with the filter, sort, pageSize, and pageNumber parameters.

Response

OK

status
enum<string>
required

The coarse outcome of the request, indicating whether it succeeded or failed.

Available options:
success,
error
code
string
required

The specific machine-readable outcome code, such as ok on success or the most specific error code on failure. Always lowercase on the wire.

data
object[]
required

The page of results, always an array. An empty page is an empty array rather than null or an omitted field.

pagination
object
required

Paging metadata for this response, carrying whether more rows remain and the cursor used to request the next page.