Skimmer.PublicApi.Host | v1

ProductCategories

Endpointhttps://publicapi.getskimmer.com

Retrieves all product categories.

GET

https://publicapi.getskimmer.com

/ProductCategories

Retrieves all product categories. › query Parameters

includeDeleted

boolean

Default: false

Retrieves all product categories. › 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 product categories. › Responses

object[]

A category for the grouping of products

id

string · required

The product category identifier.

description

string · required

The product category description.

deleted

boolean

Indicates as to if the product category is softly deleted.

createdAt

string · date-time

The timestamp of record creation.

updatedAt

string · date-time

The timestamp of last record update.

GET/ProductCategories

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

shell

Example Responses

[
  {
    "id": "id",
    "deleted": true,
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "description": "description"
  }
]

plain

Updates an existing product category.

PUT

https://publicapi.getskimmer.com

/ProductCategories

Updates an existing product category. › 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 an existing product category. › Request Body

A request to update an existing product category.

id

string · required

The product category identifier.

description

string · required

The product category description.

Updates an existing product category. › Responses

A request to update an existing product category.

id

string · required

The product category identifier.

description

string · required

The product category description.

PUT/ProductCategories

curl --request PUT \
  --url https://publicapi.getskimmer.com/ProductCategories \
  --header 'Content-Type: application/json' \
  --header 'skimmer-api-key: <string>' \
  --data '
{
  "id": "id",
  "description": "description"
}
'

shell

Example Request Body

{
  "id": "id",
  "description": "description"
}

json

Example Responses

{
  "id": "id",
  "description": "description"
}

plain

Creates a new product category.

POST

https://publicapi.getskimmer.com

/ProductCategories

Creates a new product category. › 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 category. › Request Body

A request to create a new product category.

description

string · required

Creates a new product category. › Responses

Created

A request to update an existing product category.

id

string · required

The product category identifier.

description

string · required

The product category description.

POST/ProductCategories

curl --request POST \
  --url https://publicapi.getskimmer.com/ProductCategories \
  --header 'Content-Type: application/json' \
  --header 'skimmer-api-key: <string>' \
  --data '
{
  "description": "description"
}
'

shell

Example Request Body

{
  "description": "description"
}

json

Example Responses

{
  "id": "id",
  "description": "description"
}

plain

Searches all product categories.

GET

https://publicapi.getskimmer.com

/ProductCategories/search

Searches all product categories. › 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, Description, CreatedAt, UpdatedAt

Filters

string

A comma-delimited list of property name, operator, value.Values: Id, Description, CreatedAt, UpdatedAt, Deleted

Page

integer · int32

The page number to return

PageSize

integer · int32

The number of items returned per page

Searches all product categories. › 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 product categories. › Responses

object[]

A category for the grouping of products

id

string · required

The product category identifier.

description

string · required

The product category description.

deleted

boolean

Indicates as to if the product category is softly deleted.

createdAt

string · date-time

The timestamp of record creation.

updatedAt

string · date-time

The timestamp of last record update.

GET/ProductCategories/search

curl --request GET \
  --url https://publicapi.getskimmer.com/ProductCategories/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",
    "description": "description"
  }
]

plain

Retrieves one product category by ID.

GET

https://publicapi.getskimmer.com

/ProductCategories/{id}

Retrieves one product category by ID. › path Parameters

id

string · required

Retrieves one product category by ID. › query Parameters

includeDeleted

boolean

Default: false

Retrieves one product category 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 category by ID. › Responses

A category for the grouping of products

id

string · required

The product category identifier.

description

string · required

The product category description.

deleted

boolean

Indicates as to if the product category is softly deleted.

createdAt

string · date-time

The timestamp of record creation.

updatedAt

string · date-time

The timestamp of last record update.

GET/ProductCategories/{id}

curl --request GET \
  --url https://publicapi.getskimmer.com/ProductCategories/: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",
  "description": "description"
}

plain

Deletes an existing product category.

DELETE

https://publicapi.getskimmer.com

/ProductCategories/{id}

Deletes an existing product category. › path Parameters

id

string · required

Deletes an existing product category. › 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 category. › Responses

No Content

No data returned

DELETE/ProductCategories/{id}

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

shell

Example Responses

No example specified for this content type

Products LeadSources

