API

Rental APIs

GET rental/contract/{rentalContractId}/shipping-advice-items

List of all shipping advice items which have been forwarded from a specific rental contract

HTTP method GET
URI https://api.rambase.net/rental/contract/{rentalContractId}/shipping-advice-items
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {rentalContractId} Rental contract identifier
Integer, minimum 100000
Maximum page size ($top) 80
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 6744, version 3

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.

ApprovalNotification() Named filter Shipping advices with notifications of category A (Approval) in status 2 or 3
InfoNotification() Named filter Shipping advice items with notification of category I (Information)
MyItems() Named filter Items which belong to a shipping advice the current user is either assigned to, sales assistent for or account manager for.
Assignee Integer The user who has been assigned to work with this object. Available macros: currentUser()
ContainingNotificationTypeId Integer Notification type identifier.
CreatedAt Datetime Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
Currency String Three character code following the ISO 4217 standard.
CustomerFirstname String Secondary name of a company or firstname of a person.
CustomerId Integer Customer identifier.
CustomerName String Name of customer (name of company or surname/familyname/lastname of a person).
CustomersReferenceNumber String Customers item reference number. Typically to the customers internal system.
LocationShortName String Unique abbreviation/short name of the location.
ManufacturerId Integer Manufacturer identifier.
ManufacturerShortName String Shortname/code of the manufacturer.
Note String Additional information regarding the item (free text). Might be visible to customers/suppliers.
ProductDescription String Description of the item. If not specified, the description is by default copied from the product.
ProductId Integer Product identifier.
ProductName String Name of the product.
ProductType String Type of product.
Quantity Decimal Quantity of the shipping advice item.
RemainingQuantity Decimal Remaining number of units to be forwarded.
ShippingAdviceId Integer Shipping advice identifier.
ShippingAdviceItemId Integer Item-/line-number of the shipping advice.
Status Integer Status of the shipping advice item (0-9).

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

Assignee Integer The user who has been assigned to work with this object.
ContainingNotificationTypeId Integer Notification type identifier
CreatedAt Datetime Date and time of creation
Currency String Three character code following the ISO 4217 standard
CustomerFirstname String Secondary name of a company or firstname of a person
CustomerId Integer Customer identifier
CustomerName String Name of customer (name of company or surname/familyname/lastname of a person)
CustomersReferenceNumber String Customers item reference number. Typically to the customers internal system.
LocationShortName String Unique abbreviation/short name of the location
ManufacturerId Integer Manufacturer identifier
ManufacturerShortName String Shortname/code of the manufacturer
Note String Additional information regarding the item (free text). Might be visible to customers/suppliers.
ProductDescription String Description of the item. If not specified, the description is by default copied from the product.
ProductId Integer Product identifier
ProductName String Name of the product
ProductType String Type of product
Quantity Decimal Quantity of the shipping advice item
RemainingQuantity Decimal Remaining number of units to be forwarded.
ShippingAdviceId Integer Shipping advice identifier
ShippingAdviceItemId Integer Item-/line-number of the shipping advice
Status Integer Status of the shipping advice item (0-9)

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
<ShippingAdviceItems>
2
     <ShippingAdviceItem>
3
          <ShippingAdviceItemId
ShippingAdviceItemId

Item-/line-number of the shipping advice

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

Status of the shipping advice item (0-9)

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
          <ScheduledShippingDate
ScheduledShippingDate

Date when the goods was/will be shipped from the warehouse.

>{Date}</ScheduledShippingDate>
8
          <CustomersReferenceNumber
CustomersReferenceNumber

Customers item reference number. Typically to the customers internal system.

>{String}</CustomersReferenceNumber>
9
          <ProductDescription
ProductDescription

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

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

Quantity of the shipping advice item

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

Remaining number of units to be forwarded.

>{Decimal}</RemainingQuantity>
12
          <MeasurementUnit>
13
               <MeasurementUnitId
MeasurementUnitId

