API

Product APIs

Tags and resources

Accessories
Accessories for the product
Customers Product
Customers might have their own products which map to the company products. These products are called customers products. The "CustomersProductName" field used in several resources, including sales order, maps to these products.
Customs tariff classification
Detailed description
Detailed descriptions of the product. Unlike the description of the product, these detailed descriptions is specified in different languages.
Expanded Product
Products including equivalent product names, customer product names and supplier product names. Possibility to search across all names. It is also possible to limit expanded products possible for a specific object (ex. Sales Order), including possible prices.
External material owner
The customer might provide materials used in a production. In that case external material owners should be added, with both the customer and a supplier that represents the same customer. During the manufacturing process it will automatically be created a purchase order to request shipment of the material.
Image
Manufacturers product
Notification trigger
Product Location
Product output design
Product supplier
Suppliers of this product with key information
Purchase prices
The product purchase prices from the different product suppliers
Replacement
Replacement for
Products which current product can replace or be a replacement for.
Replenishment configuration
Sales price
Standard recurring price
VAT type defaults
Default values to use for this product, specified by VAT type. The default values includes general ledger account, VAT code definition and dimensions.
POST
product/products
Create new product. Note that manufacturer might be required based on company settings.
DELETE
product/products/{productId}
Deletes specified product
GET
product/products/{productId}
Product details for the provided identifier
POST
product/products/{productId}/api-operations/{apiOperationId}/instances
13 operation(s) for product/products/{productId}
PUT
product/products/{productId}
Update the details for the provided product
GET
product/products/{productId}/related-objects
Lists objects related to product
GET
product/products/{productId}/stock-by-period?groupBy={groupBy}&locationId={locationId}
Stock by period specified in the groupBy parameter. Default period is week.
GET
product/products/{productId}/stock-forecast?locationId={locationId}
Gets stock-forecast by transaction types for provided product.
GET
product/products/{productId}/stock-forecast-by-period?groupBy={groupBy}&locationId={locationId}
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.
GET
product/products/{productId}/stock-history?groupBy={groupBy}
Stock by period specified in the groupBy parameter. Default period is month.
GET
product/products/search?keywords={keywords}&in={in}
API resource for searching products.
GET
product/products?search={search}&searchMode={searchMode}
List of products
POST
product/products?search={search}&searchMode={searchMode}/api-operations/{apiOperationId}/instances
2 operation(s) for product/products?search={search}&searchMode={searchMode}