Skip to main content
GET
Get items

Endpoint

GET /items Production URL: https://sam.aragon.morabaa.com/api/items

Authentication

This endpoint requires app authentication headers:
  • X-App-Id: <APP_ID>
  • X-App-Secret: <APP_SECRET>

Required headers

string
required
App ID credential.
string
required
App secret credential.
Need credentials? Contact info@morabaa.com.
If either is invalid or missing, the response is 401 Unauthorized. Do not send Content-Type: application/json for this GET request. Only include a Content-Type header when the request has a JSON body.

Request example

Query parameters

All query parameters are optional.
string
Filter by item name.
string
Filter by barcode.
guid
Filter by business ID. If omitted, the first business ID from the authenticated app is used.
guid
Filter by group ID.
decimal
Minimum buy price.
decimal
Maximum buy price.
decimal
Minimum sell price.
decimal
Maximum sell price.
int
Buy currency ID.
int
Sell currency ID.
bool
Include exchange currency context when true.
string
General text search.
int
Page size. Defaults to 25, clamped to 1..100.
int
Skip count. Defaults to 0 and never below 0.
Notes:
  • businessId must belong to the authenticated app if it is supplied.
  • A successful response returns 200 OK.

Response

The response type is an array of items:
guid
Item ID.
guid
Business ID associated with the item.
string
Item name.
array
Barcodes associated with the item.
object
Buy price and currency details.
object
Sell price and currency details.
decimal
Available quantity.
array
Package options and package-level prices.
object
Store details keyed by store identifier.
array
Quantity movement details.

Headers

X-App-Id
string
required

App ID credential.

X-App-Secret
string
required

App secret credential.

Query Parameters

name
string

Filter by item name.

barcode
string

Filter by barcode.

businessId
string<uuid>

Filter by business ID. If omitted, the first business ID from the authenticated app is used.

groupId
string<uuid>

Filter by group ID.

minBuyPrice
number<decimal>

Minimum buy price.

maxBuyPrice
number<decimal>

Maximum buy price.

minSellPrice
number<decimal>

Minimum sell price.

maxSellPrice
number<decimal>

Maximum sell price.

buyCurrencyId
integer

Buy currency ID.

sellCurrencyId
integer

Sell currency ID.

exchangeCurrency
boolean

Include exchange currency context when true.

query
string

General text search.

limit
integer
default:25

Page size. Defaults to 25, clamped to 1..100.

Required range: 1 <= x <= 100
offset
integer
default:0

Skip count. Defaults to 0 and never below 0.

Required range: x >= 0

Response

Items returned successfully.