Document Properties
Kbid
A27786
Last Modified
31-May-2022
Added to KB
20-Jul-2016
Public Access
Everyone
Status
Online
Doc Type
References
Product
  • IOM 2.0
  • IOM 2.1
  • IOM 2.2
  • IOM 2.9
  • IOM 2.16
  • IOM 2.17
  • IOM 3.0
  • IOM 3.1
  • IOM 3.2
  • IOM 3.3
  • IOM 3.4
  • IOM 3.5
  • IOM 3.6
  • IOM 3.7
  • IOM 4.0
  • IOM 4.1
  • IOM 4.2
  • IOM 4.3

IOM REST API - Get Stock Reservation

URI

servlets/services/reservation/<resvId>

Http Method

GET

Short Description

Used to get a stock reservation. Usually called to check the validity of a stock reservation.

Example Requests URL

http://10.17.0.245:8080/servlets/services/reservation/117

Example RequestsNo Content

HTTP Status Codes

  • 200 OK
  • 400 Bad Request

  • 401 Unauthorized

  • 404 Not Found

  • 500 Internal Server Error

Description

The IOM enables shop systems to get stock reservations via HTTP GET requests via ID.

This service supports only the content-type application/json.

ParametersPath parameter resvId = ID of the requested stock reservation

Product Version

1.1

Product To Version

 
Status

New Labels

Authorization

IOM supports "basic http authentication" only. Please configure your clients to use this authentication method. A very simple method to send REST requests on the command line can be realized using wget. The example also shows, how to configure this client to use "basic http authentication" (--auth-no-challenge).

 

wget -q -O- --auth-no-challenge --http-user=<user> --http-password='<password>' \
--method=get http://<hostname>/servlets/services/reservation/117

 

It is Important that the permission REST_RESERVATION (oms.RightDefDO with ID = 124 and name "Reservation REST service") is assigned to the requesting user. The permission is a part of the class bakery.persistence.dataobject.configuration.common.RightDefDO.
The user also needs the permission for the OMS shop instance which relates to the requested stock reservation.

JSON

Request data format

application/json

Request related java object

n/a

Request data example

No Content

Response data format

application/json

Response related java object

bakery.webservice.rest.v1.HttpResponse
bakery.reservation.v2.ReservationResponse as "data" object
Response Attributes
AttributesDescription
statusCodeHTTP status code

errors

always empty

exceptions

always empty
datasee table below
Data AttributeDescription
validUntilThe Validity of the Stock Reservation
resvIdThe id <primary key> of the Stock Reservation
items1..n items. See table below
Item AttributeDescription
idThe ID of the product. Via the OMS configurations it is determined if it is the shop product number or the IOM product ID.
qtyReserved quantity
state

State of the reservation. The reservation of the product is still "revered" or "expired".

Response data example

{
  "errors": [
  ],
  "statusCode": 200,
  "exceptions": [
  ],
  "data": {
    "validUntil": "2016-01-06 15:05:30",
    "resvId": 118,
    "items": [
      {
        "id": "First-Test",
        "qty": 3,
        "state": "reserved"
      },
      {
        "id": "First-Test",
        "qty": 2,
        "state": "reserved"
      }
    ]
  }
}
Response Code200

Disclaimer

The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.

Customer Support
Knowledge Base
Product Resources
Tickets