latestOpenAPI 3.0.12026-08-20112309904.6 KB
466169815b78
Suppliers - Sites
Get all suppliers
Retrieve all supplier sites accessible to the authenticated user with pagination support.
This endpoint returns a list of supplier sites (physical locations/branches with addresses), not site-groups (general company owners). Each site represents a specific physical location where the supplier operates.
Related Endpoints:
- To find suppliers by specific identifiers, use GET /public/v2/suppliers/sites/find-by-identifier.
- To create a new supplier, use POST /public/v2/suppliers/sites.
- To check pending supplier creation requests, use GET /public/v2/suppliers/sites/pending.
- To deactivate a supplier, use DELETE /public/v2/suppliers/sites.
Returns supplier sites that the user has access to with simplified information:
- Prewave Target ID
- Name
- Address (physical address of the site, if available)
- City
- Country Code
- Supplier IDs
Ordering:
- Supplier sites are ordered alphabetically by name (case-insensitive), then by ID for deterministic pagination
- Supplier IDs within each supplier site are ordered alphabetically by number, with null sources appearing last
Pagination:
- Results are paginated for efficient data retrieval
- Use query parameters to control pagination:
- page: Page number (0-indexed, default: 0)
- size: Number of items per page (default: 10)
- Ordering is fixed (alphabetically by name, then by ID) to ensure consistent results across pagination requests
Required Permission: ACCESS_PUBLIC_SUPPLIERS
get/public/v2/suppliers/sites
Query parameters
pageinteger
Zero-based page index (0..N)
sizeinteger
The size of the page to be returned
sortstring[]
Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
Response
Successfully retrieved suppliers