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 100204 HTTP 404 | Manufacturer not found |
| Error 100167 HTTP 404 | Measurement unit not found |
| Error 110197 HTTP 400 | Product Identifier cannot be provided unless a source company is specified. |
| Error 110196 HTTP 400 | Source company missing |