Reservations

The Reservations resource allows you to place a hold on one or more inventory items.

Cancels a reservation by ID.

delete

Cancels a reservation. Supply the unique identifier of the reservation.

Path parameters

idstringRequired

Reservation identifier

Responses

204

204 No Content

400

400 Bad Request

application/json

401

401 Unauthorized

application/json

403

403 Forbidden

application/json

404

401 Not Found

application/json

405

405 Method Not Allowed

application/json

406

406 Not Acceptable

application/json

408

408 Request Timeout

application/json

409

409 Conflict

application/json

429

429 Too Many Requests

application/json

500

500 Internal Server Error

application/json

502

502 Bad Gateway Error

application/json

503

503 Service Unavailable Error

application/json

504

504 Gateway Timeout Error

application/json

delete

HTTPcURLJavaScriptPython

DELETE /reservations/{id} HTTP/1.1
Host: api.digitalriver.com
Accept: */*

No content

Create a reservation

post

Create a reservation to hold inventory items in a fulfillment order.

Body

idstringOptional

The unique identifier of the reservation.

Example: 5678901234

expiresInSecondsinteger | nullableRequired

A positive integer that specifies the number of seconds before the reservation expires and is deleted.

Example: 300

Responses

201

201 Created

application/json

400

400 Bad Request

application/json

401

401 Unauthorized

application/json

403

403 Forbidden

application/json

405

405 Method Not Allowed

application/json

406

406 Not Acceptable

application/json

408

408 Request Timeout

application/json

409

409 Conflict

application/json

429

429 Too Many Requests

application/json

500

500 Internal Server Error

application/json

502

502 Bad Gateway Error

application/json

503

503 Service Unavailable Error

application/json

504

504 Gateway Timeout Error

application/json

post

HTTPcURLJavaScriptPython

POST /reservations HTTP/1.1
Host: api.digitalriver.com
Content-Type: application/json
Accept: */*
Content-Length: 282

{
  "id": "5678901234",
  "items": [
    {
      "inventoryItemId": "9234276173",
      "quantity": 1,
      "allowOversell": false
    }
  ],
  "shipTo": {
    "address": {
      "city": "Minnetonka",
      "postalCode": "55129",
      "state": "MN",
      "country": "US"
    }
  },
  "shippingChoice": {
    "currency": "USD",
    "amount": 5.95,
    "serviceLevel": "SG"
  },
  "expiresInSeconds": 300
}

{
  "id": "5678901234",
  "createdTime": "2025-05-08T19:46:36.845Z",
  "shipTo": {
    "address": {
      "city": "Minnetonka",
      "postalCode": "55129",
      "state": "MN",
      "country": "US"
    }
  },
  "shippingChoice": {
    "currency": "USD",
    "amount": 5.95,
    "serviceLevel": "SG"
  },
  "items": [
    {
      "inventoryItemId": "9234276173",
      "quantity": 1,
      "allowOversell": false
    }
  ],
  "expiresInSeconds": 300,
  "liveMode": false
}