Retailer API (v1)

Every product and supplier belongs to exactly one group.

The response IDs can be used in other endpoints to scope requests.

Invite a supplier to provide data on relevant products.

The supplier will be requested to provide data on products. The supplier must be the active supplier (aka linked) to each given product.

Sends a platform invite email to supplier contacts. Supplier contacts who have received such an email from previous calls to this endpoint will not be sent an additional email. Once the supplier has registered in the platform no further emails are sent.

If a product data request has been declined then calling invite with that product sends a new data request.

Status 425 indicates some product has not yet finished the necessary background processing. Try again after some time, ideally with increasing backoff.

Paginate resold products. The response will be ordered by their ID. Use the optional query parameter to control the pagination.

Create a new product which is bought as it is sold.

List IDs of products that have updated information. Fetch each product to see the relevant information. Use updated_at of the last item in the list to progress the pagination. The since parameter is inclusive, so pages may repeat the last item of the previous page. Avoid a since parameter too close to wall time, since then in flight updates may be missed.

Delete a resold product.

This will delete the product and any not yet accepted links to suppliers. If a supplier has been connected they will keep their variant of the product but it will no longer be visible from this API.

Get a resold product.

Replace all fields on resold product.

The information about current supplier of the product.

See GET /suppliers/{id}/linked-products for an explanation of the status. Responds status 204 if there is no current supplier of this product.

Get forest, land and agriculture emissions breakdown of many products.

List IDs of products that have updated footprint information. Fetch each product to see the relevant information. Use updated_at of the last item in the list to progress the pagination. The since parameter is inclusive, so pages may repeat the last item of the previous page. Avoid a since parameter too close to wall time, since then in flight updates may be missed.

List IDs of products that have updated footprint baseline information. Fetch each product to see the relevant information. Use updated_at of the last item in the list to progress the pagination. The since parameter is inclusive, so pages may repeat the last item of the previous page. Avoid a since parameter too close to wall time, since then in flight updates may be missed.

Get forest, land and agriculture emissions baselines of many products.

Get forest, land and agriculture emissions breakdown of a specific product.

Get forest, land and agriculture emissions breakdown of a specific product. The returned footprint baseline is modeled using only secondary data. This is not a secondary contribution to the primary footprint.

Retrieves all supplier periods for a product and their corresponding time ranges. The returned id on each period should be included in PUT requests to preserve existing periods and their internal linkage.

Replace the supplier period history for this product.

Each supplier entry may include an optional id field:

• With id: updates the existing period's dates in place, preserving the supplier and internal linkage.
• Without id: creates a new period.
• Any existing period whose id is not present in the request will be removed.

To avoid accidentally deleting periods, first fetch the current list via GET /resold-products/{id}/suppliers and include the returned id values for any periods you wish to keep.

Validation rules:

• All dates must be today or in the past.
• validFrom must not be after validTo (same day is allowed).
• Periods must not overlap in time, not even share a boundary day.

This endpoint only creates data connections. It does not contact or expose any data to suppliers in itself.

List suppliers for one or more groups

Create a new supplier within an organization. Contacts can optionally be included.

Delete a supplier by its unique ID. Supplier must not be invited or connected.

Get a supplier by its unique ID

Update an existing supplier by its unique ID. Only provided fields will be updated. If contacts are provided, they completely replace all existing contacts.

List active linked products for a supplier. Use optional status query filter to list only products with a specific status.

Status values:

• created: Product is linked to the supplier but no invite has been sent.
• sent: An invite has been sent to the supplier and is awaiting a response.
• declined: The supplier declined the invite.
• accepted: The supplier accepted the invite and has ownership of the product, but has not yet submitted any data.
• active: The supplier has accepted the invite and submitted (published) data at least once.