System Status

Reservations

The Reservations resource in our API enables clients to manage the reservation of inventory. It provides endpoints for placing, viewing, and canceling reservations. This functionality is crucial for businesses that must allocate inventory efficiently and ensure availability for orders or services. Users can seamlessly integrate reservation capabilities into their applications through the API, enhancing operational workflows and customer satisfaction.

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

delete
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
post
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": "2018-04-25T20:36:00Z",
  "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
}
PreviousRefundsNextReturns

Last updated