### GET /v1/items Source: https://developer.scalepad.com/openapi/quoter-api.json Retrieves a list of all items available in the system. ```markdown ### Parameters - **fields** (string (allow_decimal_quantities|category|category_id|code|cost_decimal|cost_type|description|id|internal_note|manufacturer|manufacturer_id|name|percentage_price_category_ids|percentage_price_decimal|price_decimal|pricing_scheme|quantity_help_tip|record_created_at|record_updated_at|recurring|recurring_interval|restrict_discounting|show_option_prices|sku|supplier|supplier_id|taxable|weight_decimal), query, optional): One or more response fields, separated by commas. (example: "id, name") - **sort** (string (-record_created_at|-id|-record_updated_at|-name|+record_created_at|+id|+record_updated_at|+name), query, optional): One or more sort fields, separated by commas. (example: "name,id") - **filter[category_id]** (string, query, optional): Filter records by those associated with **category_id**. **Operators:** `eq` **Examples** - `filter[category_id]=eq:cat_123` - **filter[code]** (string, query, optional): Filter by **code**. **Operators:** `eq` **Examples** - `filter[code]=eq:ITEM001` - **filter[manufacturer_id]** (string, query, optional): Filter records by those associated with **manufacturer_id**. **Operators:** `eq` **Examples** - `filter[manufacturer_id]=eq:mfg_123` - **filter[name]** (string, query, optional): Filter by **name**. **Operators:** `eq`, `cont` **Examples** - `filter[name]=eq:abba` - `filter[name]=cont:ab` - **filter[record_created_at]** (string, query, optional): Filter by **record_created_at**. **Operators:** `gt`, `lt` **Examples** - `filter[record_created_at]=gt:2023-01-01T00:00:00Z` - `filter[record_created_at]=lt:2025-01-01T00:00:00Z` - **filter[record_updated_at]** (string, query, optional): Filter by **record_updated_at**. **Operators:** `gt`, `lt` **Examples** - `filter[record_updated_at]=gt:2023-01-01T00:00:00Z` - `filter[record_updated_at]=lt:2025-01-01T00:00:00Z` - **filter[sku]** (string, query, optional): Filter by **sku**. **Operators:** `eq` **Examples** - `filter[sku]=eq:WDG-PRO-001` - **filter[supplier_id]** (string, query, optional): Filter records by those associated with **supplier_id**. **Operators:** `eq` **Examples** - `filter[supplier_id]=eq:sup_123` - **page_size** (integer (int32), query, optional): The number of records to be returned in a single page - **cursor** (string, query, optional): Cursor for pagination (from previous response's next_cursor). (example: "WyIzIl0=") ### Responses #### 200 - response **ItemList** - **data** (array (Item)): Array of item objects. Array items: - **allow_decimal_quantities** (boolean): Whether the item can be sold in fractional quantities. (example: true) - **category** (string): Name of the category to which the item belongs. (example: "SSDs") - **category_id** (string): ID of the category to which the item belongs. (example: "cat_OcThl8SOeE8w6JYUznfrnQGdp94") - **code** (string): Code used to reference the item. Also referred to as "MPN" in Quoter's UI. Should be unique. (example: "MZ-V7S1T0B/AM") - **cost_decimal** (string): Unit cost of the item in decimal format. (example: 50.5) - **cost_type** (string (amount|percentage)): Indicates the type of cost (e.g., amount, percent). (example: "amount") ("amount"|"percentage") - **description** (string): Description of the item, HTML formatting is supported. (example: "The 970 EVO Plus reaches sequential read/write speeds up to 3,500/3,300 MB/s, up to 53% faster than the 970 EVO.") - **id** (string): Unique identifier for the item. (example: "item_OcThl0eqYyTVQzll6qFrMDMBYyu") - **internal_note** (string): Internal notes about the item, not shown to customers. (example: "Check warehouse for inventory before ordering.") - **manufacturer** (string): Name of the item manufacturer. (example: "Samsung") - **manufacturer_id** (string): Unique identifier for the manufacturer. (example: "manu_OcThlEWcbhAG52u3vLJodwnV88k") - **name** (string): The name of the item. (example: "SAMSUNG 970 EVO PLUS M.2 2280 1TB PCIe Gen 3.0 x4") - **percentage_price_category_ids** (array (string)): Category IDs used to calculate percentage-based pricing. (example: ["cat_OcThlTV6Tama8RH5Zh4Jfw1fhJC"]) - **percentage_price_decimal** (string): Percentage value used for pricing if applicable. (example: 50.5) - **price_decimal** (string): Price of the item in decimal format. (example: 50.5) - **pricing_scheme** (string (per_unit|flat|tiered_volume|tiered_stepped|percentage)): Pricing scheme for the item. (example: "per_unit") ("per_unit"|"flat"|"tiered_volume"|"tiered_stepped"|"percentage") - **quantity_help_tip** (string): Optional help text to assist in selecting a quantity. (example: "Enter the number of units required.") - **record_created_at** (string (date-time)): ISO 8601 timestamp when the record was created. (example: "2024-01-15T10:30:00Z") - **record_updated_at** (string (date-time)): ISO 8601 timestamp when the record was last updated. (example: "2024-01-15T15:45:00Z") - **recurring** (boolean): Indicates if the item is billed on a recurring basis. (example: true) - **recurring_interval** (string (monthly|quarterly|semi_annually|annually)): Billing interval if the item is recurring. (example: "annually") ("monthly"|"quarterly"|"semi_annually"|"annually") - **restrict_discounting** (boolean): Whether discounting is disabled for this item. (example: true) - **show_option_prices** (boolean): Indicates if option prices should be displayed. (example: true) - **sku** (string): Stock keeping unit identifier for the item. (example: "N82E16820147743") - **supplier** (string): Name of the item's supplier. (example: "Newegg") - **supplier_id** (string): Unique identifier for the supplier. (example: "sup_OcThlLwzLAM7m5eK1WEKkXUQZtm") - **taxable** (boolean): Indicates whether the item is subject to tax. (example: true) - **weight_decimal** (string): Item weight in decimal format. (example: 50.5) - **next_cursor** (string): Base64-encoded cursor for the next page of results. Null if no more results. (example: "WyIzIl0=") - **total_count** (integer): Total number of items returned by the query. (example: 1) #### 404 - response **ErrorResponse404** - **errors** (array (object)): Array of error objects containing details about each issue. Array items: - **detail** (string): Human-readable message describing the error. (example: "Record not found") - **code** (string): Error code identifying the specific error type. (example: "ERR_NOT_FOUND") - **title** (string): A short, human-readable summary of the error. (example: "Not Found") #### 422 - response **ErrorResponse** - **errors** (array (object)): Array of error objects containing details about each issue. Array items: - **detail** (string): Human-readable message describing the error. (example: "Invalid filter operator") - **code** (string): Error code identifying the specific error type. (example: "ERR_INVALID_FILTER_OPERATOR") - **title** (string): A short, human-readable summary of the error. (example: "Unprocessable Entity") ### Example Usage ```bash curl -X GET "https://api.scalepad.com/quoter/v1/items?fields=id, name&sort=name,id&filter[category_id]=string&filter[code]=string&filter[manufacturer_id]=string&filter[name]=string&filter[record_created_at]=string&filter[record_updated_at]=string&filter[sku]=string&filter[supplier_id]=string&page_size=0&cursor=WyIzIl0=" ``` ``` -------------------------------- ### GET /v1/suppliers Source: https://developer.scalepad.com/openapi/quoter-api.json Retrieves a list of all suppliers available in the system. ```markdown ### Parameters - **fields** (string (id|name|record_created_at|record_updated_at), query, optional): One or more response fields, separated by commas. (example: "id, name") - **sort** (string (-record_created_at|-id|-record_updated_at|-name|+record_created_at|+id|+record_updated_at|+name), query, optional): One or more sort fields, separated by commas. (example: "name,id") - **filter[name]** (string, query, optional): Filter by **name**. **Operators:** `eq`, `cont` **Examples** - `filter[name]=eq:abba` - `filter[name]=cont:ab` - **filter[record_created_at]** (string, query, optional): Filter by **record_created_at**. **Operators:** `gt`, `lt` **Examples** - `filter[record_created_at]=gt:2023-01-01T00:00:00Z` - `filter[record_created_at]=lt:2025-01-01T00:00:00Z` - **filter[record_updated_at]** (string, query, optional): Filter by **record_updated_at**. **Operators:** `gt`, `lt` **Examples** - `filter[record_updated_at]=gt:2023-01-01T00:00:00Z` - `filter[record_updated_at]=lt:2025-01-01T00:00:00Z` - **page_size** (integer (int32), query, optional): The number of records to be returned in a single page - **cursor** (string, query, optional): Cursor for pagination (from previous response's next_cursor). (example: "WyIzIl0=") ### Responses #### 200 - response **SupplierList** - **data** (array (Supplier)): Array of supplier objects. Array items: - **id** (string): Unique identifier for the supplier. (example: "sup_OcThl8SOeE8w6JYUznfrnQGdp94") - **name** (string): The name of the supplier. (example: "Global Supply Co") - **record_created_at** (string (date-time)): ISO 8601 timestamp when the record was created. (example: "2024-01-15T10:30:00Z") - **record_updated_at** (string (date-time)): ISO 8601 timestamp when the record was last updated. (example: "2024-01-15T15:45:00Z") - **next_cursor** (string): Base64-encoded cursor for the next page of results. Null if no more results. (example: "WyIzIl0=") - **total_count** (integer): Total number of suppliers returned by the query. (example: 1) #### 404 - response **ErrorResponse404** - **errors** (array (object)): Array of error objects containing details about each issue. Array items: - **detail** (string): Human-readable message describing the error. (example: "Record not found") - **code** (string): Error code identifying the specific error type. (example: "ERR_NOT_FOUND") - **title** (string): A short, human-readable summary of the error. (example: "Not Found") #### 422 - response **ErrorResponse** - **errors** (array (object)): Array of error objects containing details about each issue. Array items: - **detail** (string): Human-readable message describing the error. (example: "Invalid filter operator") - **code** (string): Error code identifying the specific error type. (example: "ERR_INVALID_FILTER_OPERATOR") - **title** (string): A short, human-readable summary of the error. (example: "Unprocessable Entity") ### Example Usage ```bash curl -X GET "https://api.scalepad.com/quoter/v1/suppliers?fields=id, name&sort=name,id&filter[name]=string&filter[record_created_at]=string&filter[record_updated_at]=string&page_size=0&cursor=WyIzIl0=" ``` ``` -------------------------------- ### GET /v1/item-options Source: https://developer.scalepad.com/openapi/quoter-api.json Retrieves a list of all item options available in the system. ```markdown ### Parameters - **fields** (string (allow_multiple_values|description|extended_description|id|item_id|name|record_created_at|record_updated_at|required|sort_order), query, optional): One or more response fields, separated by commas. (example: "id, name") - **sort** (string (-record_created_at|-id|-record_updated_at|-name|-sort_order|+record_created_at|+id|+record_updated_at|+name|+sort_order), query, optional): One or more sort fields, separated by commas. (example: "name,id") - **filter[item_id]** (string, query, optional): Filter records by those associated with **item_id**. **Operators:** `eq` **Examples** - `filter[item_id]=eq:item_123` - **filter[name]** (string, query, optional): Filter by **name**. **Operators:** `eq`, `cont` **Examples** - `filter[name]=eq:abba` - `filter[name]=cont:ab` - **filter[record_created_at]** (string, query, optional): Filter by **record_created_at**. **Operators:** `gt`, `lt` **Examples** - `filter[record_created_at]=gt:2023-01-01T00:00:00Z` - `filter[record_created_at]=lt:2025-01-01T00:00:00Z` - **filter[record_updated_at]** (string, query, optional): Filter by **record_updated_at**. **Operators:** `gt`, `lt` **Examples** - `filter[record_updated_at]=gt:2023-01-01T00:00:00Z` - `filter[record_updated_at]=lt:2025-01-01T00:00:00Z` - **page_size** (integer (int32), query, optional): The number of records to be returned in a single page - **cursor** (string, query, optional): Cursor for pagination (from previous response's next_cursor). (example: "WyIzIl0=") ### Responses #### 200 - response **ItemOptionList** - **data** (array (ItemOption)): Array of item option objects. Array items: - **allow_multiple_values** (boolean): Whether multiple values can be selected for this option. (example: true) - **description** (string): Description of the item option. (example: "Choose your preferred color") - **extended_description** (string): Extended description providing additional details about the option. (example: "Select from our available color options. Additional colors may be available upon request.") - **id** (string): Unique identifier for the item option. (example: "iopt_OcThl8SOeE8w6JYUznfrnQGdp94") - **item_id** (string): Unique identifier for the item this option belongs to. (example: "item_OcThl0eqYyTVQzll6qFrMDMBYyu") - **name** (string): The name of the item option. (example: "Color") - **record_created_at** (string (date-time)): ISO 8601 timestamp when the record was created. (example: "2024-01-15T10:30:00Z") - **record_updated_at** (string (date-time)): ISO 8601 timestamp when the record was last updated. (example: "2024-01-15T15:45:00Z") - **required** (boolean): Whether this option is required to be selected. (example: true) - **sort_order** (integer): Display order for this option relative to other options. (example: 1) - **next_cursor** (string): Base64-encoded cursor for the next page of results. Null if no more results. (example: "WyIzIl0=") - **total_count** (integer): Total number of item options returned by the query. (example: 1) #### 404 - response **ErrorResponse404** - **errors** (array (object)): Array of error objects containing details about each issue. Array items: - **detail** (string): Human-readable message describing the error. (example: "Record not found") - **code** (string): Error code identifying the specific error type. (example: "ERR_NOT_FOUND") - **title** (string): A short, human-readable summary of the error. (example: "Not Found") #### 422 - response **ErrorResponse** - **errors** (array (object)): Array of error objects containing details about each issue. Array items: - **detail** (string): Human-readable message describing the error. (example: "Invalid filter operator") - **code** (string): Error code identifying the specific error type. (example: "ERR_INVALID_FILTER_OPERATOR") - **title** (string): A short, human-readable summary of the error. (example: "Unprocessable Entity") ### Example Usage ```bash curl -X GET "https://api.scalepad.com/quoter/v1/item-options?fields=id, name&sort=name,id&filter[item_id]=string&filter[name]=string&filter[record_created_at]=string&filter[record_updated_at]=string&page_size=0&cursor=WyIzIl0=" ``` ``` -------------------------------- ### GET /v1/categories Source: https://developer.scalepad.com/openapi/quoter-api.json Retrieves a list of all categories available in the system. ```markdown ### Parameters - **fields** (string (id|name|parent_category|parent_category_id|record_created_at|record_updated_at), query, optional): One or more response fields, separated by commas. (example: "id, name") - **sort** (string (-record_created_at|-id|-record_updated_at|-name|-parent_category_id|+record_created_at|+id|+record_updated_at|+name|+parent_category_id), query, optional): One or more sort fields, separated by commas. (example: "name,id") - **filter[parent_category_id]** (string, query, optional): Filter records by those associated with **parent_category_id**. **Operators:** `eq` **Examples** - `filter[parent_category_id]=eq:cat_123` - **filter[name]** (string, query, optional): Filter by **name**. **Operators:** `eq`, `cont` **Examples** - `filter[name]=eq:abba` - `filter[name]=cont:ab` - **filter[record_created_at]** (string, query, optional): Filter by **record_created_at**. **Operators:** `gt`, `lt` **Examples** - `filter[record_created_at]=gt:2023-01-01T00:00:00Z` - `filter[record_created_at]=lt:2025-01-01T00:00:00Z` - **filter[record_updated_at]** (string, query, optional): Filter by **record_updated_at**. **Operators:** `gt`, `lt` **Examples** - `filter[record_updated_at]=gt:2023-01-01T00:00:00Z` - `filter[record_updated_at]=lt:2025-01-01T00:00:00Z` - **page_size** (integer (int32), query, optional): The number of records to be returned in a single page - **cursor** (string, query, optional): Cursor for pagination (from previous response's next_cursor). (example: "WyIzIl0=") ### Responses #### 200 - response **CategoryList** - **data** (array (Category)): Array of category objects. Array items: - **id** (string): Unique identifier for the category. (example: "cat_OcThl8SOeE8w6JYUznfrnQGdp94") - **name** (string): The name of the category. (example: "Electronics") - **parent_category** (string): The name of the parent category, if any. (example: "Technology") - **parent_category_id** (string): The unique identifier of the parent category, if any. (example: "cat_OcThl8SOeE8w6JYUznfrnQGdp94") - **record_created_at** (string (date-time)): ISO 8601 timestamp when the record was created. (example: "2024-01-15T10:30:00Z") - **record_updated_at** (string (date-time)): ISO 8601 timestamp when the record was last updated. (example: "2024-01-15T15:45:00Z") - **next_cursor** (string): Base64-encoded cursor for the next page of results. Null if no more results. (example: "WyIzIl0=") - **total_count** (integer): Total number of categories returned by the query. (example: 1) #### 404 - response **ErrorResponse404** - **errors** (array (object)): Array of error objects containing details about each issue. Array items: - **detail** (string): Human-readable message describing the error. (example: "Record not found") - **code** (string): Error code identifying the specific error type. (example: "ERR_NOT_FOUND") - **title** (string): A short, human-readable summary of the error. (example: "Not Found") #### 422 - response **ErrorResponse** - **errors** (array (object)): Array of error objects containing details about each issue. Array items: - **detail** (string): Human-readable message describing the error. (example: "Invalid filter operator") - **code** (string): Error code identifying the specific error type. (example: "ERR_INVALID_FILTER_OPERATOR") - **title** (string): A short, human-readable summary of the error. (example: "Unprocessable Entity") ### Example Usage ```bash curl -X GET "https://api.scalepad.com/quoter/v1/categories?fields=id, name&sort=name,id&filter[parent_category_id]=string&filter[name]=string&filter[record_created_at]=string&filter[record_updated_at]=string&page_size=0&cursor=WyIzIl0=" ``` ``` -------------------------------- ### GET /v1/manufacturers Source: https://developer.scalepad.com/openapi/quoter-api.json Retrieves a list of all manufacturers available in the system. ```markdown ### Parameters - **fields** (string (id|name|record_created_at|record_updated_at), query, optional): One or more response fields, separated by commas. (example: "id, name") - **sort** (string (-record_created_at|-id|-record_updated_at|-name|+record_created_at|+id|+record_updated_at|+name), query, optional): One or more sort fields, separated by commas. (example: "name,id") - **filter[name]** (string, query, optional): Filter by **name**. **Operators:** `eq`, `cont` **Examples** - `filter[name]=eq:abba` - `filter[name]=cont:ab` - **filter[record_created_at]** (string, query, optional): Filter by **record_created_at**. **Operators:** `gt`, `lt` **Examples** - `filter[record_created_at]=gt:2023-01-01T00:00:00Z` - `filter[record_created_at]=lt:2025-01-01T00:00:00Z` - **filter[record_updated_at]** (string, query, optional): Filter by **record_updated_at**. **Operators:** `gt`, `lt` **Examples** - `filter[record_updated_at]=gt:2023-01-01T00:00:00Z` - `filter[record_updated_at]=lt:2025-01-01T00:00:00Z` - **page_size** (integer (int32), query, optional): The number of records to be returned in a single page - **cursor** (string, query, optional): Cursor for pagination (from previous response's next_cursor). (example: "WyIzIl0=") ### Responses #### 200 - response **ManufacturerList** - **data** (array (Manufacturer)): Array of manufacturer objects. Array items: - **id** (string): Unique identifier for the manufacturer. (example: "mfg_OcThl8SOeE8w6JYUznfrnQGdp94") - **name** (string): The name of the manufacturer. (example: "Apple") - **record_created_at** (string (date-time)): ISO 8601 timestamp when the record was created. (example: "2024-01-15T10:30:00Z") - **record_updated_at** (string (date-time)): ISO 8601 timestamp when the record was last updated. (example: "2024-01-15T15:45:00Z") - **next_cursor** (string): Base64-encoded cursor for the next page of results. Null if no more results. (example: "WyIzIl0=") - **total_count** (integer): Total number of manufacturers returned by the query. (example: 1) #### 404 - response **ErrorResponse404** - **errors** (array (object)): Array of error objects containing details about each issue. Array items: - **detail** (string): Human-readable message describing the error. (example: "Record not found") - **code** (string): Error code identifying the specific error type. (example: "ERR_NOT_FOUND") - **title** (string): A short, human-readable summary of the error. (example: "Not Found") #### 422 - response **ErrorResponse** - **errors** (array (object)): Array of error objects containing details about each issue. Array items: - **detail** (string): Human-readable message describing the error. (example: "Invalid filter operator") - **code** (string): Error code identifying the specific error type. (example: "ERR_INVALID_FILTER_OPERATOR") - **title** (string): A short, human-readable summary of the error. (example: "Unprocessable Entity") ### Example Usage ```bash curl -X GET "https://api.scalepad.com/quoter/v1/manufacturers?fields=id, name&sort=name,id&filter[name]=string&filter[record_created_at]=string&filter[record_updated_at]=string&page_size=0&cursor=WyIzIl0=" ``` ``` -------------------------------- ### GET /v1/quote-templates Source: https://developer.scalepad.com/openapi/quoter-api.json Retrieves a paginated list of all Quote Templates. Supports filtering by title and sorting options. ```markdown ### Parameters - **filter[title]** (string, query, optional): Filter by **title**. **Operators:** `cont` **Examples** - `filter[title]=cont:Business` - `filter[title]=cont:Template` - **sort** (string (-record_created_at|-id|-record_updated_at|-title|+record_created_at|+id|+record_updated_at|+title), query, optional): One or more sort fields, separated by commas. (example: "title,id") - **page_size** (integer (int32), query, optional): The number of records to be returned in a single page - **cursor** (string, query, optional): Cursor for pagination (from previous response's next_cursor). (example: "WyIzIl0=") ### Responses #### 200 - response **QuoteTemplateList** - **data** (array (QuoteTemplate)): Array of quote template objects. Array items: - **id** (string) (required): Unique identifier for the quote template. (example: "quot_38MAkwFXptvtDNBHj8B6fgCfZka") - **record_created_at** (string (date-time)) (required): Timestamp when the quote template was created. (example: "2024-01-15T10:30:00Z") - **record_updated_at** (string (date-time)) (required): Timestamp when the quote template was last updated. (example: "2024-01-15T15:45:00Z") - **slug** (string) (required): URL-friendly identifier for the quote template. (example: "business-proposal-template") - **title** (string) (required): Display name of the quote template. (example: "Business Proposal Template") - **next_cursor** (string): Cursor for pagination to fetch the next page of results. (example: "WyIzIl0=") - **total_count** (integer): Total number of quote templates. (example: 15) #### 404 - response **ErrorResponse404** - **errors** (array (object)): Array of error objects containing details about each issue. Array items: - **detail** (string): Human-readable message describing the error. (example: "Record not found") - **code** (string): Error code identifying the specific error type. (example: "ERR_NOT_FOUND") - **title** (string): A short, human-readable summary of the error. (example: "Not Found") #### 422 - response **ErrorResponse** - **errors** (array (object)): Array of error objects containing details about each issue. Array items: - **detail** (string): Human-readable message describing the error. (example: "Invalid filter operator") - **code** (string): Error code identifying the specific error type. (example: "ERR_INVALID_FILTER_OPERATOR") - **title** (string): A short, human-readable summary of the error. (example: "Unprocessable Entity") ### Example Usage ```bash curl -X GET "https://api.scalepad.com/quoter/v1/quote-templates?filter[title]=string&sort=title,id&page_size=0&cursor=WyIzIl0=" ``` ``` -------------------------------- ### GET /v1/item-options/{id} Source: https://developer.scalepad.com/openapi/quoter-api.json Retrieves detailed information about a specific item option. ```markdown ### Parameters - **id** (string, path, required): Item Option ID - **fields** (string (allow_multiple_values|description|extended_description|id|item_id|name|record_created_at|record_updated_at|required|sort_order), query, optional): One or more response fields, separated by commas. (example: "id, name") ### Responses #### 200 - response **ItemOption** - **allow_multiple_values** (boolean): Whether multiple values can be selected for this option. (example: true) - **description** (string): Description of the item option. (example: "Choose your preferred color") - **extended_description** (string): Extended description providing additional details about the option. (example: "Select from our available color options. Additional colors may be available upon request.") - **id** (string): Unique identifier for the item option. (example: "iopt_OcThl8SOeE8w6JYUznfrnQGdp94") - **item_id** (string): Unique identifier for the item this option belongs to. (example: "item_OcThl0eqYyTVQzll6qFrMDMBYyu") - **name** (string): The name of the item option. (example: "Color") - **record_created_at** (string (date-time)): ISO 8601 timestamp when the record was created. (example: "2024-01-15T10:30:00Z") - **record_updated_at** (string (date-time)): ISO 8601 timestamp when the record was last updated. (example: "2024-01-15T15:45:00Z") - **required** (boolean): Whether this option is required to be selected. (example: true) - **sort_order** (integer): Display order for this option relative to other options. (example: 1) #### 404 - response **ErrorResponse404** - **errors** (array (object)): Array of error objects containing details about each issue. Array items: - **detail** (string): Human-readable message describing the error. (example: "Record not found") - **code** (string): Error code identifying the specific error type. (example: "ERR_NOT_FOUND") - **title** (string): A short, human-readable summary of the error. (example: "Not Found") ### Example Usage ```bash curl -X GET "https://api.scalepad.com/quoter/v1/item-options/{id}?fields=id, name" ``` ``` -------------------------------- ### GET /v1/item-option-values Source: https://developer.scalepad.com/openapi/quoter-api.json Retrieves a list of all item option values available in the system. ```markdown ### Parameters - **fields** (string (code|cost_decimal|cost_type|id|item_id|item_option_id|name|price_decimal|pricing_scheme|record_created_at|record_updated_at|sort_order), query, optional): One or more response fields, separated by commas. (example: "id, name, code") - **sort** (string (-record_created_at|-id|-record_updated_at|-name|-sort_order|+record_created_at|+id|+record_updated_at|+name|+sort_order), query, optional): One or more sort fields, separated by commas. (example: "name,id") - **filter[code]** (string, query, optional): Filter records by **code**. **Operators:** `eq`, `cont` **Examples** - `filter[code]=eq:COLOR_RED` - `filter[code]=cont:COLOR` - **filter[item_id]** (string, query, optional): Filter records by those associated with **item_id**. **Operators:** `eq` **Examples** - `filter[item_id]=eq:item_123` - **filter[item_option_id]** (string, query, optional): Filter records by those associated with **item_option_id**. **Operators:** `eq` **Examples** - `filter[item_option_id]=eq:iopt_123` - **filter[name]** (string, query, optional): Filter by **name**. **Operators:** `eq`, `cont` **Examples** - `filter[name]=eq:abba` - `filter[name]=cont:ab` - **filter[record_created_at]** (string, query, optional): Filter by **record_created_at**. **Operators:** `gt`, `lt` **Examples** - `filter[record_created_at]=gt:2023-01-01T00:00:00Z` - `filter[record_created_at]=lt:2025-01-01T00:00:00Z` - **filter[record_updated_at]** (string, query, optional): Filter by **record_updated_at**. **Operators:** `gt`, `lt` **Examples** - `filter[record_updated_at]=gt:2023-01-01T00:00:00Z` - `filter[record_updated_at]=lt:2025-01-01T00:00:00Z` - **page_size** (integer (int32), query, optional): The number of records to be returned in a single page - **cursor** (string, query, optional): Cursor for pagination (from previous response's next_cursor). (example: "WyIzIl0=") ### Responses #### 200 - response **ItemOptionValueList** - **data** (array (ItemOptionValue)): Array of item option value objects. Array items: - **code** (string): Optional code identifier for the option value. (example: "COLOR_RED") - **cost_decimal** (string): Cost associated with this option value in decimal format. (example: "15.99") - **cost_type** (string): Type of cost calculation for this option value. (example: "amount") - **id** (string): Unique identifier for the item option value. (example: "iopv_OcThl8SOeE8w6JYUznfrnQGdp94") - **item_id** (string): Unique identifier for the item this option value belongs to. (example: "item_OcThl0eqYyTVQzll6qFrMDMBYyu") - **item_option_id** (string): Unique identifier for the item option this value belongs to. (example: "iopt_OcThl8SOeE8w6JYUznfrnQGdp94") - **name** (string): The display name of the option value. (example: "Red") - **price_decimal** (string): Price associated with this option value in decimal format. (example: "19.99") - **pricing_scheme** (string): Pricing scheme used for this option value. (example: "amount") - **record_created_at** (string (date-time)): ISO 8601 timestamp when the record was created. (example: "2024-01-15T10:30:00Z") - **record_updated_at** (string (date-time)): ISO 8601 timestamp when the record was last updated. (example: "2024-01-15T15:45:00Z") - **sort_order** (integer): Display order for this option value relative to other values. (example: 1) - **next_cursor** (string): Base64-encoded cursor for the next page of results. Null if no more results. (example: "WyIzIl0=") - **total_count** (integer): Total number of item option values returned by the query. (example: 1) #### 404 - response **ErrorResponse404** - **errors** (array (object)): Array of error objects containing details about each issue. Array items: - **detail** (string): Human-readable message describing the error. (example: "Record not found") - **code** (string): Error code identifying the specific error type. (example: "ERR_NOT_FOUND") - **title** (string): A short, human-readable summary of the error. (example: "Not Found") #### 422 - response **ErrorResponse** - **errors** (array (object)): Array of error objects containing details about each issue. Array items: - **detail** (string): Human-readable message describing the error. (example: "Invalid filter operator") - **code** (string): Error code identifying the specific error type. (example: "ERR_INVALID_FILTER_OPERATOR") - **title** (string): A short, human-readable summary of the error. (example: "Unprocessable Entity") ### Example Usage ```bash curl -X GET "https://api.scalepad.com/quoter/v1/item-option-values?fields=id, name, code&sort=name,id&filter[code]=string&filter[item_id]=string&filter[item_option_id]=string&filter[name]=string&filter[record_created_at]=string&filter[record_updated_at]=string&page_size=0&cursor=WyIzIl0=" ``` ``` -------------------------------- ### GET /v1/item-tiers Source: https://developer.scalepad.com/openapi/quoter-api.json Retrieves a list of all item tiers available in the system. ```markdown ### Parameters - **fields** (string (cost_decimal|cost_type|id|item_id|lower_boundary|price_decimal|record_created_at|record_updated_at), query, optional): One or more response fields, separated by commas. (example: "id, item_id, lower_boundary") - **sort** (string (-id|-lower_boundary|-record_created_at|-record_updated_at|+id|+lower_boundary|+record_created_at|+record_updated_at), query, optional): One or more sort fields, separated by commas. (example: "lower_boundary,id") - **filter[item_id]** (string, query, optional): Filter records by those associated with **item_id**. **Operators:** `eq` **Examples** - `filter[item_id]=eq:item_123` - **filter[record_created_at]** (string, query, optional): Filter by **record_created_at**. **Operators:** `gt`, `lt` **Examples** - `filter[record_created_at]=gt:2023-01-01T00:00:00Z` - `filter[record_created_at]=lt:2025-01-01T00:00:00Z` - **filter[record_updated_at]** (string, query, optional): Filter by **record_updated_at**. **Operators:** `gt`, `lt` **Examples** - `filter[record_updated_at]=gt:2023-01-01T00:00:00Z` - `filter[record_updated_at]=lt:2025-01-01T00:00:00Z` - **page_size** (integer (int32), query, optional): The number of records to be returned in a single page - **cursor** (string, query, optional): Cursor for pagination (from previous response's next_cursor). (example: "WyIzIl0=") ### Responses #### 200 - response **ItemTierList** - **data** (array (ItemTier)): Array of item tier objects. Array items: - **cost_decimal** (string): Cost of the item at this tier level as a decimal string. (example: "25.99") - **cost_type** (string): Type of cost calculation (amount, percentage, etc.). (example: "amount") - **id** (string): Unique identifier for the item tier. (example: "itier_OcThl8SOeE8w6JYUznfrnQGdp94") - **item_id** (string): Unique identifier for the item this tier belongs to. (example: "item_OcThl0eqYyTVQzll6qFrMDMBYyu") - **lower_boundary** (integer): Minimum quantity threshold for this pricing tier. (example: 10) - **price_decimal** (string): Price of the item at this tier level as a decimal string. (example: "49.99") - **record_created_at** (string (date-time)): ISO 8601 timestamp when the record was created. (example: "2024-01-15T10:30:00Z") - **record_updated_at** (string (date-time)): ISO 8601 timestamp when the record was last updated. (example: "2024-01-15T15:45:00Z") - **next_cursor** (string): Base64-encoded cursor for the next page of results. Null if no more results. (example: "WyIzIl0=") - **total_count** (integer): Total number of item tiers returned by the query. (example: 1) #### 404 - response **ErrorResponse404** - **errors** (array (object)): Array of error objects containing details about each issue. Array items: - **detail** (string): Human-readable message describing the error. (example: "Record not found") - **code** (string): Error code identifying the specific error type. (example: "ERR_NOT_FOUND") - **title** (string): A short, human-readable summary of the error. (example: "Not Found") #### 422 - response **ErrorResponse** - **errors** (array (object)): Array of error objects containing details about each issue. Array items: - **detail** (string): Human-readable message describing the error. (example: "Invalid filter operator") - **code** (string): Error code identifying the specific error type. (example: "ERR_INVALID_FILTER_OPERATOR") - **title** (string): A short, human-readable summary of the error. (example: "Unprocessable Entity") ### Example Usage ```bash curl -X GET "https://api.scalepad.com/quoter/v1/item-tiers?fields=id, item_id, lower_boundary&sort=lower_boundary,id&filter[item_id]=string&filter[record_created_at]=string&filter[record_updated_at]=string&page_size=0&cursor=WyIzIl0=" ``` ```