Products

Retrieves all products.

GET

https://publicapi.getskimmer.com

/Products

Retrieves all products. › query Parameters

includeDeleted

boolean

Default: false

Retrieves all products. › Headers

skimmer-api-key

string · required

The 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

object[]

id

string · required

The product identifier.

isTaxable

boolean · required

Indicates that a resulting invoice line item will default to be taxable.

name

string · required

The product name.

deleted

boolean

Indicates as to if the product is softly deleted.

createdAt

string · date-time

The timestamp of record creation.

updatedAt

string · date-time

The timestamp of last record update.

cost

number · double

The cost to the pool pro for the product.

defaultPrice

number · double

The default price applied when the product is added to a quote or invoice.

heritagePartNumber

string | null

The Heritage part number - sourced from the Heritage product extension.

markupType

string · enum

The markup type used to calculate the default price from cost.

Enum values:

None

FixedAmount

Percent

fixedAmountMarkup

number · double

The fixed amount markup added to cost when MarkupType is FixedAmount.

percentMarkup

number · double

The percent markup applied to cost when MarkupType is Percent.

isDiscontinued

boolean

Indicates whether the product has been discontinued.

object

A category for the grouping of products

defaultDescription

string | null

The default description applied when the product is added to a quote or invoice.

productCategoryId

string | null

The product category identifier.

manufacturerSku

string | null

The manufacturer SKU / part number.

GET/Products

curl --request GET \
  --url https://publicapi.getskimmer.com/Products \
  --header 'skimmer-api-key: <string>'

shell

Example Responses

[
  {
    "id": "id",
    "deleted": true,
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "cost": 0,
    "defaultPrice": 0,
    "isTaxable": true,
    "heritagePartNumber": "heritagePartNumber",
    "markupType": "None",
    "fixedAmountMarkup": 0,
    "percentMarkup": 0,
    "isDiscontinued": true,
    "category": {
      "id": "id",
      "deleted": true,
      "createdAt": "2024-08-25T15:00:00Z",
      "updatedAt": "2024-08-25T15:00:00Z",
      "description": "description"
    },
    "name": "name",
    "defaultDescription": "defaultDescription",
    "productCategoryId": "productCategoryId",
    "manufacturerSku": "manufacturerSku"
  }
]

text

Updates a product.

PUT

https://publicapi.getskimmer.com

/Products

Updates a product. › Headers

skimmer-api-key

string · required

The 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

id

string · required

The product identifier.

isTaxable

boolean | null · required

Indicates that a resulting invoice line item will default to be taxable.

name

string · required

The product name.

cost

number | null · double

The cost to the pool pro for the product.

defaultPrice

number | null · double

The default price applied when the product is added to a quote or invoice.

markupType

string | null · enum

The markup type used to calculate the default price from cost.

Enum values:

None

FixedAmount

Percent

fixedAmountMarkup

number | null · double

The fixed amount markup added to cost when MarkupType is FixedAmount.

percentMarkup

number | null · double

The percent markup applied to cost when MarkupType is Percent.

isDiscontinued

boolean | null

Indicates whether the product has been discontinued.

defaultDescription

string | null

The default description applied when the product is added to a quote or invoice.

productCategoryId

string | null

The product category identifier.

manufacturerSku

string | null

The manufacturer SKU / part number.

Updates a product. › Responses

id

string · required

The product identifier.

isTaxable

boolean · required

Indicates that a resulting invoice line item will default to be taxable.

name

string · required

The product name.

deleted

boolean

Indicates as to if the product is softly deleted.

createdAt

string · date-time

The timestamp of record creation.

updatedAt

string · date-time

The timestamp of last record update.

cost

number · double

The cost to the pool pro for the product.

defaultPrice

number · double

The default price applied when the product is added to a quote or invoice.

heritagePartNumber

string | null

The Heritage part number - sourced from the Heritage product extension.

markupType

string · enum

The markup type used to calculate the default price from cost.

Enum values:

None

FixedAmount

Percent

fixedAmountMarkup

number · double

The fixed amount markup added to cost when MarkupType is FixedAmount.

percentMarkup

number · double

The percent markup applied to cost when MarkupType is Percent.

isDiscontinued

boolean

Indicates whether the product has been discontinued.

object

A category for the grouping of products

defaultDescription

string | null

The default description applied when the product is added to a quote or invoice.

productCategoryId

