Skip to main content
GET
Get sub-suppliers

Headers

X-Delogue-Api
string

Query Parameters

Free-text term matched across the sub-supplier's name, address, location, custom ID, MID, website, and primary contact details.

Ids
string[]

Restricts results to the sub-suppliers with these identifiers.

CountryCodes
string[]

Restricts results to sub-suppliers located in these countries, matched by country code.

CustomIds
string[]

Restricts results to sub-suppliers with these customer-defined IDs.

RelationTypes
enum<string>[]

Restricts results to sub-suppliers with any of these commercial relationship types.

Available options:
distributor,
itemSupplier,
sourcingAgency,
styleSupplier
ProcessingTypeIds
integer<int64>[]

Restricts results to sub-suppliers that have a facility performing any of these processing types.

PhoneNumber
string

Restricts results to sub-suppliers whose primary contact phone number contains this value. Spaces are ignored.

Mid
string

Restricts results to sub-suppliers whose MID contains this value.

DateAdded
string<date-time>

Restricts results to sub-suppliers created on this calendar date.

ShowArchived
boolean

When true, archived sub-suppliers are included in the results; otherwise they are excluded.

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: Name, CustomId, DateAdded, Address, ZipCode, City, StateOrRegion, Latitude, Longitude, Country, CountryCode, WebSite, VatNumber, Mid, Relation, PrimaryContact, PhoneNumber, SubSupplierId.

pageSize

The maximum number of results 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.