Product APIs
Description
The product master record in RamBase. Central to sales, procurement, and production. Contains prices, suppliers, structures, images, and classification data.
Tags and resources
Accessories
Accessory products that can be suggested or added alongside this product.
Customers Product
Customer-specific product numbers that map to this company product, used in sales order processing.
Customs tariff classification
Customs tariff codes and classifications assigned to a product for import/export declarations.
Detailed description
Long-form product descriptions in multiple languages, supplementing the standard product description.
Expanded Product
Expanded product search including equivalent names, customer product names, and supplier product names. Useful for searching across all product identifiers.
External material owner
External material owners (customers who supply their own materials for production), linked to a representing supplier.
Image
Images associated with a product.
Manufacturers product
Manufacturer-specific product identifiers and details for this product.
Notification trigger
Notification triggers for a product, generating alerts when defined conditions are met (e.g., low stock).
Product Location
Stock locations where this product is stored or managed.
Product output design
Output design overrides for a product, controlling how it appears in printed or transmitted documents.
Product supplier
Suppliers for this product, including lead times, supplier product numbers, and purchase prices.
Purchase prices
Purchase price agreements for this product from its defined suppliers.
Replacement
Replacement products defined for this product.
Replacement for
Products that this product can replace, or that can act as a replacement for this product.
Replenishment configuration
Replenishment rules for a product per stock location, used for automated reorder suggestions.
Sales price
Sales price definitions for a product, which may vary by currency, quantity, or price list.
Standard recurring price
Standard recurring price entries for a product, used in subscription and contract-based billing.
VAT type defaults
Default VAT code definitions, GL accounts, and dimensions for a product, specified per VAT type.
product/products
List of products
2 operation(s) for product/products
product/products
Create new product. Note that manufacturer might be required based on company settings.
product/products/{productId}
Update the details for the provided product
product/products/{productId}
Product details for the provided identifier
15 operation(s) for product/products/{productId}
product/products/{productId}
Deletes specified product
product/products/{productId}/open-production-operations
List of production operations, including their associated work orders, that require the specified product as a material. The list shows all operations, including completed, where the associated production work order is released for production but not yet completed.
product/products/{productId}/related-objects
Lists objects related to product
product/products/{productId}/standard-structure-aggregated-operation-times
List of product structure operations for given product together with their aggregated production times (average, longest, shortest time calculated for each step of operation)
product/products/{productId}/stock-by-period
Stock by period specified in the groupBy parameter. Default period is week.
product/products/{productId}/stock-forecast
Gets stock-forecast by transaction types for provided product.
product/products/{productId}/stock-forecast-by-period
List of all stock forecasts by period for provided product. The forecasts is by default grouped by week, but can also be grouped by month or year. It is also possible to limit the forecasts to a specific location.
product/products/{productId}/stock-history
Stock by period specified in the groupBy parameter. Default period is month.
product/products/search
API resource for searching products.
sales/product-search
API resource for searching products. Note that quantity for calculating prices will get the default value 1 if omitted. If you provice forObjectType and forObjectId, you will get prices based on the customer and currency of the document.