string | null

The product category identifier.

manufacturerSku

string | null

The manufacturer SKU / part number.

PUT/Products

curl --request PUT \
  --url https://publicapi.getskimmer.com/Products \
  --header 'Content-Type: application/json' \
  --header 'skimmer-api-key: <string>' \
  --data '
{
  "id": "id",
  "cost": 0,
  "defaultPrice": 0,
  "isTaxable": true,
  "markupType": "None",
  "fixedAmountMarkup": 0,
  "percentMarkup": 0,
  "isDiscontinued": true,
  "name": "name",
  "defaultDescription": "defaultDescription",
  "productCategoryId": "productCategoryId",
  "manufacturerSku": "manufacturerSku"
}
'

shell

Example Request Body

{
  "id": "id",
  "cost": 0,
  "defaultPrice": 0,
  "isTaxable": true,
  "markupType": "None",
  "fixedAmountMarkup": 0,
  "percentMarkup": 0,
  "isDiscontinued": true,
  "name": "name",
  "defaultDescription": "defaultDescription",
  "productCategoryId": "productCategoryId",
  "manufacturerSku": "manufacturerSku"
}

json

Example Responses

{
  "id": "id",
  "deleted": true,
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z",
  "cost": 0,
  "defaultPrice": 0,
  "isTaxable": true,
  "heritagePartNumber": "heritagePartNumber",
  "markupType": "None",
  "fixedAmountMarkup": 0,
  "percentMarkup": 0,
  "isDiscontinued": true,
  "category": {
    "id": "id",
    "deleted": true,
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "description": "description"
  },
  "name": "name",
  "defaultDescription": "defaultDescription",
  "productCategoryId": "productCategoryId",
  "manufacturerSku": "manufacturerSku"
}

text

Creates a new product.

POST

https://publicapi.getskimmer.com

/Products

Creates a new product. › Headers

skimmer-api-key

string · required

The 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

isTaxable

boolean | null · required

Indicates that a resulting invoice line item will default to be taxable.

name

string · required

The product name.

cost

number | null · double

The cost to the pool pro for the product.

defaultPrice

number | null · double

The default price applied when the product is added to a quote or invoice.

markupType

string | null · enum

The markup type used to calculate the default price from cost.

Enum values:

None

FixedAmount

Percent

fixedAmountMarkup

number | null · double

The fixed amount markup added to cost when MarkupType is FixedAmount.

percentMarkup

number | null · double

The percent markup applied to cost when MarkupType is Percent.

isDiscontinued

boolean | null

Indicates whether the product has been discontinued.

defaultDescription

string | null

The default description applied when the product is added to a quote or invoice.

productCategoryId

string | null

The product category identifier.

manufacturerSku

string | null

The manufacturer SKU / part number.

Creates a new product. › Responses

Created

id

string · required

The product identifier.

isTaxable

boolean · required

Indicates that a resulting invoice line item will default to be taxable.

name

string · required

The product name.

deleted

boolean

Indicates as to if the product is softly deleted.

createdAt

string · date-time

The timestamp of record creation.

updatedAt

string · date-time

The timestamp of last record update.

cost

number · double

The cost to the pool pro for the product.

defaultPrice

number · double

The default price applied when the product is added to a quote or invoice.

heritagePartNumber

string | null

The Heritage part number - sourced from the Heritage product extension.

markupType

string · enum

The markup type used to calculate the default price from cost.

Enum values:

None

FixedAmount

Percent

fixedAmountMarkup

number · double

The fixed amount markup added to cost when MarkupType is FixedAmount.

percentMarkup

number · double

The percent markup applied to cost when MarkupType is Percent.

isDiscontinued

boolean

Indicates whether the product has been discontinued.

object

A category for the grouping of products

defaultDescription

string | null

The default description applied when the product is added to a quote or invoice.

productCategoryId

string | null

The product category identifier.

manufacturerSku

string | null

The manufacturer SKU / part number.

POST/Products

curl --request POST \
  --url https://publicapi.getskimmer.com/Products \
  --header 'Content-Type: application/json' \
  --header 'skimmer-api-key: <string>' \
  --data '
{
  "cost": 0,
  "defaultPrice": 0,
  "isTaxable": true,
  "markupType": "None",
  "fixedAmountMarkup": 0,
  "percentMarkup": 0,
  "isDiscontinued": true,
  "name": "name",
  "defaultDescription": "defaultDescription",
  "productCategoryId": "productCategoryId",
  "manufacturerSku": "manufacturerSku"
}
'

