IOM REST API - Get Stock Reservation

Personal Library

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 Requests	No 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.
Parameters	Path 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

Attributes	Description
statusCode	HTTP status code
errors	always empty
exceptions	always empty
data	see table below

Data Attribute	Description
validUntil	The Validity of the Stock Reservation
resvId	The id <primary key> of the Stock Reservation
items	1..n items. See table below

Item Attribute	Description
id	The ID of the product. Via the OMS configurations it is determined if it is the shop product number or the IOM product ID.
qty	Reserved 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 Code

200

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.