Adaco Requisitions Guide

Introduction

This resource enables you to retrieve information about current and historic requisition activity between Adaco outlets. Requisition items are typically either products or menu items (recipes). The response includes requisitions that were both issued and received by the specified property.

Quick Facts

Integration type HTTP REST with JSON
Authentication Basic Authentication
Availability Fourth Inventory for Hotels customers
Testing Test environment is available on request
More information See the Adaco Web API Reference 

Updates

You can find any updates on the Release Notes page for the Adaco Web API.

Get Access

Before integrating, you'll need to set up a new user account in Fourth with access rights to the API and resource.

Requests to the Requisitions resource are not restricted by property. This means you can retrieve requisitions data for properties in which the user account is not present.

Step 1: create a user group 

Create a user group for accessing the API within one of your Fourth properties — we recommend the central purchasing property where there is one. 

Screenshot showing the Group Details screen. Under "Edit Permissions", the "API Access" option is ticked.

For security, we also recommend that you limit the user group to access to just the “Requisitions API”. The setting for this is within the user group's Property > API Access sub-section. The group only needs the view option.

Screenshot of the "Access Rights" pop-up window, with the Requisition API row highlighted.

Step 2: create a user account

In the same property, create a user account. Assign it to the API user group.

Getting the property number

You’ll need the property number of your Adaco properties before you can make an API request. You can find the property numbers in the Fourth UI. 

Screenshot with the Property Number highlighted

Units of Measure

The response to requests includes an IssueUnit field. This returns predefined values you can find in the Units of Measure table.

Resources path

Details for integrating with the resource are available in the Adaco Web API reference.

The resource supports GET requests only. The path for Requisitions requests is:

<ROOT>/{customerName}Service/WebApi/Requisitions/{propertyNumber}

You need to put your customerName in the URL path — this is the same name in the URL that you currently use to log into Fourth Inventory for Hotels. You also need to add "Service" to the name; e.g. "acmeService".

Request header

For all requests, you must provide your authentication details using Basic authentication in the header. Example header:

GET /{customerName}Service/WebApi/Requisitions/{propertyNumber}  HTTP/1.1
Host: instance.example.com
Authorization: Basic VXNlcm5hbWU6cGFzc3dvcmQ=
Content-Type: application/json
Field Description
Authorization Your Requisitions API username and password, separated by a colon, and then base64 encoded. Your ID and password are case-sensitive. 
Content-Type The data format you are using for POST request. Options are: application/json, text/json.

Filtering requests

There are four optional parameters which can be included in the URL query string: pageSize and page let you determine how many requisitions you want returned in the response, while status and modifiedsince let you filter the responses.

For example, this request gets pending requisitions from and to property 12345. The request specifies the 3rd page of results, where each page holds 10 records:

GET <ROOT>/ACMEService/WebApi/Requisitions/12345?pageSize=10&page=3&status=pending

See the Adaco Web API reference for a full description.

Response to requests

Successful requests

Successfully submitted requests receive an HTTP 200 OK response.

You can find a full description and example in the Adaco Web API Reference.

Unsuccessful requests

Unsuccessful requests receive an HTTP 400-599 response, with an error message in the response body.