shell

Example Request Body

{
  "cost": 0,
  "defaultPrice": 0,
  "isTaxable": true,
  "markupType": "None",
  "fixedAmountMarkup": 0,
  "percentMarkup": 0,
  "isDiscontinued": true,
  "name": "name",
  "defaultDescription": "defaultDescription",
  "productCategoryId": "productCategoryId",
  "manufacturerSku": "manufacturerSku"
}

json

Example Responses

{
  "id": "id",
  "deleted": true,
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z",
  "cost": 0,
  "defaultPrice": 0,
  "isTaxable": true,
  "heritagePartNumber": "heritagePartNumber",
  "markupType": "None",
  "fixedAmountMarkup": 0,
  "percentMarkup": 0,
  "isDiscontinued": true,
  "category": {
    "id": "id",
    "deleted": true,
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "description": "description"
  },
  "name": "name",
  "defaultDescription": "defaultDescription",
  "productCategoryId": "productCategoryId",
  "manufacturerSku": "manufacturerSku"
}

text

Searches all products.

GET

https://publicapi.getskimmer.com

/Products/search

Searches all products. › query Parameters

Sorts

string

Comma-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, ManufacturerSku, IsDiscontinued

Filters

string

A comma-delimited list of property name, operator, value.Values: Id, Name, DefaultDescription, ProductCategoryId, DefaultPrice, IsTaxable, Spid, CreatedAt, UpdatedAt, Deleted, ManufacturerSku, IsDiscontinued, HeritagePartNumber

Page

integer · int32

The page number to return

PageSize

integer · int32

The number of items returned per page

Searches all products. › Headers

skimmer-api-key

string · required

The 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

object[]

id

string · required

The product identifier.

isTaxable

boolean · required

Indicates that a resulting invoice line item will default to be taxable.

name

string · required

The product name.

deleted

boolean

Indicates as to if the product is softly deleted.

createdAt

string · date-time

The timestamp of record creation.

updatedAt

string · date-time

The timestamp of last record update.

cost

number · double

The cost to the pool pro for the product.

defaultPrice

number · double

The default price applied when the product is added to a quote or invoice.

heritagePartNumber

string | null

The Heritage part number - sourced from the Heritage product extension.

markupType

string · enum

The markup type used to calculate the default price from cost.

Enum values:

None

FixedAmount

Percent

fixedAmountMarkup

number · double

The fixed amount markup added to cost when MarkupType is FixedAmount.

percentMarkup

number · double

The percent markup applied to cost when MarkupType is Percent.

isDiscontinued

boolean

Indicates whether the product has been discontinued.

object

A category for the grouping of products

defaultDescription

string | null

The default description applied when the product is added to a quote or invoice.

productCategoryId

string | null

The product category identifier.

manufacturerSku

string | null

The manufacturer SKU / part number.

GET/Products/search

curl --request GET \
  --url https://publicapi.getskimmer.com/Products/search \
  --header 'skimmer-api-key: <string>'

shell

Example Responses

[
  {
    "id": "id",
    "deleted": true,
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "cost": 0,
    "defaultPrice": 0,
    "isTaxable": true,
    "heritagePartNumber": "heritagePartNumber",
    "markupType": "None",
    "fixedAmountMarkup": 0,
    "percentMarkup": 0,
    "isDiscontinued": true,
    "category": {
      "id": "id",
      "deleted": true,
      "createdAt": "2024-08-25T15:00:00Z",
      "updatedAt": "2024-08-25T15:00:00Z",
      "description": "description"
    },
    "name": "name",
    "defaultDescription": "defaultDescription",
    "productCategoryId": "productCategoryId",
    "manufacturerSku": "manufacturerSku"
  }
]

text

Retrieves one product by ID.

GET

https://publicapi.getskimmer.com

/Products/{id}

Retrieves one product by ID. › path Parameters

id

string · required

Retrieves one product by ID. › query Parameters

includeDeleted

boolean

Default: false

Retrieves one product by ID. › Headers

skimmer-api-key

string · required

The 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

id

string · required

The product identifier.

isTaxable

boolean · required

Indicates that a resulting invoice line item will default to be taxable.

name

string · required

The product name.

deleted

boolean