Measurement unit identifier

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

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

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

Material unit reference

>{String}</MeasurementUnitLink>
16
          </MeasurementUnit>
17
          <Product>
18
               <ProductId
ProductId

Product identifier

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

Name of the product

>{String}</Name>
20
               <Type
Type

Type of product

Possible domain values can be found here

>{String}</Type>
21
               <Manufacturer>
22
                    <ManufacturerId
ManufacturerId

Manufacturer identifier

>{Integer}</ManufacturerId>
23
                    <ManufacturerLink
ManufacturerLink

Manufacturer reference

>{String}</ManufacturerLink>
24
               </Manufacturer>
25
               <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
26
          </Product>
27
          <ForwardedFrom
ForwardedFrom

The preceding/previous/source item.

>
28
               <ForwardedQuantity
ForwardedQuantity

The quantity forwarded to this item.

>{Decimal}</ForwardedQuantity>
29
               <ForwardedFromItem>
30
                    <ItemId
ItemId

Identifier of the object

>{Integer}</ItemId>
31
                    <Object>
32
                         <ObjectId
ObjectId

Identifier of the object

>{Integer}</ObjectId>
33
                         <ObjectType
ObjectType

Type of object

>{String}</ObjectType>
34
                         <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
35
                    </Object>
36
                    <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

>{String}</RamBaseKey>
37
                    <ItemLink
ItemLink

API reference to the item

>{String}</ItemLink>
38
               </ForwardedFromItem>
39
          </ForwardedFrom>
40
          <HighlightedNotification
HighlightedNotification

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

>
41
               <NotificationId
NotificationId

Notification identifier

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

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

Status of the notification

Possible domain values can be found here

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

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

Date and time of creation

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

>{Datetime}</CreatedAt>
44
               <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=ShippingAdviceItem.HighlightedNotification in your request URI to get this field

>{String}</Message>
45
               <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=ShippingAdviceItem.HighlightedNotification in your request URI to get this field

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

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

>
47
                    <NotificationTypeId
NotificationTypeId

Notification type identifier

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

>{String}</NotificationTypeId>
48
                    <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=ShippingAdviceItem.HighlightedNotification in your request URI to get this field

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

Notification type reference

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

>{String}</NotificationTypeLink>
50
               </NotificationType>
51
               <NotificationLink
NotificationLink

Notification reference

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

>{String}</NotificationLink>
52
          </HighlightedNotification>
53
          <ShippingAdvice>
54
               <ShippingAdviceId
ShippingAdviceId

Shipping advice identifier

>{Integer}</ShippingAdviceId>
55
               <Customer>
56
                    <CustomerId
CustomerId

Customer identifier

>{Integer}</CustomerId>
57
                    <Name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

>{String}</Name>
58
                    <Firstname
Firstname

Secondary name of a company or firstname of a person

>{String}</Firstname>
59
                    <CustomerLink
CustomerLink

Customer reference

>{String}</CustomerLink>
60
               </Customer>
61
               <ShippingAdviceLink
ShippingAdviceLink

Shipping advice reference

>{String}</ShippingAdviceLink>
62
          </ShippingAdvice>
63
          <ShippingAdviceItemLink
ShippingAdviceItemLink

Shipping advice item reference

>{String}</ShippingAdviceItemLink>
64
     </ShippingAdviceItem>
65
     <Paging
Paging

Detailed paging information for this list.

>
66
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
69
          <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>
70
          <FirstPage
FirstPage

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

>{String}</FirstPage>
71
          <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>
72
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
73
          <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>
74
          <NextPage
NextPage

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

>{String}</NextPage>
75
          <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>
76
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
78
     </Paging>
