Skimmer.PublicApi.Host | v1

ProductCategories

Endpoint:https://publicapi.getskimmer.com

Retrieves all product categories.

GET

https://publicapi.getskimmer.com

/ProductCategories

Retrieves all product categories. › query Parameters

includeDeletedboolean
Default: false

Retrieves all product categories. › Headers

skimmer-api-keystring · 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 product categories. › Responses

idstring · required
The product category identifier.
descriptionstring · required
The product category description.

deletedboolean
Indicates as to if the product category is softly deleted.
createdAtstring · date-time
The timestamp of record creation.
updatedAtstring · date-time
The timestamp of last record update.

Updates an existing product category.

PUT

https://publicapi.getskimmer.com

/ProductCategories

Updates an existing product category. › Headers

skimmer-api-keystring · 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 an existing product category. › Request Body

idstring · required
The product category identifier.
descriptionstring · required
The product category description.

Updates an existing product category. › Responses

idstring · required
The product category identifier.
descriptionstring · required
The product category description.

Creates a new product category.

POST

https://publicapi.getskimmer.com

/ProductCategories

Creates a new product category. › Headers

skimmer-api-keystring · 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 category. › Request Body

descriptionstring · required

Creates a new product category. › Responses

Created

idstring · required
The product category identifier.
descriptionstring · required
The product category description.

Searches all product categories.

GET

https://publicapi.getskimmer.com

/ProductCategories/search

Searches all product categories. › query Parameters

Sortsstring
Comma-delimited ordered list of property names to sort by. Adding - before the property name sorts in reverse order.Values: Id, Description, CreatedAt, UpdatedAt
Filtersstring
A comma-delimited list of property name, operator, value.Values: Id, Description, CreatedAt, UpdatedAt, Deleted
Pageinteger · int32
The page number to return
PageSizeinteger · int32
The number of items returned per page

Searches all product categories. › Headers

skimmer-api-keystring · 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 product categories. › Responses

idstring · required
The product category identifier.
descriptionstring · required
The product category description.

deletedboolean
Indicates as to if the product category is softly deleted.
createdAtstring · date-time
The timestamp of record creation.
updatedAtstring · date-time
The timestamp of last record update.

Retrieves one product category by ID.

GET

https://publicapi.getskimmer.com

/ProductCategories/{id}

Retrieves one product category by ID. › path Parameters

idstring · required

Retrieves one product category by ID. › query Parameters

includeDeletedboolean
Default: false

Retrieves one product category by ID. › Headers

skimmer-api-keystring · 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 category by ID. › Responses

idstring · required
The product category identifier.
descriptionstring · required
The product category description.

deletedboolean
Indicates as to if the product category is softly deleted.
createdAtstring · date-time
The timestamp of record creation.
updatedAtstring · date-time
The timestamp of last record update.

Deletes an existing product category.

DELETE

https://publicapi.getskimmer.com

/ProductCategories/{id}

Deletes an existing product category. › path Parameters

idstring · required

Deletes an existing product category. › Headers

skimmer-api-keystring · 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 category. › Responses

No Content

No data returned

Products Invoices

Retrieves all product categories.

GET

https://publicapi.getskimmer.com

/ProductCategories

Retrieves all product categories. › query Parameters

includeDeletedboolean
Default: false

Retrieves all product categories. › Headers

skimmer-api-keystring · 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 product categories. › Responses

idstring · required
The product category identifier.
descriptionstring · required
The product category description.

deletedboolean
Indicates as to if the product category is softly deleted.
createdAtstring · date-time
The timestamp of record creation.
updatedAtstring · date-time
The timestamp of last record update.

Updates an existing product category.

PUT

https://publicapi.getskimmer.com

/ProductCategories

Updates an existing product category. › Headers

skimmer-api-keystring · 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 an existing product category. › Request Body

idstring · required
The product category identifier.
descriptionstring · required
The product category description.

Updates an existing product category. › Responses

idstring · required
The product category identifier.
descriptionstring · required
The product category description.

Creates a new product category.

POST

https://publicapi.getskimmer.com

/ProductCategories

Creates a new product category. › Headers

skimmer-api-keystring · 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 category. › Request Body

descriptionstring · required

Creates a new product category. › Responses

Created

idstring · required
The product category identifier.
descriptionstring · required
The product category description.

Searches all product categories.

GET

https://publicapi.getskimmer.com

/ProductCategories/search

Searches all product categories. › query Parameters

Sortsstring
Comma-delimited ordered list of property names to sort by. Adding - before the property name sorts in reverse order.Values: Id, Description, CreatedAt, UpdatedAt
Filtersstring
A comma-delimited list of property name, operator, value.Values: Id, Description, CreatedAt, UpdatedAt, Deleted
Pageinteger · int32
The page number to return
PageSizeinteger · int32
The number of items returned per page

Searches all product categories. › Headers

skimmer-api-keystring · 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 product categories. › Responses

idstring · required
The product category identifier.
descriptionstring · required
The product category description.

deletedboolean
Indicates as to if the product category is softly deleted.
createdAtstring · date-time
The timestamp of record creation.
updatedAtstring · date-time
The timestamp of last record update.

Retrieves one product category by ID.

GET

https://publicapi.getskimmer.com

/ProductCategories/{id}

Retrieves one product category by ID. › path Parameters

idstring · required

Retrieves one product category by ID. › query Parameters

includeDeletedboolean
Default: false

Retrieves one product category by ID. › Headers

skimmer-api-keystring · 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 category by ID. › Responses

idstring · required
The product category identifier.
descriptionstring · required
The product category description.

deletedboolean
Indicates as to if the product category is softly deleted.
createdAtstring · date-time
The timestamp of record creation.
updatedAtstring · date-time
The timestamp of last record update.

Deletes an existing product category.

DELETE

https://publicapi.getskimmer.com

/ProductCategories/{id}

Deletes an existing product category. › path Parameters

idstring · required

Deletes an existing product category. › Headers

skimmer-api-keystring · 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 category. › Responses

No Content

No data returned