Get all products

GET 
/api/v2/catalog/products

Retrieve all the products for a given business

Request

Query Parameters

business_id string
Limit results to a specific business
Example: cd9feea7-99f4-4e90-897f-8b4f7cac8c59
menu_id string
Limit results to products linked to a specific menu
Example: 4lj8y3ygw1w0
available boolean
Filter products on whether they are available
Example: true

Responses

200

application/json

Schema

Schema

• Array [

id stringrequired

Possible values: >= 12 characters and <= 12 characters, Value must match regular expression ^[0-9a-z]+$

Unique ID of the product

category_id stringrequired

Category ID of the product

section_id stringrequired

Section ID of the product

name stringrequired

Possible values: non-empty

Name of the product

slug stringrequired

Possible values: non-empty

Slug of the product

description stringrequired

Description of the product

sku stringnullable

The SKU of the product

ref_code stringnullable

The reference code of the product

photo_url urinullable

The photo URL of the product

price +decimalrequired

The price of the product

available booleanrequired

Default value: true

Mark the product as not available

order integerrequired

Default value: 0

Used to order the item, order defaults to ascending.

created_at date-timerequired
updated_at date-timerequired

• ]

Example (from schema)

[
  {
    "id": "bk8h0y2r68ke",
    "category_id": "5m4v972ra9ue",
    "section_id": "u7m4f8ep5nfi",
    "name": "Pizza",
    "slug": "pizza",
    "description": "A delicious pizza",
    "sku": "123456",
    "ref_code": "123456",
    "photo_url": "https://example.com/photo.jpg",
    "price": "12.5",
    "available": true,
    "order": 1,
    "created_at": "2024-07-29T15:51:28.071Z",
    "updated_at": "2024-07-29T15:51:28.071Z"
  }
]

400

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

401

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

403

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

404

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

422

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

location stringrequired

Possible values: [query, body, response, param]

Where in the request the error occurred

errors

object[]

required

Array [

path stringrequired

Possible values: non-empty

Path to the property with the error

constraints

object

required

property name* string

Error message

]

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "location": "query",
  "errors": [
    {
      "path": "business.id",
      "constraints": {
        "object_required_property": "Required property"
      }
    }
  ]
}

500

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

Loading...