Indicates as to if the product is softly deleted.

createdAt

string · date-time

The timestamp of record creation.

updatedAt

string · date-time

The timestamp of last record update.

cost

number · double

The cost to the pool pro for the product.

defaultPrice

number · double

The default price applied when the product is added to a quote or invoice.

heritagePartNumber

string | null

The Heritage part number - sourced from the Heritage product extension.

markupType

string · enum

The markup type used to calculate the default price from cost.

Enum values:

None

FixedAmount

Percent

fixedAmountMarkup

number · double

The fixed amount markup added to cost when MarkupType is FixedAmount.

percentMarkup

number · double

The percent markup applied to cost when MarkupType is Percent.

isDiscontinued

boolean

Indicates whether the product has been discontinued.

object

A category for the grouping of products

defaultDescription

string | null

The default description applied when the product is added to a quote or invoice.

productCategoryId

string | null

The product category identifier.

manufacturerSku

string | null

The manufacturer SKU / part number.

GET/Products/{id}

curl --request GET \
  --url https://publicapi.getskimmer.com/Products/:id \
  --header 'skimmer-api-key: <string>'

shell

Example Responses

{
  "id": "id",
  "deleted": true,
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z",
  "cost": 0,
  "defaultPrice": 0,
  "isTaxable": true,
  "heritagePartNumber": "heritagePartNumber",
  "markupType": "None",
  "fixedAmountMarkup": 0,
  "percentMarkup": 0,
  "isDiscontinued": true,
  "category": {
    "id": "id",
    "deleted": true,
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "description": "description"
  },
  "name": "name",
  "defaultDescription": "defaultDescription",
  "productCategoryId": "productCategoryId",
  "manufacturerSku": "manufacturerSku"
}

text

Deletes an existing product.

DELETE

https://publicapi.getskimmer.com

/Products/{id}

Deletes an existing product. › path Parameters

id

string · required

Deletes an existing product. › Headers

skimmer-api-key

string · required

The skimmer-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Deletes an existing product. › Responses

No Content

No data returned

Updates price data for the provided list of products.

PUT

https://publicapi.getskimmer.com

/Products/prices

Updates price data for the provided list of products. › Headers

skimmer-api-key

string · required

The 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

object[]

id

string · required

The product ID.

defaultPrice

number | null · double

The 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

No data returned

Quotes ProductCategories

Skimmer.PublicApi.Host | v1

Products

Retrieves all products.

GET

https://publicapi.getskimmer.com

/Products

Retrieves all products. › query Parameters

includeDeleted

boolean

Default: false

Retrieves all products. › Headers

skimmer-api-key

string · required

The 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

object[]

id

string · required

The product identifier.

isTaxable

boolean · required

Indicates that a resulting invoice line item will default to be taxable.

name

string · required

The product name.

deleted

boolean

Indicates as to if the product is softly deleted.

createdAt

string · date-time

The timestamp of record creation.

updatedAt

string · date-time

The timestamp of last record update.

cost

number · double

The cost to the pool pro for the product.

defaultPrice

number · double

The default price applied when the product is added to a quote or invoice.

heritagePartNumber

string | null

The Heritage part number - sourced from the Heritage product extension.

markupType

string · enum

The markup type used to calculate the default price from cost.

Enum values:

None

FixedAmount

Percent

fixedAmountMarkup

number · double

The fixed amount markup added to cost when MarkupType is FixedAmount.

percentMarkup

number · double

The percent markup applied to cost when MarkupType is Percent.

isDiscontinued

boolean

Indicates whether the product has been discontinued.

object

A category for the grouping of products

defaultDescription

string | null

The default description applied when the product is added to a quote or invoice.

productCategoryId

string | null

The product category identifier.

manufacturerSku

string | null

The manufacturer SKU / part number.

GET/Products

curl --request GET \
  --url https://publicapi.getskimmer.com/Products \
  --header 'skimmer-api-key: <string>'

shell

Example Responses

[
  {
    "id": "id",
    "deleted": true,
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "cost": 0,
    "defaultPrice": 0,
    "isTaxable": true,
    "heritagePartNumber": "heritagePartNumber",
    "markupType": "None",
    "fixedAmountMarkup": 0,
    "percentMarkup": 0,
    "isDiscontinued": true,
    "category": {
      "id": "id",
      "deleted": true,
      "createdAt": "2024-08-25T15:00:00Z",
      "updatedAt": "2024-08-25T15:00:00Z",
      "description": "description"
    },
    "name": "name",
    "defaultDescription": "defaultDescription",
    "productCategoryId": "productCategoryId",
    "manufacturerSku": "manufacturerSku"
  }
]

