Product APIs
Creates a new shared product
| HTTP method | POST |
| URI | https://api.rambase.net/product/shared-products |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Successful HTTP status code | 201 |
| API resource identifier | 7167, version 1 |
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
Name of the product
>{String}</Name>Description
The origin description of the product
This field is optional.
>{String}</Description>Weight
The weight of the product in kilograms.
Minimum value: 0
This field is optional.
>{Decimal}</Weight>Type
Required/mandatory field
The origin type of the product. The inital value when uploaded from other company or when created directly in shared products
Applicable domain values can be found here
>{String}</Type>MeasurementUnit
Measurement unit used for this product, both in sales and purchase.
This field is optional.
>MeasurementUnitId
Measurement unit identifier
Minimum value: 100
This field is optional.
>{Integer}</MeasurementUnitId>Manufacturer
Manufacturer of the product
This field is optional.
>ManufacturerId
Manufacturer identifier
Minimum value: 1000
This field is optional.
>{Integer}</ManufacturerId>Dimensions
This field is optional.
>Width
Width of the product in centimetres
Minimum value: 0
This field is optional.
>{Decimal}</Width>Height
Height of the product in centimetres
Minimum value: 0
This field is optional.
>{Decimal}</Height>Length
Length of the product in centimetres
Minimum value: 0
This field is optional.
>{Decimal}</Length>Volume
Volume of the product in cubic centimetres. Volume is calculated automatically as L* W* H (when the volume field is empty and L,W ,H have values). Volume can also be changed manually
Minimum value: 0
This field is optional.
>{Decimal}</Volume>Name
Required/mandatory field
Name of the product
": "{String}",Description
The origin description of the product
This field is optional.
": "{String}",Weight
The weight of the product in kilograms.
Minimum value: 0
This field is optional.
": "{Decimal}",Type
Required/mandatory field
The origin type of the product. The inital value when uploaded from other company or when created directly in shared products
Applicable domain values can be found here
": "{String}",MeasurementUnit
Measurement unit used for this product, both in sales and purchase.
This field is optional.
": {MeasurementUnitId
Measurement unit identifier
Minimum value: 100
This field is optional.
": "{Integer}"Manufacturer
Manufacturer of the product
This field is optional.
": {ManufacturerId
Manufacturer identifier
Minimum value: 1000
This field is optional.
": "{Integer}"Dimensions
This field is optional.
": {Width
Width of the product in centimetres
Minimum value: 0
This field is optional.
": "{Decimal}",Height
Height of the product in centimetres
Minimum value: 0
This field is optional.
": "{Decimal}",Length
Length of the product in centimetres
Minimum value: 0
This field is optional.
": "{Decimal}",Volume
Volume of the product in cubic centimetres. Volume is calculated automatically as L* W* H (when the volume field is empty and L,W ,H have values). Volume can also be changed manually
Minimum value: 0
This field is optional.
": "{Decimal}"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] |
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.
SharedProductId
Shared product identifier
>{Integer}</SharedProductId>Status
Status of the shared product
Possible domain values can be found here
>{Integer}</Status>Name
Name of the product
>{String}</Name>Description
The origin description of the product
>{String}</Description>Weight
The weight of the product in kilograms.
>{Decimal}</Weight>Type
The origin type of the product. The inital value when uploaded from other company or when created directly in shared products
Possible domain values can be found here
>{String}</Type>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>UpdatedAt
Date and time of update
>{Datetime}</UpdatedAt>ProductExistsLocallyForCompany
The shared product exists in this company's article/product archive
>{Boolean}</ProductExistsLocallyForCompany>MeasurementUnit
Measurement unit used for this product, both in sales and purchase.
>MeasurementUnitId
Measurement unit identifier
>{Integer}</MeasurementUnitId>MeasurementUnitLink
Material unit reference
>{String}</MeasurementUnitLink>Manufacturer
Manufacturer of the product
>ManufacturerId
Manufacturer identifier
>{Integer}</ManufacturerId>ManufacturerLink
Manufacturer reference
>{String}</ManufacturerLink>Width
Width of the product in centimetres
>{Decimal}</Width>Height
Height of the product in centimetres
>{Decimal}</Height>Length
Length of the product in centimetres
>{Decimal}</Length>Volume
Volume of the product in cubic centimetres. Volume is calculated automatically as L* W* H (when the volume field is empty and L,W ,H have values). Volume can also be changed manually
>{Decimal}</Volume>SourceCompany
Source company, which company is the source of the shared product (which company published the local product to the shared products).
>CompanyId
Company identifier
>{Integer}</CompanyId>Name
Name of company
>{String}</Name>Database
Abbreviation/code to identify the company
>{String}</Database>CompanyLink
Company reference
>{String}</CompanyLink>SharedProductId
Shared product identifier
": "{Integer}",Status
Status of the shared product
Possible domain values can be found here
": "{Integer}",Name
Name of the product
": "{String}",Description
The origin description of the product
": "{String}",Weight
The weight of the product in kilograms.
": "{Decimal}",Type
The origin type of the product. The inital value when uploaded from other company or when created directly in shared products
Possible domain values can be found here
": "{String}",CreatedAt
Date and time of creation
": "{Datetime}",UpdatedAt
Date and time of update
": "{Datetime}",ProductExistsLocallyForCompany
The shared product exists in this company's article/product archive
": "{Boolean}",MeasurementUnit
Measurement unit used for this product, both in sales and purchase.
": {MeasurementUnitId
Measurement unit identifier
": "{Integer}",MeasurementUnitLink
Material unit reference
": "{String}"Manufacturer
Manufacturer of the product
": {ManufacturerId
Manufacturer identifier
": "{Integer}",ManufacturerLink
Manufacturer reference
": "{String}"Width
Width of the product in centimetres
": "{Decimal}",Height
Height of the product in centimetres
": "{Decimal}",Length
Length of the product in centimetres
": "{Decimal}",Volume
Volume of the product in cubic centimetres. Volume is calculated automatically as L* W* H (when the volume field is empty and L,W ,H have values). Volume can also be changed manually
": "{Decimal}"SourceCompany
Source company, which company is the source of the shared product (which company published the local product to the shared products).
": {CompanyId
Company identifier
": "{Integer}",Name
Name of company
": "{String}",Database
Abbreviation/code to identify the company
": "{String}",CompanyLink
Company 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 102667 HTTP 404 | Customer group not found |
| 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 107276 HTTP 400 | Serial number of registered rental unit cannot be modified |
| Error 109482 HTTP 400 | The availability start date for non-owners must not precede the rental unit's availability date |
| Error 109483 HTTP 400 | The end date of availability for non-owners cannot be later than the end date of the rental unit |
| 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 |