Retrieves all products.
query Parameters
includeDeletedHeaders
skimmer-api-keyThe skimmer-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.
Retrieves all products. › Responses
OK
idThe product identifier.
isTaxableIndicates that a resulting invoice line item will default to be taxable.
nameThe product name.
deletedIndicates as to if the product is softly deleted.
createdAtThe timestamp of record creation.
updatedAtThe timestamp of last record update.
costThe cost to the pool pro for the product.
defaultPriceThe default price applied when the product is added to a quote or invoice.
A category for the grouping of products
defaultDescriptionThe default description applied when the product is added to a quote or invoice.
productCategoryIdThe product category identifier.
Updates a product.
Headers
skimmer-api-keyThe skimmer-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.
Updates a product. › Request Body
idThe product identifier.
isTaxableIndicates that a resulting invoice line item will default to be taxable.
nameThe product name.
costThe cost to the pool pro for the product.
defaultPriceThe default price applied when the product is added to a quote or invoice.
defaultDescriptionThe default description applied when the product is added to a quote or invoice.
productCategoryIdThe product category identifier.
Updates a product. › Responses
OK
idThe product identifier.
isTaxableIndicates that a resulting invoice line item will default to be taxable.
nameThe product name.
deletedIndicates as to if the product is softly deleted.
createdAtThe timestamp of record creation.
updatedAtThe timestamp of last record update.
costThe cost to the pool pro for the product.
defaultPriceThe default price applied when the product is added to a quote or invoice.
A category for the grouping of products
defaultDescriptionThe default description applied when the product is added to a quote or invoice.
productCategoryIdThe product category identifier.
Creates a new product.
Headers
skimmer-api-keyThe skimmer-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.
Creates a new product. › Request Body
isTaxableIndicates that a resulting invoice line item will default to be taxable.
nameThe product name.
costThe cost to the pool pro for the product.
defaultPriceThe default price applied when the product is added to a quote or invoice.
defaultDescriptionThe default description applied when the product is added to a quote or invoice.
productCategoryIdThe product category identifier.
Creates a new product. › Responses
Created
idThe product identifier.
isTaxableIndicates that a resulting invoice line item will default to be taxable.
nameThe product name.
deletedIndicates as to if the product is softly deleted.
createdAtThe timestamp of record creation.
updatedAtThe timestamp of last record update.
costThe cost to the pool pro for the product.
defaultPriceThe default price applied when the product is added to a quote or invoice.
A category for the grouping of products
defaultDescriptionThe default description applied when the product is added to a quote or invoice.
productCategoryIdThe product category identifier.
Searches all products.
query Parameters
SortsComma-delimited ordered list of property names to sort by. Adding - before the property name sorts in reverse order.Values: Id, Name, DefaultPrice, Spid, CreatedAt, UpdatedAt
FiltersA comma-delimited list of property name, operator, value.Values: Id, Name, DefaultDescription, ProductCategoryId, DefaultPrice, IsTaxable, Spid, CreatedAt, UpdatedAt, Deleted
PageThe page number to return
PageSizeThe number of items returned per page
Headers
skimmer-api-keyThe skimmer-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.
Searches all products. › Responses
OK
idThe product identifier.
isTaxableIndicates that a resulting invoice line item will default to be taxable.
nameThe product name.
deletedIndicates as to if the product is softly deleted.
createdAtThe timestamp of record creation.
updatedAtThe timestamp of last record update.
costThe cost to the pool pro for the product.
defaultPriceThe default price applied when the product is added to a quote or invoice.
A category for the grouping of products
defaultDescriptionThe default description applied when the product is added to a quote or invoice.
productCategoryIdThe product category identifier.
Retrieves one product by ID.
path Parameters
idquery Parameters
includeDeletedHeaders
skimmer-api-keyThe skimmer-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.
Retrieves one product by ID. › Responses
OK
idThe product identifier.
isTaxableIndicates that a resulting invoice line item will default to be taxable.
nameThe product name.
deletedIndicates as to if the product is softly deleted.
createdAtThe timestamp of record creation.
updatedAtThe timestamp of last record update.
costThe cost to the pool pro for the product.
defaultPriceThe default price applied when the product is added to a quote or invoice.
A category for the grouping of products
defaultDescriptionThe default description applied when the product is added to a quote or invoice.
productCategoryIdThe product category identifier.
Updates price data for the provided list of products.
Headers
skimmer-api-keyThe skimmer-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.
Updates price data for the provided list of products. › Request Body
idThe product ID.
defaultPriceThe default price applied when the product is added to a quote or invoice.
Updates price data for the provided list of products. › Responses
No Content