text

Updates a product.

PUT

https://publicapi.getskimmer.com

/Products

Updates a product. › Headers

skimmer-api-key

string · required

The 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

id

string · required

The product identifier.

isTaxable

boolean | null · required

Indicates that a resulting invoice line item will default to be taxable.

name

string · required

The product name.

cost

number | null · double

The cost to the pool pro for the product.

defaultPrice

number | null · double

The default price applied when the product is added to a quote or invoice.

markupType

string | null · enum

The markup type used to calculate the default price from cost.

Enum values:

None

FixedAmount

Percent

fixedAmountMarkup

number | null · double

The fixed amount markup added to cost when MarkupType is FixedAmount.

percentMarkup

number | null · double

The percent markup applied to cost when MarkupType is Percent.

isDiscontinued

boolean | null

Indicates whether the product has been discontinued.

defaultDescription

string | null

The default description applied when the product is added to a quote or invoice.

productCategoryId

string | null

The product category identifier.

manufacturerSku

string | null

The manufacturer SKU / part number.

Updates a product. › Responses

id

string · required

The product identifier.

isTaxable

boolean · required

Indicates that a resulting invoice line item will default to be taxable.

name

string · required

The product name.

deleted

boolean

Indicates as to if the product is softly deleted.

createdAt

string · date-time

The timestamp of record creation.

updatedAt

string · date-time

The timestamp of last record update.

cost

number · double

The cost to the pool pro for the product.

defaultPrice

number · double

The default price applied when the product is added to a quote or invoice.

heritagePartNumber

string | null

The Heritage part number - sourced from the Heritage product extension.

markupType

string · enum

The markup type used to calculate the default price from cost.

Enum values:

None

FixedAmount

Percent

fixedAmountMarkup

number · double

The fixed amount markup added to cost when MarkupType is FixedAmount.

percentMarkup

number · double

The percent markup applied to cost when MarkupType is Percent.

isDiscontinued

boolean

Indicates whether the product has been discontinued.

object

A category for the grouping of products

defaultDescription

string | null

The default description applied when the product is added to a quote or invoice.

productCategoryId

string | null

The product category identifier.

manufacturerSku

string | null

The manufacturer SKU / part number.

PUT/Products

curl --request PUT \
  --url https://publicapi.getskimmer.com/Products \
  --header 'Content-Type: application/json' \
  --header 'skimmer-api-key: <string>' \
  --data '
{
  "id": "id",
  "cost": 0,
  "defaultPrice": 0,
  "isTaxable": true,
  "markupType": "None",
  "fixedAmountMarkup": 0,
  "percentMarkup": 0,
  "isDiscontinued": true,
  "name": "name",
  "defaultDescription": "defaultDescription",
  "productCategoryId": "productCategoryId",
  "manufacturerSku": "manufacturerSku"
}
'

shell

Example Request Body

{
  "id": "id",
  "cost": 0,
  "defaultPrice": 0,
  "isTaxable": true,
  "markupType": "None",
  "fixedAmountMarkup": 0,
  "percentMarkup": 0,
  "isDiscontinued": true,
  "name": "name",
  "defaultDescription": "defaultDescription",
  "productCategoryId": "productCategoryId",
  "manufacturerSku": "manufacturerSku"
}

json

Example Responses

{
  "id": "id",
  "deleted": true,
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z",
  "cost": 0,
  "defaultPrice": 0,
  "isTaxable": true,
  "heritagePartNumber": "heritagePartNumber",
  "markupType": "None",
  "fixedAmountMarkup": 0,
  "percentMarkup": 0,
  "isDiscontinued": true,
  "category": {
    "id": "id",
    "deleted": true,
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "description": "description"
  },
  "name": "name",
  "defaultDescription": "defaultDescription",
  "productCategoryId": "productCategoryId",
  "manufacturerSku": "manufacturerSku"
}

text

Creates a new product.

POST

https://publicapi.getskimmer.com

/Products

Creates a new product. › Headers

skimmer-api-key

string · required

The 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

isTaxable

boolean | null · required

Indicates that a resulting invoice line item will default to be taxable.

