# Get offers for timerange

Returns the newest offers for a given time range.

Endpoint: GET /api/v3/vendor/contracts/{contractId}/offers
Version: 0.0.7228
Security: BasicAuth, BearerAuth

## Path parameters:

  - `contractId` (string, required)
    Unique identifier of the contract
    Example: "qbcxvb"

## Query parameters:

  - `start` (integer)
    Where to start fetching the products

  - `limit` (integer)
    Maximum number of results
    Example: 1000

  - `includeTags` (boolean)
    Whether to return tags of products or not.

  - `startDate` (string)
    for data retrieval.

Format: ISO 8601 date-time in UTC (e.g., )


- If omitted and  is provided:  =  - 48 hours
- If both omitted: range is  to
    Example: "2024-01-15T00:00:00Z"

  - `endDate` (string)
    for data retrieval.

Format: ISO 8601 date-time in UTC (e.g., )


- If omitted and  is provided:  =  + 48 hours
- If both omitted: range is  to
    Example: "2024-01-16T23:59:59Z"

## Response 200 fields (application/json):

  - `data` (array, required)

  - `data.product` (object, required)
    The product information.

  - `data.product.name` (string, required)
    The name of the product.

  - `data.product.tags` (array, required)
    Additional imported information as key-value pairs about this product.

  - `data.product.tags.key` (string, required)

  - `data.product.tags.value` (string, required)

  - `data.product.minPriceBoundary` (number)
    The minimum price that Omnia 2.0 can recommend for the product. Omnia 2.0 won't recommend any price below this boundary.

  - `data.product.gtin` (number)
    GTIN / EAN of the product. This field is optional.

  - `data.product.customerProductId` (string)
    Your ID of the product. This field allows to link products in Omnia 2.0 to products in your system.

  - `data.product.id` (string, required)
    The internal product ID in Omnia 2.0.

  - `data.product.maxPriceBoundary` (number)
    The maximum price that Omnia 2.0 can recommend for the product. Omnia 2.0 won't recommend any price above this boundary.

  - `data.product.referencePrice` (number, required)
    The current selling price of the product. This price will be used as benchmark or variable for certain components in Omnia 2.0.

  - `data.offers` (array, required)
    The list of offers for the corresponding product.

  - `data.offers.positionByTotalPrice` (integer, required)
    The position of the offer on the domain when sorted by total price.

  - `data.offers.deliveryCosts` (number, required)
    The additional charges for delivering the product to the customer's location (shipping costs).

  - `data.offers.maxDeliveryTime` (integer)
    Optional maximum time, in hours, it takes for the product to be delivered to the customer.

  - `data.offers.url` (string, required)
    The direct link to the product page on the domain where this offer can be found.

  - `data.offers.vendorDomainId` (string)
    An identifier of the vendor on the domain. Identifiers are available for certain domains only.

  - `data.offers.domain` (string, required)
    The website from which the offer originates.

  - `data.offers.price` (number, required)
    The unit price of the offer.

  - `data.offers.minDeliveryTime` (integer)
    Optional minimum time, in hours, it takes for the product to be delivered to the customer.

  - `data.offers.gtin` (number)
    An optional field for the GTIN / EAN of the product.

  - `data.offers.positionByUnitPrice` (integer, required)
    The position of the offer on the domain when sorted by unit price.

  - `data.offers.availability` (boolean)
    An optional flag indicating whether the product is currently in stock and available for purchase.

  - `data.offers.attributes` (array, required)
    A list of additional offer details.

  - `data.offers.attributes.name` (string, required)

  - `data.offers.vendorName` (string, required)
    The display name of the shop which sells the product. In some cases (e.g. marketplaces) with some additional information about the seller: e.g. Amazon NL - Sold By Amazon NL

  - `data.offers.retrievalDate` (string)
    Optional timestamp based on ISO 8601 format, indicating when this offer was fetched from the domain.

  - `data.offers.creationDate` (string, required)
    An optional timestamp in ISO 8601 format indicating when this offer was stored in Omnia 2.0. This is not the timestamp when the offer was fetched from the domain; for that, use retrievalDate.

  - `data.offers.productName` (string, required)
    The name of the product as listed on the domain.

  - `data.offers.currency` (string, required)
    The currency in which the price and delivery costs are expressed. Provided values are ISO 4217 currency codes like "EUR".

  - `data.offers.productId` (string, required)
    The internal product ID in Omnia 2.0.

  - `data.offers.ignored` (boolean, required)
    A flag indicating whether the offer has been blacklisted or not by the Omnia 2.0 filters.

## Response 400 fields (application/json):

  - `code` (string, required)
    Machine-readable error code for programmatic error handling.
Typically follows a structured format like 'request.invalid' or 'resource.invalid'.
    Example: "request.invalid"

  - `message` (string, required)
    Human-readable error message providing details about the issue
    Example: "The provided email address is not in a valid format"