PApax8
Products

List Products

Returns a paginated list of Pax8 products filtered by optional query parameters

get/products

Request

  • Base URL
    https://api.pax8.com/v1
  • URL
    https://api.pax8.com/v1/products
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://token-manager.pax8.com/oauth/token

Query parameters

pagenumber

The page number to request for in the products list

sizenumber

Return this number of products per page

sort'name' | 'vendor'

Return products sorted by the field and direction specified. Formatted as fieldName, direction - ex. sort=name,desc

searchstring
Example:Office 365

Search on fields like name, vendor, SKU and ID.

vendorNamestring
Example:Microsoft

Return only products matching the specified vendor name

Response

Successful operation

Example response

{
  "content": [
    {
      "name": "Acme Corps Productivity Suite",
      "vendorName": "Acme Corps",
      "shortDescription": "Short description about the product to sell",
      "sku": "4225-776-3234",
      "vendorSku": "12345-AA-XYZ"
    }
  ],
  "page": {
    "size": 50,
    "totalElements": 237,
    "totalPages": 5,
    "number": 1
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.