name

string · required

The product name.

cost

number | null · double

The cost to the pool pro for the product.

defaultPrice

number | null · double

The default price applied when the product is added to a quote or invoice.

markupType

string | null · enum

The markup type used to calculate the default price from cost.

Enum values:

None

FixedAmount

Percent

fixedAmountMarkup

number | null · double

The fixed amount markup added to cost when MarkupType is FixedAmount.

percentMarkup

number | null · double

The percent markup applied to cost when MarkupType is Percent.

isDiscontinued

boolean | null

Indicates whether the product has been discontinued.

defaultDescription

string | null

The default description applied when the product is added to a quote or invoice.

productCategoryId

string | null

The product category identifier.

manufacturerSku

string | null

The manufacturer SKU / part number.

Creates a new product. › Responses

Created

id

string · required

The product identifier.

isTaxable

boolean · required

Indicates that a resulting invoice line item will default to be taxable.

name

string · required

The product name.

deleted

boolean

Indicates as to if the product is softly deleted.

createdAt

string · date-time

The timestamp of record creation.

updatedAt

string · date-time

The timestamp of last record update.

cost

number · double

The cost to the pool pro for the product.

defaultPrice

number · double

The default price applied when the product is added to a quote or invoice.

heritagePartNumber

string | null

The Heritage part number - sourced from the Heritage product extension.

markupType

string · enum

The markup type used to calculate the default price from cost.

Enum values:

None

FixedAmount

Percent

fixedAmountMarkup

number · double

The fixed amount markup added to cost when MarkupType is FixedAmount.

percentMarkup

number · double

The percent markup applied to cost when MarkupType is Percent.

isDiscontinued

boolean

Indicates whether the product has been discontinued.

object

A category for the grouping of products

defaultDescription

string | null

The default description applied when the product is added to a quote or invoice.

productCategoryId

string | null

The product category identifier.

manufacturerSku

string | null

The manufacturer SKU / part number.

POST/Products

curl --request POST \
  --url https://publicapi.getskimmer.com/Products \
  --header 'Content-Type: application/json' \
  --header 'skimmer-api-key: <string>' \
  --data '
{
  "cost": 0,
  "defaultPrice": 0,
  "isTaxable": true,
  "markupType": "None",
  "fixedAmountMarkup": 0,
  "percentMarkup": 0,
  "isDiscontinued": true,
  "name": "name",
  "defaultDescription": "defaultDescription",
  "productCategoryId": "productCategoryId",
  "manufacturerSku": "manufacturerSku"
}
'

shell

Example Request Body

{
  "cost": 0,
  "defaultPrice": 0,
  "isTaxable": true,
  "markupType": "None",
  "fixedAmountMarkup": 0,
  "percentMarkup": 0,
  "isDiscontinued": true,
  "name": "name",
  "defaultDescription": "defaultDescription",
  "productCategoryId": "productCategoryId",
  "manufacturerSku": "manufacturerSku"
}

json

Example Responses

{
  "id": "id",
  "deleted": true,
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z",
  "cost": 0,
  "defaultPrice": 0,
  "isTaxable": true,
  "heritagePartNumber": "heritagePartNumber",
  "markupType": "None",
  "fixedAmountMarkup": 0,
  "percentMarkup": 0,
  "isDiscontinued": true,
  "category": {
    "id": "id",
    "deleted": true,
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "description": "description"
  },
  "name": "name",
  "defaultDescription": "defaultDescription",
  "productCategoryId": "productCategoryId",
  "manufacturerSku": "manufacturerSku"
}

text

Searches all products.

GET

https://publicapi.getskimmer.com

/Products/search

Searches all products. › query Parameters

Sorts

string

Filters

string

Page

integer · int32

The page number to return

PageSize

integer · int32

The number of items returned per page

Searches all products. › Headers

skimmer-api-key

string · required

The 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

object[]

id

string · required

The product identifier.

isTaxable

boolean · required

Indicates that a resulting invoice line item will default to be taxable.

name

string · required

The product name.

deleted

boolean

Indicates as to if the product is softly deleted.

createdAt

string · date-time

The timestamp of record creation.

updatedAt

string · date-time

The timestamp of last record update.

cost

number · double

The cost to the pool pro for the product.

defaultPrice

number · double

The default price applied when the product is added to a quote or invoice.

heritagePartNumber

string | null

