Price Books | SalesOS Docs

Get all price books

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Query Parameters

isActiveboolean

isStandardboolean

currencystring

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

Create a new price book

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

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

curl -X POST "https://www.salesos.org/api/api/price-books" \
  -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

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

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

Get price book statistics

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

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

Get a price book by ID

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring

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

Update a price book

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

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

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

Delete a price book

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring

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

Clone a price book

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring

curl -X POST "https://www.salesos.org/api/api/price-books/<string>/clone" \
  -H "Authorization: Bearer <token>"

Get all entries in a price book

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring

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

Add a product entry to price book

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

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

curl -X POST "https://www.salesos.org/api/api/price-books/<string>/entries" \
  -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

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring

curl -X POST "https://www.salesos.org/api/api/price-books/<string>/entries/bulk" \
  -H "Authorization: Bearer <token>"

Update a price book entry

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

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

curl -X PATCH "https://www.salesos.org/api/api/price-books/<string>/entries/<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

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring

entryIdRequiredstring

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

Get product price from price book

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring

productIdRequiredstring

Query Parameters

quantitynumber

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