Check PIN Availability

The request of the availability of a PIN code for an identified product is the first interaction a client system shall implement against the domec.tools platform. This request return the effective availability of a product on the platform so that can be sold to the end user. From the end-user perspective this request starts when the user takes the blister with the product and give it to the cashier; this in turn pass the blister on the barcode reader on his desk which identifies the unique product code, the EAN, and send this code to the Domec Platform. Together with the feature of requesting the availability of a product, the client system can optionally set the booking flag in the request. This leverage a reservation for the client system and the product remains available to the requestor within 120 seconds of the booking itself. When the client system asks for the availability of a code you are requesting a product and its quantity indicating a booking id (is equivalent to a identifier for the reservation). In particular the system blocks, for the next 120 seconds, the availability of required codes by associating it with the identifying booking sent.

Request


GET https://api.domec.tools/v1.0/pd/pin?ProductCode=<string>&Quantity=<integer>&Booking=<boolean>&BookingRequestID=<string>&Shop=<string>&Terminal=<string>


Parameters

The Check PIN Availability receive the following parameters in the input.

NameTypeData TypeMandatory
ProductCodequerystring
Quantityqueryinteger
Bookingqueryboolean
BookingRequestIDquerystring 
Shopquerystring
Terminalquerystring

Responses

The following HTTP status codes may be returned, optionally with a response resource

Status codeDescriptionResponse body
200OK
Success
View body
400BadRequest
The input request contains errors which prevents executing the request
View body
404NotFound
Endpoint not found
View body