The Heritage part number - sourced from the Heritage product extension.

markupType

string · enum

The markup type used to calculate the default price from cost.

Enum values:

None

FixedAmount

Percent

fixedAmountMarkup

number · double

The fixed amount markup added to cost when MarkupType is FixedAmount.

percentMarkup

number · double

The percent markup applied to cost when MarkupType is Percent.

isDiscontinued

boolean

Indicates whether the product has been discontinued.

object

A category for the grouping of products

defaultDescription

string | null

The default description applied when the product is added to a quote or invoice.

productCategoryId

string | null

The product category identifier.

manufacturerSku

string | null

The manufacturer SKU / part number.

GET/Products/search

curl --request GET \
  --url https://publicapi.getskimmer.com/Products/search \
  --header 'skimmer-api-key: <string>'

shell

Example Responses

[
  {
    "id": "id",
    "deleted": true,
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "cost": 0,
    "defaultPrice": 0,
    "isTaxable": true,
    "heritagePartNumber": "heritagePartNumber",
    "markupType": "None",
    "fixedAmountMarkup": 0,
    "percentMarkup": 0,
    "isDiscontinued": true,
    "category": {
      "id": "id",
      "deleted": true,
      "createdAt": "2024-08-25T15:00:00Z",
      "updatedAt": "2024-08-25T15:00:00Z",
      "description": "description"
    },
    "name": "name",
    "defaultDescription": "defaultDescription",
    "productCategoryId": "productCategoryId",
    "manufacturerSku": "manufacturerSku"
  }
]

text

Retrieves one product by ID.

GET

https://publicapi.getskimmer.com

/Products/{id}

Retrieves one product by ID. › path Parameters

id

string · required

Retrieves one product by ID. › query Parameters

includeDeleted

boolean

Default: false

Retrieves one product by ID. › Headers

skimmer-api-key

string · required

The 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

id

string · required

The product identifier.

isTaxable

boolean · required

Indicates that a resulting invoice line item will default to be taxable.

name

string · required

The product name.

deleted

boolean

Indicates as to if the product is softly deleted.

createdAt

string · date-time

The timestamp of record creation.

updatedAt

string · date-time

The timestamp of last record update.

cost

number · double

The cost to the pool pro for the product.

defaultPrice

number · double

The default price applied when the product is added to a quote or invoice.

heritagePartNumber

string | null

The Heritage part number - sourced from the Heritage product extension.

markupType

string · enum

The markup type used to calculate the default price from cost.

Enum values:

None

FixedAmount

Percent

fixedAmountMarkup

number · double

The fixed amount markup added to cost when MarkupType is FixedAmount.

percentMarkup

number · double

The percent markup applied to cost when MarkupType is Percent.

isDiscontinued

boolean

Indicates whether the product has been discontinued.

object

A category for the grouping of products

defaultDescription

string | null

The default description applied when the product is added to a quote or invoice.

productCategoryId

string | null

The product category identifier.

manufacturerSku

string | null

The manufacturer SKU / part number.

GET/Products/{id}

curl --request GET \
  --url https://publicapi.getskimmer.com/Products/:id \
  --header 'skimmer-api-key: <string>'

shell

Example Responses

{
  "id": "id",
  "deleted": true,
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z",
  "cost": 0,
  "defaultPrice": 0,
  "isTaxable": true,
  "heritagePartNumber": "heritagePartNumber",
  "markupType": "None",
  "fixedAmountMarkup": 0,
  "percentMarkup": 0,
  "isDiscontinued": true,
  "category": {
    "id": "id",
    "deleted": true,
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "description": "description"
  },
  "name": "name",
  "defaultDescription": "defaultDescription",
  "productCategoryId": "productCategoryId",
  "manufacturerSku": "manufacturerSku"
}

text

Deletes an existing product.

DELETE

https://publicapi.getskimmer.com

/Products/{id}

Deletes an existing product. › path Parameters

id

string · required

Deletes an existing product. › Headers

skimmer-api-key

string · required

The skimmer-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Deletes an existing product. › Responses

No Content

No data returned

Updates price data for the provided list of products.

PUT

https://publicapi.getskimmer.com

/Products/prices

Updates price data for the provided list of products. › Headers

skimmer-api-key

string · required

The 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

object[]

id

string · required

The product ID.

defaultPrice

number | null · double

The 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

No data returned

Quotes ProductCategories