Documentation Index
Fetch the complete documentation index at: https://bancofcalifornia-preview.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
POST URL
Add a Product
| Variables | Description |
|---|
| products* | Add a product to the Product Manager. Value: “add_product“ |
| product_sku* | The unique SKU for this product. An error will be returned if the SKU is already in use by another product. Examples: “000001” or “324-6323-0005“ |
| product_description* | The user-facing name of the product. Examples: “1 Gallon Milk” or “Phone Case” |
| product_cost* | The cost of the product before any tax or discounts. Must be greater than 0.00. |
| product_currency* | The currency for the product’s price. Examples: “USD” or “EUR” |
| product_commodity_code | The commodity code for the product. |
| product_unit_of_measure | The unit of measure for the product. Defaults to “NAR” (number of articles). Examples: “TDK” or “MTQ” |
| product_tax_amount | The tax that should be added to the product cost. This is a fixed amount, not a percentage. Example: “1.54” |
| product_discount_amount | The discount that will subtracted from the cost of the product. |
| product_image_data** | The Base64-encoded version of the image for the product. The format must be JPG, PNG, or GIF, and be 2MB or smaller. |
| product_image_name** | The file name of the image being added with product_image_data. Examples: “product.png” or “sku-1234.jpg” |
Field markers
* Always required
** Required if adding an image to the product
Update a Product
| Variables | Description |
|---|
| products* | Update a product already in the Product Manager. Value: “update_product” |
| product_id* | The automatically generated ID for the product. This was returned in the add_product API response, or can be found in the UI under the Product Details page in the Product Manager. Example: “5538585252” |
| product_sku | The unique SKU for this product. An error will be returned if the SKU is already in use by another product. Examples: “000001” or “324-6323-0005” |
| product_description | The user-facing name of the product. Examples: “1 Gallon Milk” or “Phone Case” |
| product_cost | The cost of the product before any tax or discounts. Must be greater than 0.00. |
| product_currency | The currency for the product’s price. Examples: “USD” or “EUR” |
| product_commodity_code | The commodity code for the product. |
| product_unit_of_measure | The unit of measure for the product. Examples: “TDK” or “MTQ” |
| product_tax_amount | The tax that should be added to the product cost. This is a fixed amount, not a percentage. Example: “1.54” |
| product_discount_amount | The discount that will subtracted from the cost of the product. |
| product_image_data** | The Base64-encoded version of the image for the product. The format must be JPG, PNG, or GIF, and be 2MB or smaller. |
| product_image_name** | The file name of the image being added with product_image_data. Examples: “product.png” or “sku-1234.jpg” |
Field markers
* Always required
** Required if adding an image to the product
Delete a Product
| Variables | Description |
|---|
| products* | Delete a product to the Product Manager. This action can not be undone. Value: “delete_product” |
| product_id* | The automatically generated ID for the product. This was returned in the add_product API response, or can be found in the UI under the Product Details page in the Product Manager. Example: “5538585252” |
Field markers