API

Product APIs

GET product/shared-products/{sharedProductId}

Shared product details for the provided identifier

HTTP method GET
URI https://api.rambase.net/product/shared-products/{sharedProductId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {sharedProductId} Shared product identifier
Integer, minimum 10000
Successful HTTP status code 200
API resource identifier 7076, version 15

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.

Format:
1
1

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.

$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]
$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
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$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.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.

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. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<SharedProduct>
2
     <SharedProductId
SharedProductId

Shared product identifier

>{Integer}</SharedProductId>
3
     <Status
Status

Status of the shared product

Possible domain values can be found here

>{Integer}</Status>
4
     <Name
Name

Name of the product

>{String}</Name>
5
     <Description
Description

The origin description of the product

>{String}</Description>
6
     <Weight
Weight

The weight of the product in kilograms.

>{Decimal}</Weight>
7
     <Type
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>
8
     <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
9
     <UpdatedAt
UpdatedAt

Date and time of update

>{Datetime}</UpdatedAt>
10
     <ProductExistsLocallyForCompany
ProductExistsLocallyForCompany

The shared product exists in this company's article/product archive

>{Boolean}</ProductExistsLocallyForCompany>
11
     <MeasurementUnit
MeasurementUnit

Measurement unit used for this product, both in sales and purchase.

>
12
          <MeasurementUnitId
MeasurementUnitId

Measurement unit identifier

>{Integer}</MeasurementUnitId>
13
          <Unit
Unit

Measurement unit (ex. mm, km, dl, kg)

This field is greyed out because it is an expandable field. You have to add $expand=MeasurementUnit.Unit in your request URI to get this field

>{String}</Unit>
14
          <MeasurementUnitLink
MeasurementUnitLink

Material unit reference

>{String}</MeasurementUnitLink>
15
     </MeasurementUnit>
16
     <Manufacturer
Manufacturer

Manufacturer of the product

>
17
          <ManufacturerId
ManufacturerId

Manufacturer identifier

>{Integer}</ManufacturerId>
18
          <ShortName
ShortName

Shortname/code of the manufacturer

This field is greyed out because it is an expandable field. You have to add $expand=Manufacturer.ShortName in your request URI to get this field

>{String}</ShortName>
19
          <ManufacturerLink
ManufacturerLink

Manufacturer reference

>{String}</ManufacturerLink>
20
     </Manufacturer>
21
     <Dimensions>
22
          <Width
Width

Width of the product in centimetres

>{Decimal}</Width>
23
          <Height
Height

Height of the product in centimetres

>{Decimal}</Height>
24
          <Length
Length

Length of the product in centimetres

>{Decimal}</Length>
25
          <Volume
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>
26
     </Dimensions>
27
     <SourceCompany
SourceCompany

Source company, which company is the source of the shared product (which company published the local product to the shared products).

>
28
          <CompanyId
CompanyId

Company identifier

>{Integer}</CompanyId>
29
          <Name
Name

Name of company

>{String}</Name>
30
          <Database
Database

Abbreviation/code to identify the company

>{String}</Database>
31
          <CompanyLink
CompanyLink

Company reference

>{String}</CompanyLink>
32
     </SourceCompany>
33
</SharedProduct>
1
{
2
     "sharedProduct": {
3
          "sharedProductId
SharedProductId

Shared product identifier

": "{Integer}",
4
          "status
Status

Status of the shared product

Possible domain values can be found here

": "{Integer}",
5
          "name
Name

Name of the product

": "{String}",
6
          "description
Description

The origin description of the product

": "{String}",
7
          "weight
Weight

The weight of the product in kilograms.

": "{Decimal}",
8
          "type
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}",
9
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
10
          "updatedAt
UpdatedAt

Date and time of update

": "{Datetime}",
11
          "productExistsLocallyForCompany
ProductExistsLocallyForCompany

The shared product exists in this company's article/product archive

": "{Boolean}",
12
          "measurementUnit
MeasurementUnit

Measurement unit used for this product, both in sales and purchase.

": {
13
               "measurementUnitId
MeasurementUnitId

Measurement unit identifier

": "{Integer}",
14
               "unit
Unit

Measurement unit (ex. mm, km, dl, kg)

This field is greyed out because it is an expandable field. You have to add $expand=MeasurementUnit.Unit in your request URI to get this field

": "{String}",
15
               "measurementUnitLink
MeasurementUnitLink

Material unit reference

": "{String}"
16
          },
17
          "manufacturer
Manufacturer

Manufacturer of the product

": {
18
               "manufacturerId
ManufacturerId

Manufacturer identifier

": "{Integer}",
19
               "shortName
ShortName

Shortname/code of the manufacturer

This field is greyed out because it is an expandable field. You have to add $expand=Manufacturer.ShortName in your request URI to get this field

": "{String}",
20
               "manufacturerLink
ManufacturerLink

Manufacturer reference

": "{String}"
21
          },
22
          "dimensions": {
23
               "width
Width

Width of the product in centimetres

": "{Decimal}",
24
               "height
Height

Height of the product in centimetres

": "{Decimal}",
25
               "length
Length

Length of the product in centimetres

": "{Decimal}",
26
               "volume
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}"
27
          },
28
          "sourceCompany
SourceCompany

Source company, which company is the source of the shared product (which company published the local product to the shared products).

": {
29
               "companyId
CompanyId

Company identifier

": "{Integer}",
30
               "name
Name

Name of company

": "{String}",
31
               "database
Database

Abbreviation/code to identify the company

": "{String}",
32
               "companyLink
CompanyLink

Company reference

": "{String}"
33
          }
34
     }
35
}

Possible error codes the response might return:

Error 100140 HTTP 404 Company not found
Error 100167 HTTP 404 Measurement unit not found