API

Procurement APIs

GET procurement/returns/{supplierReturnId}/items

List of item for provided supplier return

HTTP method GET
URI https://api.rambase.net/procurement/returns/{supplierReturnId}/items
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {supplierReturnId} Supplier return identifier
Integer, minimum 100000
Maximum page size ($top) 80
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 3245, version 8

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
$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.

CreatedAt Datetime Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
LineNumber Integer Line- or sequence number of the item. The LineNumber is used for sorting items in applications, prints, reports etc.
Note String Additional information regarding the item (free text). Might be visible to customers/suppliers.
ProductId Integer Product identifier.
ProductName String Name of the product.
ProductType String Type of product.
Quantity Decimal Quantity of the supplier return item.
RemainingQuantity Decimal Remaining number of units to be forwarded.
Status Integer Status of the supplier return item.
SupplierReturnItemId Integer Supplier return item identifier.
SuppliersProductName String Suppliers internal name of the product. Retrieved from the product.
SuppliersReferenceNumber String Suppliers/sellers item reference number. Typically to an external system.

Read more about filters and sorting on how to use sortable parameters

CreatedAt Datetime Date and time of creation
LineNumber Integer Line- or sequence number of the item. The LineNumber is used for sorting items in applications, prints, reports etc.
Note String Additional information regarding the item (free text). Might be visible to customers/suppliers.
ProductId Integer Product identifier
ProductName String Name of the product
ProductType String Type of product
Quantity Decimal Quantity of the supplier return item
RemainingQuantity Decimal Remaining number of units to be forwarded
Status Integer Status of the supplier return item
SupplierReturnItemId Integer Supplier return item identifier
SuppliersProductName String Suppliers internal name of the product. Retrieved from the product.
SuppliersReferenceNumber String Suppliers/sellers item reference number. Typically to an external system.

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
<SupplierReturnItems>
2
     <SupplierReturnItem>
3
          <SupplierReturnItemId
SupplierReturnItemId

Supplier return item identifier

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

Status of the supplier return item

Possible domain values can be found here

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

Date and time of creation

>{Datetime}</CreatedAt>
6
          <LineNumber
LineNumber

Line- or sequence number of the item. The LineNumber is used for sorting items in applications, prints, reports etc.

>{Integer}</LineNumber>
7
          <SuppliersReferenceNumber
SuppliersReferenceNumber

Suppliers/sellers item reference number. Typically to an external system.

>{String}</SuppliersReferenceNumber>
8
          <SuppliersProductName
SuppliersProductName

Suppliers internal name of the product. Retrieved from the product.

>{String}</SuppliersProductName>
9
          <Note
Note

Additional information regarding the item (free text). Might be visible to customers/suppliers.

>{String}</Note>
10
          <Quantity
Quantity

Quantity of the supplier return item

>{Decimal}</Quantity>
11
          <RemainingQuantity
RemainingQuantity

Remaining number of units to be forwarded

>{Decimal}</RemainingQuantity>
12
          <Price>
13
               <Currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

>{String}</Currency>
14
               <NetPrice
NetPrice

Final price per unit after deducting all discounts etc.

>{Decimal}</NetPrice>
15
          </Price>
16
          <Totals>
17
               <Currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

>{String}</Currency>
18
               <NetAmount
NetAmount

Final item amount after deducting all discounts etc.

>{Decimal}</NetAmount>
19
          </Totals>
20
          <MeasurementUnit>
21
               <MeasurementUnitId
MeasurementUnitId

Material unit reference

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

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

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

Material unit reference

>{String}</MeasurementUnitLink>
24
          </MeasurementUnit>
25
          <Product>
26
               <ProductId
ProductId

Product identifier

>{Integer}</ProductId>
27
               <Name
Name

Name of the product

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

Description of the item. If not specified, the description is by default copied from the product.

>{String}</Description>
29
               <Type
Type

Type of product

Possible domain values can be found here

>{String}</Type>
30
               <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>
31
               <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
32
          </Product>
33
          <Manufacturer>
34
               <ManufacturerId
ManufacturerId

Manufacturer identifier

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

Shortname/code of the manufacturer

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

Manufacturer reference

>{String}</ManufacturerLink>
37
          </Manufacturer>
38
          <ManufacturersProduct
ManufacturersProduct

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

>
39
               <ManufacturersProductId
ManufacturersProductId

Manufacturer product identifier

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

>{Integer}</ManufacturersProductId>
40
               <Name
Name

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

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

>{String}</Name>
41
               <ManufacturersProductLink
ManufacturersProductLink

Manufacturers product reference

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

>{String}</ManufacturersProductLink>
42
          </ManufacturersProduct>
43
          <HighlightedNotification
HighlightedNotification

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

>
44
               <NotificationId
NotificationId

Notification identifier

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

>{Integer}</NotificationId>
45
               <Status
Status

Status of the notification

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

>{Integer}</Status>
46
               <CreatedAt
CreatedAt

Date and time of creation

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

>{Datetime}</CreatedAt>
47
               <Message
Message

The message from the notification definition, expanded with parameters.

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

>{String}</Message>
48
               <TranslatedMessage
TranslatedMessage

The translated message from the notification definition, expanded with parameters.

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

>{String}</TranslatedMessage>
49
               <NotificationType
NotificationType

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

>
50
                    <NotificationTypeId
NotificationTypeId

Notification type identifier

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

>{String}</NotificationTypeId>
51
                    <Category
Category

Category of notification type (warning, information etc)

Possible domain values can be found here

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

