Settings Products

List Products

get

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

List of products

application/json

totalRowsnumberOptional

400

Bad Request

application/json

401

Not Authorized

application/json

500

Unexpected error

application/json

get/settings/products

HTTPcURLJavaScriptPython

GET /v2/settings/products HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalRows": 1,
  "rows": [
    {
      "id": "premium-paint",
      "label": "Premium Interior Paint",
      "active": true,
      "coverageRate": 400,
      "lnftCoverage": 0,
      "quantityCoverage": 1,
      "pricePerUnit": 65.99,
      "unit": "gallon",
      "quoteTypes": [
        "interior",
        "residential"
      ]
    }
  ]
}

Create Product

post

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

labelstringRequired

The display label of the product.

activebooleanOptional

Whether this product is active & usable

coverageRatenumberRequired

Square feet coverage per gallon (sqft/gal)

lnftCoveragenumberRequired

Linear feet coverage

quantityCoveragenumberRequired

Quantity coverage

pricePerUnitnumberOptional

Unit price per gallon ($/gal)

unitstringOptional

Measurement unit label

quoteTypesstring[]Optional

Quote types this product applies to

Responses

200

Successfully created product

application/json

idstringRequired

The unique ID of the product.

labelstringRequired

The display label of the product.

activebooleanOptional

Whether this product is active & usable

coverageRatenumberRequired

Square feet coverage per gallon (sqft/gal)

lnftCoveragenumberRequired

Linear feet coverage

quantityCoveragenumberRequired

Quantity coverage

pricePerUnitnumberOptional

Unit price per gallon ($/gal)

unitstringOptional

Measurement unit label

quoteTypesstring[]Optional

Quote types this product applies to

400

Bad Request

application/json

401

Not Authorized

application/json

409

Conflict - Product already exists

application/json

500

Unexpected error

application/json

post/settings/products

HTTPcURLJavaScriptPython

POST /v2/settings/products HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 182

{
  "label": "Premium Interior Paint",
  "active": true,
  "coverageRate": 400,
  "lnftCoverage": 0,
  "quantityCoverage": 1,
  "pricePerUnit": 65.99,
  "unit": "gallon",
  "quoteTypes": [
    "interior",
    "residential"
  ]
}

{
  "id": "premium-paint",
  "label": "Premium Interior Paint",
  "active": true,
  "coverageRate": 400,
  "lnftCoverage": 0,
  "quantityCoverage": 1,
  "pricePerUnit": 65.99,
  "unit": "gallon",
  "quoteTypes": [
    "interior",
    "residential"
  ]
}

Retrieve Product

get

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of the Product

Responses

200

Details about the product

application/json

idstringRequired

The unique ID of the product.

labelstringRequired

The display label of the product.

activebooleanOptional

Whether this product is active & usable

coverageRatenumberRequired

Square feet coverage per gallon (sqft/gal)

lnftCoveragenumberRequired

Linear feet coverage

quantityCoveragenumberRequired

Quantity coverage

pricePerUnitnumberOptional

Unit price per gallon ($/gal)

unitstringOptional

Measurement unit label

quoteTypesstring[]Optional

Quote types this product applies to

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

get/settings/products/{id}

HTTPcURLJavaScriptPython

GET /v2/settings/products/{id} HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "premium-paint",
  "label": "Premium Interior Paint",
  "active": true,
  "coverageRate": 400,
  "lnftCoverage": 0,
  "quantityCoverage": 1,
  "pricePerUnit": 65.99,
  "unit": "gallon",
  "quoteTypes": [
    "interior",
    "residential"
  ]
}

Update Product

put

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of the Product

Body

application/json

idstringRequired

The unique ID of the product.

labelstringRequired

The display label of the product.

activebooleanOptional

Whether this product is active & usable

coverageRatenumberRequired

Square feet coverage per gallon (sqft/gal)

lnftCoveragenumberRequired

Linear feet coverage

quantityCoveragenumberRequired

Quantity coverage

pricePerUnitnumberOptional

Unit price per gallon ($/gal)

unitstringOptional

Measurement unit label

quoteTypesstring[]Optional

Quote types this product applies to

Responses

200

Successfully updated product

application/json

idstringRequired

The unique ID of the product.

labelstringRequired

The display label of the product.

activebooleanOptional

Whether this product is active & usable

coverageRatenumberRequired

Square feet coverage per gallon (sqft/gal)

lnftCoveragenumberRequired

Linear feet coverage

quantityCoveragenumberRequired

Quantity coverage

pricePerUnitnumberOptional

Unit price per gallon ($/gal)

unitstringOptional

Measurement unit label

quoteTypesstring[]Optional

Quote types this product applies to

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

put/settings/products/{id}

HTTPcURLJavaScriptPython

PUT /v2/settings/products/{id} HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 203

{
  "id": "premium-paint",
  "label": "Premium Interior Paint",
  "active": true,
  "coverageRate": 400,
  "lnftCoverage": 0,
  "quantityCoverage": 1,
  "pricePerUnit": 65.99,
  "unit": "gallon",
  "quoteTypes": [
    "interior",
    "residential"
  ]
}

{
  "id": "premium-paint",
  "label": "Premium Interior Paint",
  "active": true,
  "coverageRate": 400,
  "lnftCoverage": 0,
  "quantityCoverage": 1,
  "pricePerUnit": 65.99,
  "unit": "gallon",
  "quoteTypes": [
    "interior",
    "residential"
  ]
}

Delete Product

delete

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of the Product

Responses

204

Product successfully deleted

No content

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

delete/settings/products/{id}

HTTPcURLJavaScriptPython

DELETE /v2/settings/products/{id} HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content