Product APIs
List of all manufacturers products for provided product
| HTTP method | GET |
| 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 |
| Maximum page size ($top) | 80 |
| Custom fields | Custom fields supported |
| Successful HTTP status code | 200 |
| API resource identifier | 3478, 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.
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 |
| $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. |
| $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. |
| $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. |
| $format String, optional | Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json" |
| $showCustomFields Boolean, optional | Set to "true" to include custom fields. Default value is false. |
| $top String, optional | Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10. |
| $pageKey String, optional | Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response. |
| $filter String, optional | Use to filter the result list, see the Filtering and sorting page for more information. |
| $orderby String, optional | Use to order the result list, see the Filtering and sorting page for more information. |
| $inlinecount String, optional | Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none" |
Read more about filters and sorting on how to use filter parameters and named filters.
| NotClosed() Named filter | Manufacturers products not closed (status < 9) |
| CountryOfOriginCode String | 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. |
| CreatedAt Datetime | Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| GlobalTradeItemNumber String | 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. |
| InternalNote String | Internal note/comment about manufacturers product. |
| IsPreferred Boolean | Manufacturer products can be set as preferred. This is only for information.. |
| LastTimeBuyDate Date | The last time buy (LTB) date is the last date on which the manufacturer will accept orders for this product.. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| ManufacturerId Integer | Manufacturer identifier. |
| ManufacturersProductId Integer | Manufacturer product identifier. |
| Name String | Manufacturers name of the product. Also known as Manufacturer Part Number (MPN). |
| PackageQuantity Decimal | Total quantity of the product within a package. |
| PackageType String | Type of wrapping used for the package. |
| Status Integer | Status of manufacturer product. |
Read more about filters and sorting on how to use sortable parameters
| CountryOfOriginCode String | 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. |
| CreatedAt Datetime | Date and time of creation |
| GlobalTradeItemNumber String | 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 |
| InternalNote String | Internal note/comment about manufacturers product. |
| IsPreferred Boolean | Manufacturer products can be set as preferred. This is only for information. |
| LastTimeBuyDate Date | The last time buy (LTB) date is the last date on which the manufacturer will accept orders for this product. |
| ManufacturerId Integer | Manufacturer identifier |
| ManufacturersProductId Integer | Manufacturer product identifier |
| Name String | Manufacturers name of the product. Also known as Manufacturer Part Number (MPN). |
| PackageQuantity Decimal | Total quantity of the product within a package |
| PackageType String | Type of wrapping used for the package |
| Status Integer | Status of manufacturer product |
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.
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>ManufacturersProductLink
Manufacturers product reference
>{String}</ManufacturersProductLink>Paging
Detailed paging information for this list.
>PageSize
Number of elements in the list, as defined in $top. Default is 10.
>{Integer}</PageSize>Position
Position of the first element in the list
>{Integer}</Position>Page
Page index
>{Integer}</Page>FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
>{String}</FirstPage>PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
>{String}</PreviousPage>NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
>{String}</NextPage>LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
>{String}</LastPage>Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
>{Integer}</Size>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}"ManufacturersProductLink
Manufacturers product reference
": "{String}"Paging
Detailed paging information for this list.
": {PageSize
Number of elements in the list, as defined in $top. Default is 10.
": "{Integer}",Position
Position of the first element in the list
": "{Integer}",Page
Page index
": "{Integer}",FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
": "{String}",PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
": "{String}",NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
": "{String}",LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
": "{String}",Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
": "{Integer}"
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 99946 HTTP 400 | {0}: Missing mandatory arguments {1} |
| Error 100089 HTTP 404 | Product {0} not found |