SalesOS

Price Books

Price book management

Get all price books

GET
/v1/price-books

Authorization

AuthorizationRequiredBearer <token>

Session token from the SalesOS web app.

In: header

X-API-Key<token>

API key from Settings → API Keys. Authorization: ApiKey <key> is also accepted. Each operation lists the scope it needs under x-api-key-scopes.

In: header

Query Parameters

isActiveboolean
isStandardboolean
currencystring
curl -X GET "https://api.salesos.org/v1/price-books?isActive=true&isStandard=true&currency=%3Cstring%3E" \
  -H "Authorization: Bearer <token>"

[
  {}
]

Create a new price book

POST
/v1/price-books

Authorization

AuthorizationRequiredBearer <token>

Session token from the SalesOS web app.

In: header

X-API-Key<token>

API key from Settings → API Keys. Authorization: ApiKey <key> is also accepted. Each operation lists the scope it needs under x-api-key-scopes.

In: header

Request Body

application/jsonRequired
nameRequiredstring

Price book name

descriptionstring

Description

currencystring

Currency code

Default: "USD"
isStandardboolean

Is this the standard price book

validFromstring

Valid from date

validTostring

Valid to date

Header Parameters

Idempotency-Keystring

Unique key (a UUID is ideal) that makes this write safe to retry for 24 hours: a retry with the same body replays the original response (Idempotent-Replayed: true); the same key with a different body is a 409.

Maximum length: 255
curl -X POST "https://api.salesos.org/v1/price-books" \
  -H "Idempotency-Key: <string>" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "description": "string",
    "currency": "USD",
    "isStandard": true,
    "validFrom": "string",
    "validTo": "string"
  }'

{}

Get the standard price book

GET
/v1/price-books/standard

Authorization

AuthorizationRequiredBearer <token>

Session token from the SalesOS web app.

In: header

X-API-Key<token>

API key from Settings → API Keys. Authorization: ApiKey <key> is also accepted. Each operation lists the scope it needs under x-api-key-scopes.

In: header

curl -X GET "https://api.salesos.org/v1/price-books/standard" \
  -H "Authorization: Bearer <token>"

{}

Get price book statistics

GET
/v1/price-books/stats

Authorization

AuthorizationRequiredBearer <token>

Session token from the SalesOS web app.

In: header

X-API-Key<token>

API key from Settings → API Keys. Authorization: ApiKey <key> is also accepted. Each operation lists the scope it needs under x-api-key-scopes.

In: header

curl -X GET "https://api.salesos.org/v1/price-books/stats" \
  -H "Authorization: Bearer <token>"

Get a price book by ID

GET
/v1/price-books/{id}

Authorization

AuthorizationRequiredBearer <token>

Session token from the SalesOS web app.

In: header

X-API-Key<token>

API key from Settings → API Keys. Authorization: ApiKey <key> is also accepted. Each operation lists the scope it needs under x-api-key-scopes.

In: header

Path Parameters

idRequiredstring
curl -X GET "https://api.salesos.org/v1/price-books/<string>" \
  -H "Authorization: Bearer <token>"

{}

Update a price book

PATCH
/v1/price-books/{id}

Authorization

AuthorizationRequiredBearer <token>

Session token from the SalesOS web app.

In: header

X-API-Key<token>

API key from Settings → API Keys. Authorization: ApiKey <key> is also accepted. Each operation lists the scope it needs under x-api-key-scopes.

In: header

Request Body

application/jsonRequired
namestring

Price book name

descriptionstring

Description

currencystring

Currency code

isActiveboolean

Is active

validFromstring

Valid from date

validTostring

Valid to date

Path Parameters

idRequiredstring

Header Parameters

Idempotency-Keystring

Unique key (a UUID is ideal) that makes this write safe to retry for 24 hours: a retry with the same body replays the original response (Idempotent-Replayed: true); the same key with a different body is a 409.

Maximum length: 255
curl -X PATCH "https://api.salesos.org/v1/price-books/<string>" \
  -H "Idempotency-Key: <string>" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "description": "string",
    "currency": "string",
    "isActive": true,
    "validFrom": "string",
    "validTo": "string"
  }'

{}

Clone a price book

POST
/v1/price-books/{id}/clone

Authorization

AuthorizationRequiredBearer <token>

Session token from the SalesOS web app.

In: header

X-API-Key<token>

API key from Settings → API Keys. Authorization: ApiKey <key> is also accepted. Each operation lists the scope it needs under x-api-key-scopes.

In: header

Request Body

application/jsonRequired

Path Parameters

idRequiredstring

Header Parameters

Idempotency-Keystring

Unique key (a UUID is ideal) that makes this write safe to retry for 24 hours: a retry with the same body replays the original response (Idempotent-Replayed: true); the same key with a different body is a 409.

Maximum length: 255
curl -X POST "https://api.salesos.org/v1/price-books/<string>/clone" \
  -H "Idempotency-Key: <string>" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{}'

{}

