Product APIs
Creates a new manufacturer product
| HTTP method | POST |
| URI | https://api.rambase.net/product/products/{productId}/manufacturers-products |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {productId} |
Product identifier
Integer, minimum 10000 |
| Custom fields | Custom fields supported |
| Successful HTTP status code | 201 |
| API resource identifier | 3477, version 4 |
The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.
Name
Required/mandatory field
Manufacturers name of the product. Also known as Manufacturer Part Number (MPN).
>{String}</Name>InternalNote
Internal note/comment about manufacturers product.
This field is optional.
>{String}</InternalNote>LastTimeBuyDate
The last time buy (LTB) date is the last date on which the manufacturer will accept orders for this product.
This field is optional.
>{Date}</LastTimeBuyDate>IsPreferred
Manufacturer products can be set as preferred. This is only for information.
Default value: False
This field is optional.
>{Boolean}</IsPreferred>IsDefaultForProduct
True if this manufacturers product is the default manufacturers product for the product
Default value: False
This field is optional.
>{Boolean}</IsDefaultForProduct>GlobalTradeItemNumber
Global Trade Item Number (GTIN) is a 14 digit identifier for trade items (comprising among others of the former EAN International and Uniform Code Council). Examples of types of GTIN are UPC, EAN, JAN, ISBN
Maximum value: 14
Input must match the following regular expression pattern: ([0-9])+
This field is optional.
>{String}</GlobalTradeItemNumber>CountryOfOriginCode
Two-character code (ISO 3166) identifying the default country where the product is produced. This value is inherrited from the assigned goods reception(s). If not country of origin is specified for the goods reception(s), country of origin is retrieved from the product. If assigned to multiple goods receptions with different origin, the field will be empty.
This field is optional.
>{String}</CountryOfOriginCode>Package
This field is optional.
>PackageQuantity
Total quantity of the product within a package
Minimum value: 0
This field is optional.
>{Decimal}</PackageQuantity>PackageType
Type of wrapping used for the package
Applicable domain values can be found here
This field is optional.
>{String}</PackageType>ManufacturerId
Required/mandatory field
Manufacturer identifier
Minimum value: 1000
>{Integer}</ManufacturerId>Name
Required/mandatory field
Manufacturers name of the product. Also known as Manufacturer Part Number (MPN).
": "{String}",InternalNote
Internal note/comment about manufacturers product.
This field is optional.
": "{String}",LastTimeBuyDate
The last time buy (LTB) date is the last date on which the manufacturer will accept orders for this product.
This field is optional.
": "{Date}",IsPreferred
Manufacturer products can be set as preferred. This is only for information.
Default value: False
This field is optional.
": "{Boolean}",IsDefaultForProduct
True if this manufacturers product is the default manufacturers product for the product
Default value: False
This field is optional.
": "{Boolean}",GlobalTradeItemNumber
Global Trade Item Number (GTIN) is a 14 digit identifier for trade items (comprising among others of the former EAN International and Uniform Code Council). Examples of types of GTIN are UPC, EAN, JAN, ISBN
Maximum value: 14
Input must match the following regular expression pattern: ([0-9])+
This field is optional.
": "{String}",CountryOfOriginCode
Two-character code (ISO 3166) identifying the default country where the product is produced. This value is inherrited from the assigned goods reception(s). If not country of origin is specified for the goods reception(s), country of origin is retrieved from the product. If assigned to multiple goods receptions with different origin, the field will be empty.
This field is optional.
": "{String}",Package
This field is optional.
": {PackageQuantity
Total quantity of the product within a package
Minimum value: 0
This field is optional.
": "{Decimal}",PackageType
Type of wrapping used for the package
Applicable domain values can be found here
This field is optional.
": "{String}"ManufacturerId
Required/mandatory field
Manufacturer identifier
Minimum value: 1000
": "{Integer}"The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.
| $access_token String, optional | After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time. |
| $db String, optional | Set the database/company for the request |
| $useMinimumVersion Integer, optional | Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information. |
| $showDomainDescriptions Boolean, optional | Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false. |
| $lang String, optional | Specifies the language used in the response, following the 3-letter ISO-639-1 [lll] |
| $showCustomFields Boolean, optional | Set to "true" to include custom fields. Default value is false. |
Read more about filters and sorting on how to use filter parameters and named filters.
Read more about filters and sorting on how to use sortable parameters
Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
ManufacturersProductId
Manufacturer product identifier
>{Integer}</ManufacturersProductId>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>Status
Status of manufacturer product
Possible domain values can be found here
>{Integer}</Status>Name
Manufacturers name of the product. Also known as Manufacturer Part Number (MPN).
>{String}</Name>InternalNote
Internal note/comment about manufacturers product.
>{String}</InternalNote>LastTimeBuyDate
The last time buy (LTB) date is the last date on which the manufacturer will accept orders for this product.
>{Date}</LastTimeBuyDate>IsPreferred
Manufacturer products can be set as preferred. This is only for information.
>{Boolean}</IsPreferred>IsDefaultForProduct
True if this manufacturers product is the default manufacturers product for the product
>{Boolean}</IsDefaultForProduct>GlobalTradeItemNumber
Global Trade Item Number (GTIN) is a 14 digit identifier for trade items (comprising among others of the former EAN International and Uniform Code Council). Examples of types of GTIN are UPC, EAN, JAN, ISBN
>{String}</GlobalTradeItemNumber>CountryOfOriginCode
Two-character code (ISO 3166) identifying the default country where the product is produced. This value is inherrited from the assigned goods reception(s). If not country of origin is specified for the goods reception(s), country of origin is retrieved from the product. If assigned to multiple goods receptions with different origin, the field will be empty.
>{String}</CountryOfOriginCode>PackageType
Type of wrapping used for the package
Possible domain values can be found here
>{String}</PackageType>PackageQuantity
Total quantity of the product within a package
>{Decimal}</PackageQuantity>ManufacturerId
Manufacturer identifier
>{Integer}</ManufacturerId>ShortName
Shortname/code of the manufacturer
>{String}</ShortName>ManufacturerLink
Manufacturer reference
>{String}</ManufacturerLink>ManufacturersProductId
Manufacturer product identifier
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",Status
Status of manufacturer product
Possible domain values can be found here
": "{Integer}",Name
Manufacturers name of the product. Also known as Manufacturer Part Number (MPN).
": "{String}",InternalNote
Internal note/comment about manufacturers product.
": "{String}",LastTimeBuyDate
The last time buy (LTB) date is the last date on which the manufacturer will accept orders for this product.
": "{Date}",IsPreferred
Manufacturer products can be set as preferred. This is only for information.
": "{Boolean}",IsDefaultForProduct
True if this manufacturers product is the default manufacturers product for the product
": "{Boolean}",GlobalTradeItemNumber
Global Trade Item Number (GTIN) is a 14 digit identifier for trade items (comprising among others of the former EAN International and Uniform Code Council). Examples of types of GTIN are UPC, EAN, JAN, ISBN
": "{String}",CountryOfOriginCode
Two-character code (ISO 3166) identifying the default country where the product is produced. This value is inherrited from the assigned goods reception(s). If not country of origin is specified for the goods reception(s), country of origin is retrieved from the product. If assigned to multiple goods receptions with different origin, the field will be empty.
": "{String}",PackageType
Type of wrapping used for the package
Possible domain values can be found here
": "{String}",PackageQuantity
Total quantity of the product within a package
": "{Decimal}"ManufacturerId
Manufacturer identifier
": "{Integer}",ShortName
Shortname/code of the manufacturer
": "{String}",ManufacturerLink
Manufacturer reference
": "{String}"
List of available operations/actions for this resource.
See the operations documentation for more information about API operations.
Possible error codes the response might return:
| Error 101235 HTTP 404 | Goods reception item {0} not found |
| Error 109354 HTTP 400 | Not allowed to swap the goods, this goods reception item is double locked to the rental contract |
| Error 101420 HTTP 404 | Setting definition not found |
| Error 100199 HTTP 404 | Location is not found |
| Error 108137 HTTP 400 | Standard ManhourRate is not set for Resource |
| Error 107763 HTTP 400 | Only product structures can be set up for line production |
| Error 107764 HTTP 400 | Only product structures can be externally manufactured |
| Error 109643 HTTP 400 | Safetystock cannot be greater than maximumstock |
| Error 103478 HTTP 400 | Purchase price is required |
| Error 102109 HTTP 400 | Supplier is required |
| Error 100047 HTTP 404 | Supplier not found |
| Error 101097 HTTP 404 | Given currency {0} mismatch with currencies of supplier {1} |
| Error 103551 HTTP 400 | IsManufacturedInBatches can only be changed on product structures |
| Error 103554 HTTP 400 | AutomaticallyCreateWorkOrdersForSubstructures can only be changed on product structures |
| Error 104253 HTTP 400 | ProduceInMultipleOf can only be changed on product structures. |
| Error 107694 HTTP 400 | Use line production can only be changed on product structeres |
| Error 106999 HTTP 400 | Sub module 'Projectorder' is not activated in this company |
| Error 106436 HTTP 400 | Unit can only be changed when status is equal to draft (status 1) |
| Error 100167 HTTP 404 | Measurement unit not found |
| Error 104486 HTTP 400 | Unit production is only allowed for measurment units (UNI) of type QTY |
| Error 100200 HTTP 404 | Special handling code not found |
| Error 100092 HTTP 404 | Service template not found |
| Error 103020 HTTP 404 | Qcdoc not found |
| Error 101091 HTTP 404 | Contry of origin is not valid: {0} |
| Error 101124 HTTP 400 | Hardware code already exists |
| Error 106437 HTTP 400 | Type can not be changed when status is not equal to draft (status 1) |
| Error 106680 HTTP 400 | Not allowed when product is of subscription sales type |
| Error 101009 HTTP 400 | The product has a structure. You can only change the product type to a type that can contain a structure. |
| Error 101010 HTTP 400 | The product structure contains operations and can not be changed to become a phantom structure |
| Error 101008 HTTP 400 | Cannot change product type from a physical type to a virtual type |
| Error 101007 HTTP 400 | Cannot change product type from a virtual type to a physical type |
| Error 108988 HTTP 400 | Sales type can not be changed when status is equal to completed(status 9) |
| Error 109184 HTTP 400 | Sales type can not be changed to Subscription from other types. |
| Error 109185 HTTP 400 | Sales type can not be changed to other types from Subscription. |
| Error 109180 HTTP 400 | Sales type can not be changed from Rental/Sale to Sales |
| Error 103021 HTTP 400 | Linkid must be a rental product |
| Error 104760 HTTP 400 | Costing method can't be changed after product has been received |
| Error 104652 HTTP 400 | Both minimum sales price and minimum sales price currency must be given |
| Error 100563 HTTP 400 | Currency {0} is not supported by the system |
| Error 104653 HTTP 400 | Minimum sales price can not be negative |
| Error 106506 HTTP 404 | Image not found |