Sign in
latestOpenAPI 3.0.12026-08-101292701.1 MB

f21981db32be

Reservations

Create a reservation

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

post/reservations

Request body

idstring

The unique identifier of the reservation.

expiresInSecondsinteger nullable required

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

Example request

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

Response

201 Created

idstring

The unique identifier of the reservation.

createdTimestring date-time

The time when the reservation was created.

expiresInSecondsinteger

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

liveModeboolean

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

Example response

{
  "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
    }
  ],
  "expiresInSeconds": 300
}