Get all entries in a price book

GET
/v1/price-books/{id}/entries

Authorization

AuthorizationRequiredBearer <token>

Session token from the SalesOS web app.

In: header

X-API-Key<token>

API key from Settings → API Keys. Authorization: ApiKey <key> is also accepted. Each operation lists the scope it needs under x-api-key-scopes.

In: header

Path Parameters

idRequiredstring
curl -X GET "https://api.salesos.org/v1/price-books/<string>/entries" \
  -H "Authorization: Bearer <token>"

Add a product entry to price book

POST
/v1/price-books/{id}/entries

Authorization

AuthorizationRequiredBearer <token>

Session token from the SalesOS web app.

In: header

X-API-Key<token>

API key from Settings → API Keys. Authorization: ApiKey <key> is also accepted. Each operation lists the scope it needs under x-api-key-scopes.

In: header

Request Body

application/jsonRequired
productIdRequiredstring

Product ID

listPriceRequirednumber

List price

unitPricenumber

Unit price override

minQuantitynumber

Minimum quantity

Default: 1
discountTiersarray<string>

Discount tiers array

Path Parameters

idRequiredstring

Header Parameters

Idempotency-Keystring

Unique key (a UUID is ideal) that makes this write safe to retry for 24 hours: a retry with the same body replays the original response (Idempotent-Replayed: true); the same key with a different body is a 409.

Maximum length: 255
curl -X POST "https://api.salesos.org/v1/price-books/<string>/entries" \
  -H "Idempotency-Key: <string>" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "productId": "string",
    "listPrice": 0,
    "unitPrice": 0,
    "minQuantity": 1,
    "discountTiers": [
      "string"
    ]
  }'

Add multiple product entries to price book

POST
/v1/price-books/{id}/entries/bulk

Authorization

AuthorizationRequiredBearer <token>

Session token from the SalesOS web app.

In: header

X-API-Key<token>

API key from Settings → API Keys. Authorization: ApiKey <key> is also accepted. Each operation lists the scope it needs under x-api-key-scopes.

In: header

Request Body

application/jsonRequired

Path Parameters

idRequiredstring

Header Parameters

Idempotency-Keystring

Unique key (a UUID is ideal) that makes this write safe to retry for 24 hours: a retry with the same body replays the original response (Idempotent-Replayed: true); the same key with a different body is a 409.

Maximum length: 255
curl -X POST "https://api.salesos.org/v1/price-books/<string>/entries/bulk" \
  -H "Idempotency-Key: <string>" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{}'

Update a price book entry

PATCH
/v1/price-books/{id}/entries/{entryId}

Authorization

AuthorizationRequiredBearer <token>

Session token from the SalesOS web app.

In: header

X-API-Key<token>

API key from Settings → API Keys. Authorization: ApiKey <key> is also accepted. Each operation lists the scope it needs under x-api-key-scopes.

In: header

Request Body

application/jsonRequired
listPricenumber

List price

unitPricenumber

Unit price override

minQuantitynumber

Minimum quantity

discountTiersarray<string>

Discount tiers array

isActiveboolean

Is active

Path Parameters

idRequiredstring
entryIdRequiredstring

Header Parameters

Idempotency-Keystring

Unique key (a UUID is ideal) that makes this write safe to retry for 24 hours: a retry with the same body replays the original response (Idempotent-Replayed: true); the same key with a different body is a 409.

Maximum length: 255
curl -X PATCH "https://api.salesos.org/v1/price-books/<string>/entries/<string>" \
  -H "Idempotency-Key: <string>" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "listPrice": 0,
    "unitPrice": 0,
    "minQuantity": 0,
    "discountTiers": [
      "string"
    ],
    "isActive": true
  }'

Remove a price book entry

DELETE
/v1/price-books/{id}/entries/{entryId}

Authorization

AuthorizationRequiredBearer <token>

Session token from the SalesOS web app.

In: header

X-API-Key<token>

API key from Settings → API Keys. Authorization: ApiKey <key> is also accepted. Each operation lists the scope it needs under x-api-key-scopes.

In: header

Path Parameters

idRequiredstring
entryIdRequiredstring
curl -X DELETE "https://api.salesos.org/v1/price-books/<string>/entries/<string>" \
  -H "Authorization: Bearer <token>"

Get product price from price book

GET
/v1/price-books/{id}/products/{productId}/price

Authorization

AuthorizationRequiredBearer <token>

Session token from the SalesOS web app.

In: header

X-API-Key<token>

API key from Settings → API Keys. Authorization: ApiKey <key> is also accepted. Each operation lists the scope it needs under x-api-key-scopes.

In: header

Path Parameters

idRequiredstring
productIdRequiredstring

Query Parameters

quantitynumber
curl -X GET "https://api.salesos.org/v1/price-books/<string>/products/<string>/price?quantity=0" \
  -H "Authorization: Bearer <token>"

Contracts

Contract lifecycle management

Discount Rules

Discount approval rules and thresholds