Management API
Product

List Products

5min

Show all products the requesting manager has access permissions to.

URL: /api/v1/products/

Method: GET

Query Parameters:

Ordering:

  • order_by - Which attribute to order the list by.
    • default ordering is ascending, can be made descending by prefixing the attribute name with -
    • Example: order_by=created_at
    • Example: order_by=-created_at

Pagination:

Default pagination is 20 results per page.

  • limit - Number of results to return per page.
    • Example: limit=20
  • offset - The initial index from which to return the results.
    • Example: offset=21

Filtering:

The results can be filtered by various attributes on product or related to the product.

Possible filters:

  • is_archived
  • short_code
  • is_bundle
  • metadata

Success Response:

Code: 200 OK

Content Examples:

JSON