>{String}</Category>
52
                    <NotificationTypeLink
NotificationTypeLink

Notification type reference

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

>{String}</NotificationTypeLink>
53
               </NotificationType>
54
               <NotificationLink
NotificationLink

Notification reference

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

>{String}</NotificationLink>
55
          </HighlightedNotification>
56
          <SupplierReturnItemLink
SupplierReturnItemLink

Supplier return item reference

>{String}</SupplierReturnItemLink>
57
     </SupplierReturnItem>
58
     <Paging
Paging

Detailed paging information for this list.

>
59
          <PageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>
60
          <Position
Position

Position of the first element in the list

>{Integer}</Position>
61
          <Page
Page

Page index

>{Integer}</Page>
62
          <FirstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

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

>{String}</FirstPageKey>
63
          <FirstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>
64
          <PreviousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

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

>{String}</PreviousPageKey>
65
          <PreviousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>
66
          <NextPageKey
NextPageKey

Page key to use for navigating to next page in the list

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

>{String}</NextPageKey>
67
          <NextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>
68
          <LastPageKey
LastPageKey

Page key to use for navigating to last page in the list

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

>{String}</LastPageKey>
69
          <LastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>
70
          <Size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>
71
     </Paging>
72
</SupplierReturnItems>
1
{
2
     "supplierReturnItems": [
3
          {
4
               "supplierReturnItemId
SupplierReturnItemId

Supplier return item identifier

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

Status of the supplier return item

Possible domain values can be found here

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

Date and time of creation

": "{Datetime}",
7
               "lineNumber
LineNumber

Line- or sequence number of the item. The LineNumber is used for sorting items in applications, prints, reports etc.

": "{Integer}",
8
               "suppliersReferenceNumber
SuppliersReferenceNumber

Suppliers/sellers item reference number. Typically to an external system.

": "{String}",
9
               "suppliersProductName
SuppliersProductName

Suppliers internal name of the product. Retrieved from the product.

": "{String}",
10
               "note
Note

Additional information regarding the item (free text). Might be visible to customers/suppliers.

": "{String}",
11
               "quantity
Quantity

Quantity of the supplier return item

": "{Decimal}",
12
               "remainingQuantity
RemainingQuantity

Remaining number of units to be forwarded

": "{Decimal}",
13
               "price": {
14
                    "currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

": "{String}",
15
                    "netPrice
NetPrice

Final price per unit after deducting all discounts etc.

": "{Decimal}"
16
               },
17
               "totals": {
18
                    "currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

": "{String}",
19
                    "netAmount
NetAmount

Final item amount after deducting all discounts etc.

": "{Decimal}"
20
               },
21
               "measurementUnit": {
22
                    "measurementUnitId
MeasurementUnitId

Material unit reference

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

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

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

Material unit reference

": "{String}"
25
               },
26
               "product": {
27
                    "productId
ProductId

Product identifier

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

Name of the product

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

Description of the item. If not specified, the description is by default copied from the product.

": "{String}",
30
                    "type
Type

Type of product

Possible domain values can be found here

": "{String}",
31
                    "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}",
32
                    "productLink
ProductLink

Product reference

": "{String}"
33
               },
34
               "manufacturer": {
35
                    "manufacturerId
ManufacturerId

Manufacturer identifier

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

Shortname/code of the manufacturer

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

Manufacturer reference

": "{String}"
38
               },
39
               "manufacturersProduct
ManufacturersProduct

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

": {
40
                    "manufacturersProductId
ManufacturersProductId

Manufacturer product identifier

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

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

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

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

": "{String}",
42
                    "manufacturersProductLink
ManufacturersProductLink

Manufacturers product reference

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

": "{String}"
43
               },
44
               "highlightedNotification
HighlightedNotification

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

": {
45
                    "notificationId
NotificationId

Notification identifier

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

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

Status of the notification

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

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

Date and time of creation

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

": "{Datetime}",
48
                    "message
Message

The message from the notification definition, expanded with parameters.

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

": "{String}",
49
                    "translatedMessage
TranslatedMessage

The translated message from the notification definition, expanded with parameters.

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

": "{String}",
50
                    "notificationType
NotificationType

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

": {
51
                         "notificationTypeId
NotificationTypeId

Notification type identifier

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

": "{String}",
52
                         "category
Category

Category of notification type (warning, information etc)

Possible domain values can be found here

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

": "{String}",
53
                         "notificationTypeLink
NotificationTypeLink

Notification type reference

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

": "{String}"
54
                    },
55
                    "notificationLink
NotificationLink

Notification reference

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

": "{String}"
56
               },
57
               "supplierReturnItemLink
SupplierReturnItemLink

Supplier return item reference

": "{String}"
58
          }
59
     ],
60
     "paging
Paging

Detailed paging information for this list.

": {
61
          "pageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

": "{Integer}",
62
          "position
Position

Position of the first element in the list

": "{Integer}",
63
          "page
Page

Page index

": "{Integer}",
64
          "firstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

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

": "{String}",
65
          "firstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

": "{String}",
66
          "previousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

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

": "{String}",
67
          "previousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

": "{String}",
68
          "nextPageKey
NextPageKey

Page key to use for navigating to next page in the list

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

": "{String}",
69
          "nextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

": "{String}",
70
          "lastPageKey
LastPageKey

Page key to use for navigating to last page in the list

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

": "{String}",
71
          "lastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

": "{String}",
72
          "size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

": "{Integer}"
73
     }
74
}

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 100147 HTTP 404 Notification type not found