YSRBS Public API v1.0.0

The YSRS API utilizes the REST architecture so you can seamlessly integrate your app with YellowStone and the YSRBS Ecosystem.

Here’s how to get started:

Obtain API Key
Whitelist requestin server IPs
Create sandbox environments and set up testing tools

We’re here to help you integrate your app with RBS Apps and understand all the related moving parts.

Review this documentation to familiarize yourself and our API’s capabilities. They’ll give you a sense of what you can build and how to build it.

Server

https://public-api.lodgeical.us/api

Sandbox

https://api.rbsapps.com/api

Live

Authentication

apiKey api_key

Use a valid API key to test the API endpoints. Since we use the API Key authentication, it's highly recommended to initiate the request from a server rather than the browser since the API Key is visible at the request header when originated from the browser.

Fields

Key	In
x-api-key	Header

Get Inventory Locations

This API endpoint will retrieve the list of inventory locations that are enabled for selling online in the YSRBS application.

Auth

Query String

inventoryLocationID

integer

Inventory Location ID

GET /Inventory/GetInventoryLocations

xxxxxxxxxx
 
curl --get \ --url 'https://public-api.lodgeical.us/api/Inventory/GetInventoryLocations' \ --header 'x-api-key: {x-api-key}' \ --data inventoryLocationID={inventoryLocationID}
Copy

Responses

200

Sucess Message

Root Type for GetInventoryLocationResponse	object	Inventory Location Response
inventoryLocationID	int32
clientId	int32
inventoryLocationName	string
locationProfitCenterId	int32
locationProfitCenter	string
isPOS	boolean
categoryTypeID	int32
categoryTypeName	string
iconName	string
sellOnline	boolean
isActive	boolean
isDeleted	boolean

Response

xxxxxxxxxx
 
{ "content": [  {   "inventoryLocationID": 198,   "clientId": 19,   "inventoryLocationName": "Pro Shop",   "locationProfitCenterId": 10,   "locationProfitCenter": "2001/South Operations",   "isPOS": true,   "isKitchen": true,   "categoryTypeID": 269,   "categoryTypeName": "Pro Shop",   "iconName": "<i class=\"fas fa-shopping-bag\"></i>",   "sellOnline": true,   "isActive": true,   "isDeleted": false  },  {   "inventoryLocationID": 203,   "clientId": 19,   "inventoryLocationName": "The Grill",   "locationProfitCenterId": 10,   "locationProfitCenter": "2001/South Operations",   "isPOS": true,   "isKitchen": true,   "categoryTypeID": 276,   "categoryTypeName": "F&B",   "iconName": "<i class=\"fas fa-wine-glass-alt\"></i>",   "sellOnline": true,   "isActive": true,   "isDeleted": false  } ], "errors": [], "message": "Inventory location setup retrieval successful.", "success": true}
Copy

Get Inventory Items

Get list of inventory items. Inventory items can be filter by the Item Number or by the inventory location ID

Auth

Query String

inventoryLocationID	integer	Pass an inventory location ID to retrieve inventory items specific to the location.
itemNumber	string	Pass Item Numer to retrieve specific inventory item details.

GET /Inventory/GetInventoryItem

xxxxxxxxxx
 
curl --get \ --url 'https://public-api.lodgeical.us/api/Inventory/GetInventoryItem' \ --header 'x-api-key: {x-api-key}' \ --data inventoryLocationID={inventoryLocationID} \ --data itemNumber={itemNumber}
Copy

Responses

200

Sucess Message

Root Type for GetInventoryItemResponseType	object	Get Inventory Item Response Type Defination
inventoryId	int32
itemNumber	string
inventoryLocationId	int32
inventoryLocationName	string
description	string
size	string
color	string
quantityInHand	int32
price	number

Response

xxxxxxxxxx
 
{ "content": [  {   "inventoryId": 45186,   "itemNumber": "10029653",   "inventoryLocationId": 198,   "inventoryLocationName": "Pro Shop",   "description": "Women's Ariat Dixon Black Western Bootie",   "size": "7",   "color": "#ff0f0f",   "productType": "Appetizer",   "productImageType": "",   "productImageURL": "",   "quantityInHand": 5,   "cost": 53.29,   "price": 199  },  {   "inventoryId": 45190,   "itemNumber": "112317278",   "inventoryLocationId": 198,   "inventoryLocationName": "Pro Shop",   "description": "Women's Wrangler Sherpa Snap Jacket",   "size": "M",   "color": "#faf1e4",   "productType": "Jackets",   "productImageType": "",   "productImageURL": "",   "quantityInHand": 29,   "cost": 22.84,   "price": 101  },  {   "inventoryId": 45497,   "itemNumber": "12GAGE",   "inventoryLocationId": 198,   "inventoryLocationName": "Pro Shop",   "description": ".12 Gauge",   "size": "",   "color": "",   "productType": "Ammo",   "productImageType": ".jpeg",   "productImageURL": "https://s3.us-west-2.amazonaws.com/images.ysrbs.com/dev/7103573600606403_12ga.jpeg",   "quantityInHand": 35,   "cost": 1.25,   "price": 3.14  } ], "errors": [], "message": "Success", "success": true}
Copy

Expand

Post a Sale

Using this API endpoint, users can post a sale in YellowStone for an inventory location.

Auth

Request Body

Parameter Body test

object	object
LocationID	integer	Inventory location ID for which the sale was performed
InventoryItem	array[object]	Array of sale inventory items
Price	integer	The price of the item that has been obtained from the GetInventoryItem endpoint.
InventoryId	integer	Inventory ID of the item
Quantity	integer	Number of quantities sold
PurchaseDate	date-time	Date and time of the sale
AmountReceived	number	Total amount received as part of the sale

POST /Sale/PostSale

xxxxxxxxxx
 
curl --request POST \ --url 'https://public-api.lodgeical.us/api/Sale/PostSale' \ --header 'Content-Type: multipart/form-data' \ --header 'x-api-key: {x-api-key}' \ --form 'file=@{file}'
Copy

Responses

200

No response body

Response

xxxxxxxxxx
 
{ "content": {  "identity": "Public API",  "clientId": 2000,  "subTotal": 0,  "taxes": 0,  "total": 0,  "totalDiscount": 0,  "totalServiceCharge": 0,  "tenderTypeIds": [],  "balanceDue": 0,  "locationId": 179,  "inventoryItem": [   {    "receiptId": "3880",    "reservationId": 0,    "guestId": 0,    "employeeId": 0,    "inventoryTypeCategoryId": 0,    "purchaseDate": "12/03/2023",    "inventoryId": 5699,    "cost": 200,    "price": 200,    "quantity": 1,    "tax": 0,    "tips": 0,    "isActive": false,    "isDeleted": false   }  ],  "paymentReceived": [   {    "receiveId": 1632,    "clientId": 0,    "reservationId": 0,    "inventoryTypeCategoryId": 0,    "amountReceived": 200,    "paymentMethodId": -4,    "paymentCategoryId": 0,    "feeId": 0,    "feeValue": 0,    "isGuestPayment": false   }  ],  "tabId": 0,  "isActive": false,  "showOnReceipt": false,  "totalTips": 0,  "isExternalPurchase": true,  "tipAmountReceived": [] }, "errors": [], "message": "Save inventory purchase successful.", "success": true}
Copy

Expand