System Status

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
delete
curl -L \
  --request DELETE \
  --url 'https://api.digitalriver.com/reservations/{id}'
No Content

204 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
itemsobject[]required

shipToobjectrequired

The customer's shipping information.

shippingChoiceobject | nullablerequired

expiresInSecondsinteger | nullablerequired

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

Example: 300
Responses
post
curl -L \
  --request POST \
  --url 'https://api.digitalriver.com/reservations' \
  --header 'Content-Type: application/json' \
  --data '{
    "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": {
    "offset": {
      "totalSeconds": 0,
      "id": "Z",
      "rules": {
        "fixedOffset": true,
        "transitions": [],
        "transitionRules": []
      }
    },
    "nano": 0,
    "year": 2018,
    "monthValue": 4,
    "dayOfMonth": 25,
    "hour": 20,
    "minute": 36,
    "second": 0,
    "dayOfWeek": "WEDNESDAY",
    "dayOfYear": 115,
    "month": "APRIL"
  },
  "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
}

201 Created

PreviousRefundsNextReturns

Last updated