Retrieves all products.
query Parameters
includeDeletedbooleanDefault: false
Headers
skimmer-api-keystring · requiredThe
skimmer-api-keyheader is used to authenticate with the API using your API key. Value is of the formatYOUR_KEY_HERE.
Responses
OK
idstring · requiredThe product identifier.
isTaxableboolean · requiredIndicates that a resulting invoice line item will default to be taxable.
namestring · requiredThe product name.
deletedbooleanIndicates as to if the product is softly deleted.
createdAtstring · date-timeThe timestamp of record creation.
updatedAtstring · date-timeThe timestamp of last record update.
costnumber · doubleThe cost to the pool pro for the product.
defaultPricenumber · doubleThe default price applied when the product is added to a quote or invoice.
categoryobjectA category for the grouping of products
defaultDescriptionstring | nullThe default description applied when the product is added to a quote or invoice.
productCategoryIdstring | nullThe product category identifier.
Updates a product.
Headers
skimmer-api-keystring · requiredThe
skimmer-api-keyheader is used to authenticate with the API using your API key. Value is of the formatYOUR_KEY_HERE.
Request Body
idstring · requiredThe product identifier.
isTaxableboolean | null · requiredIndicates that a resulting invoice line item will default to be taxable.
namestring · requiredThe product name.
costnumber | null · doubleThe cost to the pool pro for the product.
defaultPricenumber | null · doubleThe default price applied when the product is added to a quote or invoice.
defaultDescriptionstring | nullThe default description applied when the product is added to a quote or invoice.
productCategoryIdstring | nullThe product category identifier.
Responses
OK
idstring · requiredThe product identifier.
isTaxableboolean · requiredIndicates that a resulting invoice line item will default to be taxable.
namestring · requiredThe product name.
deletedbooleanIndicates as to if the product is softly deleted.
createdAtstring · date-timeThe timestamp of record creation.
updatedAtstring · date-timeThe timestamp of last record update.
costnumber · doubleThe cost to the pool pro for the product.
defaultPricenumber · doubleThe default price applied when the product is added to a quote or invoice.
categoryobjectA category for the grouping of products
defaultDescriptionstring | nullThe default description applied when the product is added to a quote or invoice.
productCategoryIdstring | nullThe product category identifier.
Creates a new product.
Headers
skimmer-api-keystring · requiredThe
skimmer-api-keyheader is used to authenticate with the API using your API key. Value is of the formatYOUR_KEY_HERE.
Request Body
isTaxableboolean | null · requiredIndicates that a resulting invoice line item will default to be taxable.
namestring · requiredThe product name.
costnumber | null · doubleThe cost to the pool pro for the product.
defaultPricenumber | null · doubleThe default price applied when the product is added to a quote or invoice.
defaultDescriptionstring | nullThe default description applied when the product is added to a quote or invoice.
productCategoryIdstring | nullThe product category identifier.
Responses
Created
idstring · requiredThe product identifier.
isTaxableboolean · requiredIndicates that a resulting invoice line item will default to be taxable.
namestring · requiredThe product name.
deletedbooleanIndicates as to if the product is softly deleted.
createdAtstring · date-timeThe timestamp of record creation.
updatedAtstring · date-timeThe timestamp of last record update.
costnumber · doubleThe cost to the pool pro for the product.
defaultPricenumber · doubleThe default price applied when the product is added to a quote or invoice.
categoryobjectA category for the grouping of products
defaultDescriptionstring | nullThe default description applied when the product is added to a quote or invoice.
productCategoryIdstring | nullThe product category identifier.
Searches all products.
query Parameters
SortsstringComma-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
FiltersstringA comma-delimited list of property name, operator, value.Values: Id, Name, DefaultDescription, ProductCategoryId, DefaultPrice, IsTaxable, Spid, CreatedAt, UpdatedAt, Deleted
Pageinteger · int32The page number to return
PageSizeinteger · int32The number of items returned per page
Headers
skimmer-api-keystring · requiredThe
skimmer-api-keyheader is used to authenticate with the API using your API key. Value is of the formatYOUR_KEY_HERE.
Responses
OK
idstring · requiredThe product identifier.
isTaxableboolean · requiredIndicates that a resulting invoice line item will default to be taxable.
namestring · requiredThe product name.
deletedbooleanIndicates as to if the product is softly deleted.
createdAtstring · date-timeThe timestamp of record creation.
updatedAtstring · date-timeThe timestamp of last record update.
costnumber · doubleThe cost to the pool pro for the product.
defaultPricenumber · doubleThe default price applied when the product is added to a quote or invoice.
categoryobjectA category for the grouping of products
defaultDescriptionstring | nullThe default description applied when the product is added to a quote or invoice.
productCategoryIdstring | nullThe product category identifier.
Retrieves one product by ID.
path Parameters
idstring · required
query Parameters
includeDeletedbooleanDefault: false
Headers
skimmer-api-keystring · requiredThe
skimmer-api-keyheader is used to authenticate with the API using your API key. Value is of the formatYOUR_KEY_HERE.
Responses
OK
idstring · requiredThe product identifier.
isTaxableboolean · requiredIndicates that a resulting invoice line item will default to be taxable.
namestring · requiredThe product name.
deletedbooleanIndicates as to if the product is softly deleted.
createdAtstring · date-timeThe timestamp of record creation.
updatedAtstring · date-timeThe timestamp of last record update.
costnumber · doubleThe cost to the pool pro for the product.
defaultPricenumber · doubleThe default price applied when the product is added to a quote or invoice.
categoryobjectA category for the grouping of products
defaultDescriptionstring | nullThe default description applied when the product is added to a quote or invoice.
productCategoryIdstring | nullThe product category identifier.
Updates price data for the provided list of products.
Headers
skimmer-api-keystring · requiredThe
skimmer-api-keyheader is used to authenticate with the API using your API key. Value is of the formatYOUR_KEY_HERE.
Request Body
idstring · requiredThe product ID.
defaultPricenumber | null · doubleThe default price applied when the product is added to a quote or invoice.
Responses
No Content