GET /v3/vendor/products/:id/reservations — live reservations

GET

/v3/vendor/products/{productId}/reservations

const url = 'https://api-ha-prod-p8.handbid.dev/v3/vendor/products/5001/reservations';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api-ha-prod-p8.handbid.dev/v3/vendor/products/5001/reservations \
  --header 'Authorization: Bearer <token>'

The auction items that currently hold a reservation on this package. protectedWithin60d flags reservations whose auction ends inside the 60-day notice window (they cannot be pulled without an emergency).

Errors: 404 not_found (not in your catalog), 401 / 403 as elsewhere.

Authorizations

bearer

Parameters

Path Parameters

productId

required

integer

Example

Responses

200

The package’s live reservations.

application/json

object

Example

{
  "reservations": [
    {
      "itemId": 7001,
      "auctionId": 555,
      "auctionName": "Spring Gala",
      "endTime": 1893456000,
      "protectedWithin60d": false,
      "status": "open"
    }
  ]
}

401

No or invalid Bearer token.

application/json

Unified error envelope. retryAfter is present only on transient (429 / 503) responses.

object

error

required

Stable machine-readable error code (e.g. unauthorized, forbidden, not_found, validation_error, unavailable).

string

message

required

Human-readable explanation.

string

retryAfter

Seconds to wait before retrying. Present on 429 and 503.

integer

Example

{
  "error": "unauthorized",
  "message": "A valid Bearer token is required."
}

403

The token’s organization is not a marketplace vendor.

application/json

Unified error envelope. retryAfter is present only on transient (429 / 503) responses.

object

error

required

Stable machine-readable error code (e.g. unauthorized, forbidden, not_found, validation_error, unavailable).

string

message

required

Human-readable explanation.

string

retryAfter

Seconds to wait before retrying. Present on 429 and 503.

integer

Example

{
  "error": "forbidden",
  "message": "Your organization is not a marketplace vendor."
}

404

Not found in your catalog.

application/json

Unified error envelope. retryAfter is present only on transient (429 / 503) responses.

object

error

required

Stable machine-readable error code (e.g. unauthorized, forbidden, not_found, validation_error, unavailable).

string

message

required

Human-readable explanation.

string

retryAfter

Seconds to wait before retrying. Present on 429 and 503.

integer

Example

{
  "error": "not_found",
  "message": "Product not found in your catalog."
}