Skip to main content
GET
/
commerce
/
reservation
/
{reservationId}
Error
A valid request URL is required to generate request examples
{
  "id": "<string>",
  "siteId": 123,
  "tenantId": 123,
  "userId": "<string>",
  "customerAccountId": 123,
  "items": [
    {
      "lineId": 123,
      "id": "<string>",
      "orderItemId": "<string>",
      "product": {
        "productCode": "<string>",
        "name": "<string>",
        "productType": "<string>",
        "mfgPartNumber": "<string>",
        "variationProductCode": "<string>",
        "sku": "<string>",
        "goodsType": "<string>",
        "productUsage": "<string>",
        "bundledProducts": [
          {
            "productCode": "<string>",
            "name": "<string>",
            "goodsType": "<string>",
            "quantity": 123,
            "optionAttributeFQN": "<string>",
            "optionValue": "<unknown>",
            "measurements": {
              "height": {
                "unit": "<string>",
                "value": 123
              },
              "width": {
                "unit": "<string>",
                "value": 123
              },
              "length": {
                "unit": "<string>",
                "value": 123
              },
              "weight": {
                "unit": "<string>",
                "value": 123
              }
            }
          }
        ],
        "isSplitExtrasInShipment": true,
        "properties": [
          {
            "attributeFQN": "<string>",
            "values": [
              {
                "stringValue": "<string>",
                "value": "<unknown>"
              }
            ]
          }
        ],
        "measurements": {
          "height": {
            "unit": "<string>",
            "value": 123
          },
          "width": {
            "unit": "<string>",
            "value": 123
          },
          "length": {
            "unit": "<string>",
            "value": 123
          },
          "weight": {
            "unit": "<string>",
            "value": 123
          }
        },
        "isTaxable": true,
        "serialNumber": "<string>",
        "condition": "<string>"
      },
      "quantity": 123,
      "fulfillmentLocationCode": "<string>",
      "fulfillmentMethod": "<string>",
      "allocations": [
        {
          "itemId": "<string>",
          "quantity": 123,
          "fulfillmentLocationCode": "<string>",
          "transferLocationCode": "<string>",
          "productCode": "<string>",
          "futureDate": "2023-11-07T05:31:56Z",
          "isStateChange": true,
          "allocationId": 123
        }
      ],
      "allowsBackOrder": true,
      "allocationStatus": "<string>",
      "inventoryTags": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "suggestions": [
        {
          "locationCode": "<string>",
          "suggestionType": "<string>",
          "quantity": 123,
          "productCode": "<string>",
          "futureDate": "2023-11-07T05:31:56Z"
        }
      ],
      "fulfillmentInfo": {
        "fulfillmentContact": {
          "id": 123,
          "email": "<string>",
          "firstName": "<string>",
          "middleNameOrInitial": "<string>",
          "lastNameOrSurname": "<string>",
          "companyOrOrganization": "<string>",
          "phoneNumbers": {
            "home": "<string>",
            "mobile": "<string>",
            "work": "<string>"
          },
          "address": {
            "address1": "<string>",
            "address2": "<string>",
            "address3": "<string>",
            "address4": "<string>",
            "cityOrTown": "<string>",
            "stateOrProvince": "<string>",
            "postalOrZipCode": "<string>",
            "countryCode": "<string>",
            "addressType": "<string>",
            "isValidated": true
          }
        },
        "shippingMethodCode": "<string>",
        "shippingMethodName": "<string>",
        "isDestinationCommercial": true,
        "itemLevelShippingMethod": "<string>"
      },
      "shippingMethodCode": "<string>"
    }
  ],
  "cartId": "<string>",
  "orderId": "<string>",
  "orderNumber": 123,
  "expirationDateTime": "2023-11-07T05:31:56Z",
  "zipCode": "<string>",
  "status": "<string>",
  "auditInfo": {
    "createdBy": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedBy": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "changeMessages": [
    {
      "id": "<string>",
      "identifier": "<string>",
      "correlationId": "<string>",
      "userId": "<string>",
      "appKey": "<string>",
      "appName": "<string>",
      "subjectType": "<string>",
      "subject": "<string>",
      "verb": "<string>",
      "message": "<string>",
      "createDate": "2023-11-07T05:31:56Z"
    }
  ],
  "reservationType": "<string>",
  "fulfillmentInfo": {
    "fulfillmentContact": {
      "id": 123,
      "email": "<string>",
      "firstName": "<string>",
      "middleNameOrInitial": "<string>",
      "lastNameOrSurname": "<string>",
      "companyOrOrganization": "<string>",
      "phoneNumbers": {
        "home": "<string>",
        "mobile": "<string>",
        "work": "<string>"
      },
      "address": {
        "address1": "<string>",
        "address2": "<string>",
        "address3": "<string>",
        "address4": "<string>",
        "cityOrTown": "<string>",
        "stateOrProvince": "<string>",
        "postalOrZipCode": "<string>",
        "countryCode": "<string>",
        "addressType": "<string>",
        "isValidated": true
      }
    },
    "shippingMethodCode": "<string>",
    "shippingMethodName": "<string>",
    "isDestinationCommercial": true,
    "itemLevelShippingMethod": "<string>"
  }
}

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

reservationId
string
required

Query Parameters

responseFields
string

limits which fields are returned in the response body

Response

Success

id
string | null
siteId
integer<int32> | null
tenantId
integer<int32> | null
userId
string | null
customerAccountId
integer<int32> | null
items
object[] | null
cartId
string | null
orderId
string | null
orderNumber
integer<int32> | null
expirationDateTime
string<date-time> | null
zipCode
string | null
status
string | null
auditInfo
object
changeMessages
object[] | null
reservationType
string | null
fulfillmentInfo
object