When the Swisslog SynQ system is selcted on the Remote Storage Integration profile, Alma uses the following API calls to the Swisslog sytsem:

• “Product Master – Create” – When new item is added. This is triggered by
  • The “Inventory Remote Storage Update” job, as scheduled on the Remote Storage Integration Profile
  • In response to data requests received from from SynQ

• “Product Master – Delete” – When an item that is not stored in a crate is deleted. This is triggered by the “Inventory Remote Storage Update” job, as scheduled on the Remote Storage Integration Profile

• Order – Create” – When the request is placed

Outgoing Messages

“Product Master – Create”

Uses:

• Alma sends Product Master messages to create a product in the Swisslog SynQ system.
• Alma responds with Product Master message to data requests from the Swisslog SynQ system.

REST method: POST /synq/resources/nbproducts

Alma handles items that have a ‘Storage Location ID’ differently from items that don’t –

• An existing ‘Storage Location ID’ on the item record indicates that the Alma item is stored in a box in the storage, and that the box ID (stored in the ‘Storage Location ID’) is used for the communication with the Swisslog SynQ
• Where no ‘Storage Location ID’ exists on the item record the item is understood to be a standalone item, and its barcode is used to communicate with the Swisslog SynQ

List of fields:

“Product Master – Delete”

This is sent by the inventory update job when a standalone item (with no box number in Storage Location ID) is withdrawn in Alma from a location attached to the remote storage.

Swisslog allows an item to be deleted if the following holds:

• no more inventory inside SynQ is linked to this product.
• no ASN lines inside SynQ is linked to this product.
• no expected receipt lines inside SynQ is linked to this product.
• no order lines inside SynQ are linked to this product.
• no bill of materials are linked to this product.
• no work order and lines inside SynQ are linked to this product.

REST method: DELETE /nbproducts/{owner}/{productId}

“Order – Create”

Message is sent when a request is placed by staff user via Alma screen or by patron via Primo.

REST method: POST /synq/resources/orders/batch

List of fields: (only one order is sent in a message)

Incoming Messages

Requested path from Swisslog: POST {Alma Domain}/synq/resources/nbproducts/data-request

List of fields in incoming message:

Return response

When getting a data request, Alma checks if there are any items for which the barcode matches the barcode on the incoming message.

• If found then Alma returns the “Product Master – Create” for this item and a HTTP 200 OK response.
• If not found Alma checks if there’s an item with Storage Location ID that matches the barcode on the incoming message and returns “Product Master – Create” for the first match and a HTTP 200 OK response.
• If no matching item barcode and no matching Storage Location ID is found then Alma returns a HTTP 404 not found error