Reservations

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

Cancels a reservation by ID

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

delete

/reservations/{id}

Path parameters

idstringrequired

Reservation identifier

Responses

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.digitalriver.com/reservations/{id}'

204

400

401

403

404

405

406

408

409

429

500

502

503

504

204

No body

204 No Content

Create a reservation

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

post

/reservations

Body

idstring

The unique identifier of the reservation.

Example: 5678901234

shipToReservationShippingrequired

The customer's shipping information.

shippingChoiceReservationShippingChoicerequired

expiresInSecondsinteger | nullablerequired

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

Example: 300

itemsReservationInventoryItem[]required

Responses

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.digitalriver.com/reservations' \
  --header 'Content-Type: application/json' \
  --data '{"id":"5678901234","shipTo":{"address":{"city":"Minnetonka","postalCode":"55129","state":"MN","country":"US"}},"shippingChoice":{"currency":"USD","amount":5.95,"serviceLevel":"SG"},"expiresInSeconds":300,"items":[{"inventoryItemId":"9234276173","quantity":1,"allowOversell":false}]}'

201

400

401

403

405

406

408

409

429

500

502

503

504

201

{
  "id": "5678901234",
  "shipTo": {
    "address": {
      "city": "Minnetonka",
      "postalCode": "55129",
      "state": "MN",
      "country": "US"
    }
  },
  "shippingChoice": {
    "currency": "USD",
    "amount": 5.95,
    "serviceLevel": "SG"
  },
  "expiresInSeconds": 300,
  "liveMode": false,
  "items": [
    {
      "inventoryItemId": "9234276173",
      "quantity": 1,
      "allowOversell": false
    }
  ],
  "createdTime": {
    "nano": 0,
    "year": 2018,
    "monthValue": 4,
    "dayOfMonth": 25,
    "hour": 20,
    "minute": 36,
    "second": 0,
    "dayOfWeek": "WEDNESDAY",
    "dayOfYear": 115,
    "month": "APRIL",
    "offset": {
      "totalSeconds": 0,
      "id": "Z",
      "rules": {
        "fixedOffset": true,
        "transitions": [],
        "transitionRules": []
      }
    }
  }
}

201 Created