Skip to main content

Get products by section

GET 

https://api.staging.powerapi.com/api/v2/catalog/sections/products

Returns products grouped by their section

Queries can use the slugs instead of the IDs. When searching by category slug, you must provide the business_id.

Request

Query Parameters

    business_id string

    Limit results to a specific business

    category_id string

    Filter sections by a specific category

    menu_id string

    Filter sections and products by a menu

    available boolean

    Filter products on whether they are available

Responses

Schema
  • Array [
  • id stringrequired

    Unique ID of the section

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

    Example: u7m4f8ep5nfi
    name stringrequired

    Name of the section

    Possible values: non-empty

    Example: Pizza
    slug stringrequired

    Slug of the section

    Possible values: non-empty

    Example: pizza
    order integerrequired

    Used to order the item, order defaults to ascending.

    Default value: 0
    Example: 1
    created_at date-timerequired
    updated_at date-timerequired
    products object[]required
  • Array [
  • id stringrequired

    Unique ID of the product

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

    Example: bk8h0y2r68ke
    category_id stringrequired

    Category ID of the product

    Example: 5m4v972ra9ue
    section_id stringrequired

    Section ID of the product

    Example: u7m4f8ep5nfi
    name stringrequired

    Name of the product

    Possible values: non-empty

    Example: Pizza
    slug stringrequired

    Slug of the product

    Possible values: non-empty

    Example: pizza
    description stringrequired

    Description of the product

    Example: A delicious pizza
    sku stringnullable

    The SKU of the product

    Example: 123456
    ref_code stringnullable

    The reference code of the product

    Example: 123456
    photo_url urinullable

    The photo URL of the product

    Example: https://example.com/photo.jpg
    price +decimalrequired

    The price of the product

    Example: 12.5
    available booleanrequired

    Mark the product as not available

    Default value: true
    order integerrequired

    Used to order the item, order defaults to ascending.

    Default value: 0
    Example: 1
    created_at date-timerequired
    updated_at date-timerequired
  • ]
  • ]

Authorization: http

name: bearertype: httpscheme: bearerbearerFormat: JWT
curl -L 'https://api.staging.powerapi.com/api/v2/catalog/sections/products' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
Request Collapse all
Base URL
https://api.staging.powerapi.com
Auth
Parameters
— query
— query
— query
— query
ResponseClear

Click the Send API Request button above and see the response here!