Skimmer.PublicApi.Host | v1

ProductCategories

Endpointhttps://publicapi.getskimmer.com

Retrieves all product categories.

GET

https://publicapi.getskimmer.com

/ProductCategories

Retrieves all product categories. › query Parameters

includeDeleted

boolean

Default: false

Retrieves all product categories. › 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 product categories. › Responses

object[]

A category for the grouping of products

id

string · required

The product category identifier.

description

string · required

The product category description.

deleted

boolean

Indicates as to if the product category is softly deleted.

createdAt

string · date-time

The timestamp of record creation.

updatedAt

string · date-time

The timestamp of last record update.

GET/ProductCategories

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

shell

Example Responses

[
  {
    "id": "id",
    "deleted": true,
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "description": "description"
  }
]

plain

Updates an existing product category.

PUT

https://publicapi.getskimmer.com

/ProductCategories

Updates an existing product category. › 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 an existing product category. › Request Body

A request to update an existing product category.

id

string · required

The product category identifier.

description

string · required

The product category description.

Updates an existing product category. › Responses

A request to update an existing product category.

id

string · required

The product category identifier.

description

string · required

The product category description.

PUT/ProductCategories

curl --request PUT \
  --url https://publicapi.getskimmer.com/ProductCategories \
  --header 'Content-Type: application/json' \
  --header 'skimmer-api-key: <string>' \
  --data '
{
  "id": "id",
  "description": "description"
}
'

shell

Example Request Body

{
  "id": "id",
  "description": "description"
}

json

Example Responses

{
  "id": "id",
  "description": "description"
}

plain

Creates a new product category.

POST

https://publicapi.getskimmer.com

/ProductCategories

Creates a new product category. › 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 category. › Request Body

A request to create a new product category.

description

string · required

Creates a new product category. › Responses

Created

A request to update an existing product category.

id

string · required

The product category identifier.

description

string · required

The product category description.

POST/ProductCategories

curl --request POST \
  --url https://publicapi.getskimmer.com/ProductCategories \
  --header 'Content-Type: application/json' \
  --header 'skimmer-api-key: <string>' \
  --data '
{
  "description": "description"
}
'

shell

Example Request Body

{
  "description": "description"
}

json

Example Responses

{
  "id": "id",
  "description": "description"
}

plain

Searches all product categories.

GET

https://publicapi.getskimmer.com

/ProductCategories/search

Searches all product categories. › 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, Description, CreatedAt, UpdatedAt

Filters

string

A comma-delimited list of property name, operator, value.Values: Id, Description, CreatedAt, UpdatedAt, Deleted

Page

integer · int32

The page number to return

PageSize

integer · int32

The number of items returned per page

Searches all product categories. › 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 product categories. › Responses

object[]

A category for the grouping of products

id

string · required

The product category identifier.

description

string · required

The product category description.

deleted

boolean

Indicates as to if the product category is softly deleted.

createdAt

string · date-time

The timestamp of record creation.

updatedAt

string · date-time

The timestamp of last record update.

GET/ProductCategories/search

curl --request GET \
  --url https://publicapi.getskimmer.com/ProductCategories/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",
    "description": "description"
  }
]

plain

Retrieves one product category by ID.

GET

https://publicapi.getskimmer.com

/ProductCategories/{id}

Retrieves one product category by ID. › path Parameters

id

string · required

Retrieves one product category by ID. › query Parameters

includeDeleted

boolean

Default: false

Retrieves one product category 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 category by ID. › Responses

A category for the grouping of products

id

string · required

The product category identifier.

description

string · required

The product category description.

deleted

boolean

Indicates as to if the product category is softly deleted.

createdAt

string · date-time

The timestamp of record creation.

updatedAt

string · date-time

The timestamp of last record update.

GET/ProductCategories/{id}

curl --request GET \
  --url https://publicapi.getskimmer.com/ProductCategories/: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",
  "description": "description"
}

plain

Deletes an existing product category.

DELETE

https://publicapi.getskimmer.com

/ProductCategories/{id}

Deletes an existing product category. › path Parameters

id

string · required

Deletes an existing product category. › 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 category. › Responses

No Content

No data returned

DELETE/ProductCategories/{id}

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

shell

Example Responses

No example specified for this content type

Products LeadSources