79
</ShippingAdviceItems>
1
{
2
     "shippingAdviceItems": [
3
          {
4
               "shippingAdviceItemId
ShippingAdviceItemId

Item-/line-number of the shipping advice

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

Status of the shipping advice item (0-9)

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
               "scheduledShippingDate
ScheduledShippingDate

Date when the goods was/will be shipped from the warehouse.

": "{Date}",
9
               "customersReferenceNumber
CustomersReferenceNumber

Customers item reference number. Typically to the customers internal system.

": "{String}",
10
               "productDescription
ProductDescription

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

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

Quantity of the shipping advice item

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

Remaining number of units to be forwarded.

": "{Decimal}",
13
               "measurementUnit": {
14
                    "measurementUnitId
MeasurementUnitId

Measurement unit identifier

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

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

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

Material unit reference

": "{String}"
17
               },
18
               "product": {
19
                    "productId
ProductId

Product identifier

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

Name of the product

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

Type of product

Possible domain values can be found here

": "{String}",
22
                    "manufacturer": {
23
                         "manufacturerId
ManufacturerId

Manufacturer identifier

": "{Integer}",
24
                         "manufacturerLink
ManufacturerLink

Manufacturer reference

": "{String}"
25
                    },
26
                    "productLink
ProductLink

Product reference

": "{String}"
27
               },
28
               "forwardedFrom
ForwardedFrom

The preceding/previous/source item.

": {
29
                    "forwardedQuantity
ForwardedQuantity

The quantity forwarded to this item.

": "{Decimal}",
30
                    "forwardedFromItem": {
31
                         "itemId
ItemId

Identifier of the object

": "{Integer}",
32
                         "object": {
33
                              "objectId
ObjectId

Identifier of the object

": "{Integer}",
34
                              "objectType
ObjectType

Type of object

": "{String}",
35
                              "objectLink
ObjectLink

API reference to the object

": "{String}"
36
                         },
37
                         "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

": "{String}",
38
                         "itemLink
ItemLink

API reference to the item

": "{String}"
39
                    }
40
               },
41
               "highlightedNotification
HighlightedNotification

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

": {
42
                    "notificationId
NotificationId

Notification identifier

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

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

Status of the notification

Possible domain values can be found here

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

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

Date and time of creation

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

": "{Datetime}",
45
                    "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=ShippingAdviceItem.HighlightedNotification in your request URI to get this field

": "{String}",
46
                    "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=ShippingAdviceItem.HighlightedNotification in your request URI to get this field

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

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

": {
48
                         "notificationTypeId
NotificationTypeId

Notification type identifier

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

": "{String}",
49
                         "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=ShippingAdviceItem.HighlightedNotification in your request URI to get this field

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

Notification type reference

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

": "{String}"
51
                    },
52
                    "notificationLink
NotificationLink

Notification reference

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

": "{String}"
53
               },
54
               "shippingAdvice": {
55
                    "shippingAdviceId
ShippingAdviceId

Shipping advice identifier

": "{Integer}",
56
                    "customer": {
57
                         "customerId
CustomerId

Customer identifier

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

Name of customer (name of company or surname/familyname/lastname of a person)

": "{String}",
59
                         "firstname
Firstname

Secondary name of a company or firstname of a person

": "{String}",
60
                         "customerLink
CustomerLink

Customer reference

": "{String}"
61
                    },
62
                    "shippingAdviceLink
ShippingAdviceLink

Shipping advice reference

": "{String}"
63
               },
64
               "shippingAdviceItemLink
ShippingAdviceItemLink

Shipping advice item reference

": "{String}"
65
          }
66
     ],
67
     "paging
Paging

Detailed paging information for this list.

": {
68
          "pageSize
PageSize

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

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

Position of the first element in the list

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

Page index

": "{Integer}",
71
          "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}",
72
          "firstPage
FirstPage

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

": "{String}",
73
          "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}",
74
          "previousPage
PreviousPage

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

": "{String}",
75
          "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}",
76
          "nextPage
NextPage

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

": "{String}",
77
          "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}",
78
          "lastPage
LastPage

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

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

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

": "{Integer}"
80
     }
81
}

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
Error 100167 HTTP 404 Measurement unit not found