API

Product APIs

GET product/products/{productId}/manufacturers-products/{manufacturerProductId}

Manufacturers product details for provided identifier

HTTP method GET
URI https://api.rambase.net/product/products/{productId}/manufacturers-products/{manufacturerProductId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {productId} Product identifier
Integer, minimum 10000
- URI parameter {manufacturerProductId} Manufacturer product identifier
Integer, minimum 100000
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 3461, version 5

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.
$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. 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
<ManufacturersProduct>
2
     <ManufacturersProductId
ManufacturersProductId

Manufacturer product identifier

>{Integer}</ManufacturersProductId>
3
     <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
4
     <Status
Status

Status of manufacturer product

Possible domain values can be found here

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

Manufacturers name of the product. Also known as Manufacturer Part Number (MPN).

>{String}</Name>
6
     <InternalNote
InternalNote

Internal note/comment about manufacturers product.

>{String}</InternalNote>
7
     <LastTimeBuyDate
LastTimeBuyDate

The last time buy (LTB) date is the last date on which the manufacturer will accept orders for this product.

>{Date}</LastTimeBuyDate>
8
     <IsPreferred
IsPreferred

Manufacturer products can be set as preferred. This is only for information.

>{Boolean}</IsPreferred>
9
     <IsDefaultForProduct
IsDefaultForProduct

True if this manufacturers product is the default manufacturers product for the product

>{Boolean}</IsDefaultForProduct>
10
     <GlobalTradeItemNumber
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>
11
     <CountryOfOriginCode
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>
12
     <Package>
13
          <PackageType
PackageType

Type of wrapping used for the package

Possible domain values can be found here

>{String}</PackageType>
14
          <PackageQuantity
PackageQuantity

Total quantity of the product within a package

>{Decimal}</PackageQuantity>
15
     </Package>
16
     <Manufacturer>
17
          <ManufacturerId
ManufacturerId

Manufacturer identifier

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

Shortname/code of the manufacturer

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

Manufacturer reference

>{String}</ManufacturerLink>
20
     </Manufacturer>
21
</ManufacturersProduct>
1
{
2
     "manufacturersProduct": {
3
          "manufacturersProductId
ManufacturersProductId

Manufacturer product identifier

": "{Integer}",
4
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
5
          "status
Status

Status of manufacturer product

Possible domain values can be found here

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

Manufacturers name of the product. Also known as Manufacturer Part Number (MPN).

": "{String}",
7
          "internalNote
InternalNote

Internal note/comment about manufacturers product.

": "{String}",
8
          "lastTimeBuyDate
LastTimeBuyDate

The last time buy (LTB) date is the last date on which the manufacturer will accept orders for this product.

": "{Date}",
9
          "isPreferred
IsPreferred

Manufacturer products can be set as preferred. This is only for information.

": "{Boolean}",
10
          "isDefaultForProduct
IsDefaultForProduct

True if this manufacturers product is the default manufacturers product for the product

": "{Boolean}",
11
          "globalTradeItemNumber
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}",
12
          "countryOfOriginCode
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}",
13
          "package": {
14
               "packageType
PackageType

Type of wrapping used for the package

Possible domain values can be found here

": "{String}",
15
               "packageQuantity
PackageQuantity

Total quantity of the product within a package

": "{Decimal}"
16
          },
17
          "manufacturer": {
18
               "manufacturerId
ManufacturerId

Manufacturer identifier

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

Shortname/code of the manufacturer

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

Manufacturer reference

": "{String}"
21
          }
22
     }
23
}

Possible error codes the response might return:

Error 100204 HTTP 404 Manufacturer not found
Error 100089 HTTP 404 Product {0} not found