Supplier Items feed
Details of the items (lots) available for bidding in Sourcing Events you have been invited to are available through the Supplier Items feed. The feed provides a record per item, carrying the bid sheet values known for that item. See the OpenAPI specification for full details.
Unlike the other Export API feeds, which are scoped to the purchaser running the event, the Supplier Items feed is scoped to your organisation as a supplier: it returns items from other organisations' Sourcing Events in which you are a participating bidder.
Note
The Supplier Items feed is part of the Bidding API, which is not available on the Free Plan. It is only available on the Enhanced or Premium Plan.
The feed is the read side of the bidding API workflow: fetch the items you have been invited to bid on from this
feed, then place bids using the place-bid job endpoint on the Intake API (see the Intake APIs section).
The item field of each record is the item ID the place bid endpoint expects.
The feed is updated when items are generated or refreshed for a Sourcing Event you have been invited to. A
SUPPLIER_ITEMS_FEED_UPDATED webhook trigger is available to be notified when this happens — see the
Webhook API section for details.
Examples
The following examples show how the feed may be used to get item data. In each example, we show the URL used with
a GET request and the corresponding response JSON. Click on the Response section to see the full response
content.
These examples are specific to the Supplier Items feed, to be used with the /feeds/supplier/items endpoint
which is more fully described in the OpenAPI specification.
Basic Supplier Items feed
This example shows simple use of the Supplier Items feed. It is unfiltered so returns all item records in the order they have been added or modified, starting from the oldest.
Filtered example
The below example filters to the items of a specific Sourcing Event, modified within a date range.
Filters
The following filters are available on the Supplier Items feed. These are also detailed on the OpenAPI specification. Filters are applied additively.
Filter to records associated with a specific Sourcing Event.
Filter to records modified within a date range. One or both ends may be provided. If a date is supplied
without a time, the time defaults to 00:00 UTC.
If no date filters are provided, the feed returns the last 45 days of data by default.
Response fields
Each item record contains:
| Field | Type | Description |
|---|---|---|
id |
integer | Unique record identifier (for tracking updates) |
sourcing_event |
UUID | The Sourcing Event this item belongs to |
item |
UUID | The item (lot) identifier — use this when placing a bid via the Intake API |
sourcing_event_name |
string | The name of the Sourcing Event |
organisation |
string | The display name of the purchaser organisation running the event |
data |
object | The item's bid sheet values (see below) |
modified |
datetime | When this record was last updated |
The data object
The data object carries the item's bid sheet values as strings, keyed by standard field identifier — the same
identifiers used by the standard_field column selector when placing bids through the Intake API. Examples
include:
| Key | Description |
|---|---|
general.lot_identifier |
The item's name on the bid sheet (e.g. "Lot 1") |
geo.origin_postal_code |
Origin postal code |
geo.destination_postal_code |
Destination postal code |
logistics.distance |
Shipment distance |
logistics.trailer_type |
Trailer / equipment type |
sourcing.event_invite_datetime |
When your organisation was invited to the event |
The exact set of keys depends on the bid sheet columns defined by the purchaser for the event, so consumers
should treat data as a flexible map rather than a fixed schema.
Data updates
The data returned by the Supplier Items feed represents a snapshot of the latest known item data. When the items of a Sourcing Event are refreshed, the existing records for that event are replaced and the updated records are appended to the end of the feed (see Data Updates for details on how updates work).
Records returned from the Supplier Items feed can be uniquely identified using the id field. This ID can be
used to track changes as described in the Data Updates section of the usage document.
Typical consumer workflow
- Receive a
SUPPLIER_ITEMS_FEED_UPDATEDwebhook notification (or poll the feed periodically) - Fetch the updated items:
GET /api/feeds/supplier/items?sourcing_event={event} - Decide your bids based on the item
data - Place bids via the Intake API:
POST /api/jobs/place-bidwith theitemUUID from the feed record