LogoLogo
System Status
2020-12-17
2020-12-17
  • 2021-12-17
  • Charges
  • Checkouts
  • Country specifications
  • Customers
  • Events
  • Fees
  • File links
  • Files
  • Fulfillment cancellation
  • Fulfillment orders
  • Fulfillment returns
  • Fulfillments
  • Inventory items
  • Inventory levels
  • Invoices
  • Orders
  • Payouts
  • Refunds
  • Reservations
  • Returns
  • Sales summaries
  • Sales transactions
  • Shipments
  • Shipping quotes
  • SKU
  • Sources
  • Webhooks
Powered by GitBook
On this page

Reservations

PreviousRefundsNextReturns

Last updated 7 months ago

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

  • DELETECancels a reservation by ID
  • POSTCreate a reservation

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
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
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": {
    "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
}