---
updatedAt: 2025-11-21T18:11:46.000Z
agentTools:
projectIndex: https://docs.staxpayments.com/llms.txt
---
# Retrieve All Catalog Items
Retrieves all the items saved under a merchant's catalog.
**Note**: Authentication Token, Active Team and Enabled Team Required.
Retrieves all the items saved under a merchant's catalog. The items may be searched using keywords, such as keywords\[]=red, to find specific items. The items may also be filtered and sorted.
### Sort Parameters
| Parameter | Description |
| :----------- | :---------------------------------------------------------------------- |
| name | Sorts the items alphabetically by name. |
| code | Sorts by item code numerically. |
| description | Sorts items alphabetically by description. |
| price | Sorts the items numerically by price. |
| quantity | Sorts the items numerically by quantity. |
| is\_service | Sorts the items between those that are a service and those that aren't. |
| is\_active | Sorts items into active and inactive categories. |
| is\_taxable | Sorts the items between those that are taxable and those that aren't. |
| is\_discount | Sorts items into those on discount and those not on discount. |
| created\_at | Sorts chronologically based on the times items were created. |
| updated\_at | Sorts chronologically based on the last time items were updated. |
### Order Parameters
| Parameter | Description |
| :-------- | :-------------------------------------- |
| DESC | Displays results in a descending order. |
| ASC | Displays results in an ascending order. |
# OpenAPI definition
```json
{
"openapi": "3.1.0",
"info": {
"title": "stax-api",
"version": "0.1"
},
"servers": [
{
"url": "https://apiprod.fattlabs.com/"
}
],
"components": {
"securitySchemes": {
"ApiKeyAuth": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT",
"description": "API key for merchant-level operations. Provides access to merchant-specific endpoints including transactions, payments, customer management, and merchant account settings. This key is scoped to a single merchant account and cannot access partner-level functionality."
}
}
},
"security": [
{
"ApiKeyAuth": []
}
],
"paths": {
"/item": {
"get": {
"summary": "Retrieve All Catalog Items",
"description": "Retrieves all the items saved under a merchant's catalog.",
"operationId": "retrieve-all-catalog-items",
"parameters": [
{
"name": "code",
"in": "query",
"description": "Filter by items of the exact code",
"schema": {
"type": "string"
}
},
{
"name": "price",
"in": "query",
"description": "Filters by items of the exact price.",
"schema": {
"type": "number",
"format": "float"
}
},
{
"name": "quantity",
"in": "query",
"description": "Filters by items of the exact quantity.",
"schema": {
"type": "string"
}
},
{
"name": "is_service",
"in": "query",
"description": "Filters for services.",
"schema": {
"type": "boolean"
}
},
{
"name": "is_active",
"in": "query",
"description": "Filters for active items.",
"schema": {
"type": "boolean"
}
},
{
"name": "is_taxable",
"in": "query",
"description": "Filters for taxable items.",
"schema": {
"type": "boolean"
}
},
{
"name": "is_discount",
"in": "query",
"description": "Filters if the item is discounted or not.",
"schema": {
"type": "boolean"
}
},
{
"name": "user_id",
"in": "query",
"schema": {
"type": "string"
},
"description": "Filters by user id."
},
{
"name": "name",
"in": "query",
"schema": {
"type": "string"
},
"description": "Filters out any items that don't share the inputted name. Does not have to be exact."
},
{
"name": "description",
"in": "query",
"schema": {
"type": "string"
},
"description": "Filters by part of description."
},
{
"name": "meta",
"in": "query",
"schema": {
"type": "string"
},
"description": "Filters by meta. Does not have to be exact."
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"total\": 2,\n \"per_page\": 25,\n \"current_page\": 1,\n \"last_page\": 1,\n \"next_page_url\": null,\n \"prev_page_url\": null,\n \"from\": 1,\n \"to\": 2,\n \"data\": [\n {\n \"id\": \"79256d84-3930-4e4b-bc71-9c6587cfc65c\",\n \"user_id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"merchant_id\": \"dd36b936-1eb7-4ece-bebc-b514c6a36ebd\",\n \"thumbnail_id\": null,\n \"item\": \"meeseeks\",\n \"code\": \"aaaa\",\n \"details\": \"just a test item\",\n \"is_active\": true,\n \"is_taxable\": false,\n \"is_service\": false,\n \"is_discount\": false,\n \"price\": 7.11,\n \"in_stock\": 0,\n \"meta\": [],\n \"created_at\": \"2017-05-05 19:49:21\",\n \"updated_at\": \"2017-05-05 19:49:21\",\n \"deleted_at\": null,\n \"deprecation_warning\": \"The name and decription fiels will be deprecated on 7/1/17\",\n \"user\": {\n \"id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"system_admin\": false,\n \"name\": \"Test Guy\",\n \"email\": \"contact@example.com\",\n \"email_verification_sent_at\": \"2017-03-29 15:27:19\",\n \"email_verified_at\": \"2017-03-29 15:27:21\",\n \"is_api_key\": false,\n \"created_at\": \"2017-01-11 21:44:02\",\n \"updated_at\": \"2017-04-24 15:41:58\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/157965dea7cd2f44e349382d1d791650\",\n \"team_admin\": null,\n \"team_enabled\": null,\n \"team_role\": null\n },\n \"files\": [],\n \"thumbnail\": null\n },\n {\n \"id\": \"62c6c812-36e6-4037-9569-caa1dfe968de\",\n \"user_id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"merchant_id\": \"dd36b936-1eb7-4ece-bebc-b514c6a36ebd\",\n \"thumbnail_id\": null,\n \"item\": \"Meeseeks Box\",\n \"code\": null,\n \"details\": null,\n \"is_active\": true,\n \"is_taxable\": false,\n \"is_service\": true,\n \"is_discount\": true,\n \"price\": 55,\n \"in_stock\": 0,\n \"meta\": [],\n \"created_at\": \"2017-05-05 19:55:05\",\n \"updated_at\": \"2017-05-05 19:55:06\",\n \"deleted_at\": null,\n \"deprecation_warning\": \"The name and decription fiels will be deprecated on 7/1/17\",\n \"user\": {\n \"id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"system_admin\": false,\n \"name\": \"test guy\",\n \"email\": \"contact@example.com\",\n \"email_verification_sent_at\": \"2017-03-29 15:27:19\",\n \"email_verified_at\": \"2017-03-29 15:27:21\",\n \"is_api_key\": false,\n \"created_at\": \"2017-01-11 21:44:02\",\n \"updated_at\": \"2017-04-24 15:41:58\",\n \"deleted_at\": null,\n \"gravatar\": \"//www.gravatar.com/avatar/157965dea7cd2f44e349382d1d791650\",\n \"team_admin\": null,\n \"team_enabled\": null,\n \"team_role\": null\n },\n \"files\": [\n {\n \"id\": \"cc5d4376-8a76-4de1-8fc1-b9135be5f26f\",\n \"merchant_id\": \"dd36b936-1eb7-4ece-bebc-b514c6a36ebd\",\n \"user_id\": \"b58d7eee-e68d-4d12-a1f8-62f5e71382ae\",\n \"name\": \"meeseeks.png\",\n \"public_url\": \"https://s3-us-west-2.amazonaws.com/fattpaydocuments/cc5d4376-8a76-4de1-8fc1-b9135be5f26f.png\",\n \"tag\": null,\n \"meta\": {\n \"filesize_bytes\": 14181,\n \"filesize\": \"0.14 kB\",\n \"extension\": \"png\",\n \"size\": {\n \"width\": 128,\n \"height\": 128\n },\n \"mime\": \"image/png\"\n },\n \"created_at\": \"2017-05-05 19:55:00\",\n \"updated_at\": \"2017-05-05 19:55:01\",\n \"deleted_at\": null\n }\n ],\n \"thumbnail\": null\n }\n ]\n}"
}
},
"schema": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"example": 2,
"default": 0
},
"per_page": {
"type": "integer",
"example": 25,
"default": 0
},
"current_page": {
"type": "integer",
"example": 1,
"default": 0
},
"last_page": {
"type": "integer",
"example": 1,
"default": 0
},
"next_page_url": {},
"prev_page_url": {},
"from": {
"type": "integer",
"example": 1,
"default": 0
},
"to": {
"type": "integer",
"example": 2,
"default": 0
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "79256d84-3930-4e4b-bc71-9c6587cfc65c"
},
"user_id": {
"type": "string",
"example": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae"
},
"merchant_id": {
"type": "string",
"example": "dd36b936-1eb7-4ece-bebc-b514c6a36ebd"
},
"thumbnail_id": {},
"item": {
"type": "string",
"example": "meeseeks"
},
"code": {
"type": "string",
"example": "aaaa"
},
"details": {
"type": "string",
"example": "just a test item"
},
"is_active": {
"type": "boolean",
"example": true,
"default": true
},
"is_taxable": {
"type": "boolean",
"example": false,
"default": true
},
"is_service": {
"type": "boolean",
"example": false,
"default": true
},
"is_discount": {
"type": "boolean",
"example": false,
"default": true
},
"price": {
"type": "number",
"example": 7.11,
"default": 0
},
"in_stock": {
"type": "integer",
"example": 0,
"default": 0
},
"meta": {
"type": "array"
},
"created_at": {
"type": "string",
"example": "2017-05-05 19:49:21"
},
"updated_at": {
"type": "string",
"example": "2017-05-05 19:49:21"
},
"deleted_at": {},
"deprecation_warning": {
"type": "string",
"example": "The name and decription fiels will be deprecated on 7/1/17"
},
"user": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "b58d7eee-e68d-4d12-a1f8-62f5e71382ae"
},
"system_admin": {
"type": "boolean",
"example": false,
"default": true
},
"name": {
"type": "string",
"example": "Test Guy"
},
"email": {
"type": "string",
"example": "contact@example.com"
},
"email_verification_sent_at": {
"type": "string",
"example": "2017-03-29 15:27:19"
},
"email_verified_at": {
"type": "string",
"example": "2017-03-29 15:27:21"
},
"is_api_key": {
"type": "boolean",
"example": false,
"default": true
},
"created_at": {
"type": "string",
"example": "2017-01-11 21:44:02"
},
"updated_at": {
"type": "string",
"example": "2017-04-24 15:41:58"
},
"deleted_at": {},
"gravatar": {
"type": "string",
"example": "//www.gravatar.com/avatar/157965dea7cd2f44e349382d1d791650"
},
"team_admin": {},
"team_enabled": {},
"team_role": {}
}
},
"files": {
"type": "array"
},
"thumbnail": {}
}
}
}
}
}
}
}
},
"422": {
"description": "422",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"sort\": [\n \"The selected sort is invalid.\"\n ],\n \"order\": [\n \"The selected order is invalid.\"\n ],\n \"is_active\": [\n \"The is active field must be true or false.\"\n ]\n}"
}
},
"schema": {
"type": "object",
"properties": {
"sort": {
"type": "array",
"items": {
"type": "string",
"example": "The selected sort is invalid."
}
},
"order": {
"type": "array",
"items": {
"type": "string",
"example": "The selected order is invalid."
}
},
"is_active": {
"type": "array",
"items": {
"type": "string",
"example": "The is active field must be true or false."
}
}
}
}
}
}
}
},
"deprecated": false
}
}
},
"x-readme": {
"headers": [],
"explorer-enabled": true,
"proxy-enabled": true
},
"x-readme-fauxas": true
}
```