Skip to content

Get Offers

Request

Look up multiple offers in one request by their IDs. Uses POST (rather than GET) so that callers can pass many IDs without hitting URL length limits. IDs that cannot be resolved are returned in not_found_ids

See OfferResponse for the full concept and shape of an offer.

Security
BearerAuth
Headers
Acceptstring(OfferAcceptHeader)required

Set this to application/api.luminovo.offer-v1+json.

Value:"application/api.luminovo.offer-v1+json"
Bodyapplication/jsonrequired
idsArray of stringsrequired

The offer IDs to look up (colon-separated opaque strings as returned by other endpoints). IDs that do not resolve will appear in the response's not_found_ids list.

POST
/offers/bulk
curl -i -X POST \
  https://api.luminovo.com/offers/bulk \
  -H 'Accept: application/api.luminovo.offer-v1+json' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "ids": [
      "string"
    ]
  }'

Responses

Successfully retrieved offers. Note: any IDs that could not be resolved (wrong tenant, deleted, or non-existent) are returned in not_found_ids rather than causing the whole request to fail.

Bodyapplication/json
itemsArray of any(OfferResponse)required

The offers that were found. Order is not guaranteed and does not necessarily match the request order.

not_found_idsArray of stringsrequired

Offer IDs that could not be resolved. An ID lands here if it does not exist, was deleted, or belongs to a different tenant. Returning these explicitly (rather than silently dropping them) lets callers reconcile missing data without comparing input and output IDs themselves.

Response
{
  "items": [
    { … }
  ],
  "not_found_ids": [
    "string"
  ]
}