API

Logistics APIs

GET sales/order-items/items-for-shipping

Lists order items ready for shipment as it has reached scheduled shipping date, and shipping advice items in status 0 that the orders have been forwarded to.

HTTP method GET
URI https://api.rambase.net/sales/order-items/items-for-shipping
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 3708, version 45

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 Sales order items with notifications of category A (approvals)
IsNonStockProduct() Named filter Items with products that are not using assignments
ItemsWithStock() Named filter Sales order items with assignments from stock
NoApprNotification() Named filter Sales order items without notifications of category A (approvals)
NoStopNotification() Named filter Sales order items without notifications of category S (stopped)
OnStockAndNonStock() Named filter Sales order items with assignments from stock and products not using assignments
StoppedNotification() Named filter Sales order items with notifications of category S (stopped)
AllocatedStockQuantity Decimal The quantity of this item which do have assignments from stock.
ConfirmedDeliveryDate Date Confirmed date of delivery. Date of which the customer can expect the arriving goods. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
ContainingNotificationMessage String The message from the notification definition, expanded with parameters.
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()
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.
IsNonStock Boolean True if this is a non-physical product which are no using assignments from the assignment archive.
ItemId Integer Item-number of the object.
Location String Unique abbreviation/short name of the location.
ProductDescription String Description of the product.
ProductId Integer Product identifier.
ProductName String Name of the product.
ProductType String Type of product.
Quantity Decimal Quantity of the object.
RemainingQuantity Decimal Remaining number of units to be forwarded.
RequestedDeliveryDate Date The delivery date as requested by the customer. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
SalesOrderId Integer Sales order identifier.
SalesOrderItemId Integer Sales order item identifier.
ScheduledShippingDate Date Date when the goods was/will be shipped from the warehouse. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
ShippingServiceName String Name of shipping service.
Status Integer Status of the item/object.

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

AllocatedStockQuantity Decimal The quantity of this item which do have assignments from stock
ConfirmedDeliveryDate Date Confirmed date of delivery. Date of which the customer can expect the arriving goods
ContainingNotificationMessage String The message from the notification definition, expanded with parameters.
ContainingNotificationTypeId Integer Notification type identifier
CreatedAt Datetime Date and time of creation
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.
IsNonStock Boolean True if this is a non-physical product which are no using assignments from the assignment archive
ItemId Integer Item-number of the object
Location String Unique abbreviation/short name of the location
ProductDescription String Description of the product
ProductId Integer Product identifier
ProductName String Name of the product
ProductType String Type of product
Quantity Decimal Quantity of the object.
RemainingQuantity Decimal Remaining number of units to be forwarded
RequestedDeliveryDate Date The delivery date as requested by the customer.
SalesOrderId Integer Sales order identifier
SalesOrderItemId Integer Sales order item identifier
ScheduledShippingDate Date Date when the goods was/will be shipped from the warehouse.
ShippingServiceName String Name of shipping service
Status Integer Status of the item/object.

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
<ItemsForShipping>
2
     <ItemForShipping>
3
          <EntireSalesOrderReadyForShipping
EntireSalesOrderReadyForShipping

If the shipping setting on sales order is set to only ship entire order, this field will return true if the entire order is not ready to be delivered

>{Boolean}</EntireSalesOrderReadyForShipping>
4
          <EntireSalesOrderItemReadyForShipping
EntireSalesOrderItemReadyForShipping

If the shipping setting on sales order is set to only ship entire item, this field will return true if the entire item is not ready to be delivered

>{Boolean}</EntireSalesOrderItemReadyForShipping>
5
          <AllSalesOrderItemsOnSameDateReadyForShipping
AllSalesOrderItemsOnSameDateReadyForShipping

If the shipping setting on sales order is set to only ship equal scheduled shipping date together, this field will return true if all the items with equal scheduled shipping date are ready to be delivered.

>{Boolean}</AllSalesOrderItemsOnSameDateReadyForShipping>
6
          <SalesOrderItem>
7
               <SalesOrderItemId
SalesOrderItemId

Sales order item identifier

>{Integer}</SalesOrderItemId>
8
               <Status
Status

Status of the sales order item (0-9).

Possible domain values can be found here

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

Date and time of creation

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

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

>{Integer}</LineNumber>
11
               <RequestedDeliveryDate
RequestedDeliveryDate

The delivery date as requested by the customer.

>{Date}</RequestedDeliveryDate>
12
               <ConfirmedDeliveryDate
ConfirmedDeliveryDate

Confirmed date of delivery. Date of which the customer can expect the arriving goods

>{Date}</ConfirmedDeliveryDate>
13
               <ScheduledShippingDate
ScheduledShippingDate

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

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

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

>{String}</CustomersReferenceNumber>
15
               <Note
Note

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

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

Number of units ordered

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

Remaining number of units to be forwarded.

>{Decimal}</RemainingQuantity>
18
               <AllocatedStockQuantity
AllocatedStockQuantity

The quantity of this item which do have assignments from stock

>{Decimal}</AllocatedStockQuantity>
19
               <Totals>
20
                    <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
21
                    <RemainingAmount
RemainingAmount

Total remaining value of item in document currency. The sum of remaining quantity and open forwarded quantity, multiplied with netprice

>{Decimal}</RemainingAmount>
22
               </Totals>
23
               <MeasurementUnit>
24
                    <MeasurementUnitId
MeasurementUnitId

Material unit reference

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

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

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

Material unit reference

>{String}</MeasurementUnitLink>
27
               </MeasurementUnit>
28
               <Product>
29
                    <ProductId
ProductId

Product identifier

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

Name of the product

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

Description of the product

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

Type of product

Possible domain values can be found here

>{String}</Type>
33
                    <Stock>
34
                         <IsNonStock
IsNonStock

True if this is a non-physical product which are no using assignments from the assignment archive

>{Boolean}</IsNonStock>
35
                    </Stock>
36
                    <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
37
               </Product>
38
               <SalesOrder>
39
                    <SalesOrderId
SalesOrderId

Sales order identifier

>{Integer}</SalesOrderId>
40
                    <RegistrationDate
RegistrationDate

Date of registration

>{Date}</RegistrationDate>
41
                    <Location
Location

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

>
42
                         <LocationId
LocationId

Location identifier

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

>{Integer}</LocationId>
43
                         <Name
Name

Name of location

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

>{String}</Name>
44
                         <ShortName
ShortName

Unique abbreviation/short name of the location

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

>{String}</ShortName>
45
                         <LocationLink
LocationLink

Location reference

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

>{String}</LocationLink>
46
                    </Location>
47
                    <Assignee
Assignee

The user who has been assigned to work with this object.

>
48
                         <UserId
UserId

User identifier

>{Integer}</UserId>
49
                         <Name
Name

Name of the user

>{String}</Name>
50
                         <FirstName
FirstName

First name of the user

>{String}</FirstName>
51
                         <UserLink
UserLink

User reference

>{String}</UserLink>
52
                    </Assignee>
53
                    <Customer>
54
                         <CustomerId
CustomerId

Customer identifier

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

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

>{String}</Name>
56
                         <FirstName
FirstName

Secondary name of a company or firstname of a person

>{String}</FirstName>
57
                         <CustomerLink
CustomerLink

Customer reference

>{String}</CustomerLink>
58
                    </Customer>
59
                    <Shipment>
60
                         <OnlyShipEntireSalesOrder
OnlyShipEntireSalesOrder

True if all items of a sales order should be shipped together. The items of a sales order should never be split into several shipments. If sales order is forwarded to shipping advice by bulk handling, this will be controlled by RamBase. Manually forward requires that the users controls this themselves.

>{Boolean}</OnlyShipEntireSalesOrder>
61
                         <OnlyShipEntireSalesOrderItems
OnlyShipEntireSalesOrderItems

True if the total quantity of a sales order item always should be shipped together. The quantity should never be split into several shipments. If sales order is forwarded to shipping advice by bulk handling, this will be controlled by RamBase. Manually forward requires that the users controls this themselves.

>{Boolean}</OnlyShipEntireSalesOrderItems>
62
                         <AvoidMultipleShipmentsOnSameDate
AvoidMultipleShipmentsOnSameDate

True if all items of a sales order with the same sheduled delivery date should be shipped together. If sales order is forwarded to shipping advice by bulk handling, this will be controlled by RamBase. Manually forward requires that the users controls this themselves.

>{Boolean}</AvoidMultipleShipmentsOnSameDate>
63
                    </Shipment>
64
                    <SalesOrderLink
SalesOrderLink

API reference to the object

>{String}</SalesOrderLink>
65
               </SalesOrder>
66
               <ForwardedTo>
67
                    <ForwardedToItems>
68
                         <Item
Item

Item this item was forwarded to.

>
69
                              <ItemId
ItemId

Identifier of the object

>{Integer}</ItemId>
70
                              <Object>
71
                                   <ObjectId
ObjectId

Identifier of the object

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

Type of object

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

API reference to the object

>{String}</ObjectLink>
74
                              </Object>
75
                              <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

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

API reference to the item

>{String}</ItemLink>
77
                         </Item>
78
                    </ForwardedToItems>
79
               </ForwardedTo>
80
               <SalesOrderItemLink
SalesOrderItemLink

API reference to the item

>{String}</SalesOrderItemLink>
81
          </SalesOrderItem>
82
          <HighlightedNotifications
HighlightedNotifications

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

>
83
               <Notification
Notification

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

>
84
                    <NotificationId
NotificationId

Notification identifier

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

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

Status of the notification

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

>{Integer}</Status>
86
                    <CurrentUserCanApprove
CurrentUserCanApprove

True if current user is allowed to approve the notification.

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

>{Boolean}</CurrentUserCanApprove>
87
                    <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=ItemForShipping.HighlightedNotifications in your request URI to get this field

>{String}</Message>
88
                    <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=ItemForShipping.HighlightedNotifications in your request URI to get this field

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

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

>
90
                         <NotificationTypeId
NotificationTypeId

Notification type identifier

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

>{String}</NotificationTypeId>
91
                         <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=ItemForShipping.HighlightedNotifications in your request URI to get this field

>{String}</Category>
92
                         <Priority
Priority

Priority of notification with this notification type.

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

>{String}</Priority>
93
                         <NotificationTypeLink
NotificationTypeLink

Notification type reference

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

>{String}</NotificationTypeLink>
94
                    </NotificationType>
95
                    <NotificationLink
NotificationLink

Notification reference

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

>{String}</NotificationLink>
96
               </Notification>
97
          </HighlightedNotifications>
98
     </ItemForShipping>
99
     <Paging
Paging

Detailed paging information for this list.

>
100
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
103
          <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>
104
          <FirstPage
FirstPage

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

>{String}</FirstPage>
105
          <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>
106
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
107
          <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>
108
          <NextPage
NextPage

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

>{String}</NextPage>
109
          <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>
110
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
112
     </Paging>
113
</ItemsForShipping>
1
{
2
     "itemsForShipping": [
3
          {
4
               "entireSalesOrderReadyForShipping
EntireSalesOrderReadyForShipping

If the shipping setting on sales order is set to only ship entire order, this field will return true if the entire order is not ready to be delivered

": "{Boolean}",
5
               "entireSalesOrderItemReadyForShipping
EntireSalesOrderItemReadyForShipping

If the shipping setting on sales order is set to only ship entire item, this field will return true if the entire item is not ready to be delivered

": "{Boolean}",
6
               "allSalesOrderItemsOnSameDateReadyForShipping
AllSalesOrderItemsOnSameDateReadyForShipping

If the shipping setting on sales order is set to only ship equal scheduled shipping date together, this field will return true if all the items with equal scheduled shipping date are ready to be delivered.

": "{Boolean}",
7
               "salesOrderItem": {
8
                    "salesOrderItemId
SalesOrderItemId

Sales order item identifier

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

Status of the sales order item (0-9).

Possible domain values can be found here

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

Date and time of creation

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

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

": "{Integer}",
12
                    "requestedDeliveryDate
RequestedDeliveryDate

The delivery date as requested by the customer.

": "{Date}",
13
                    "confirmedDeliveryDate
ConfirmedDeliveryDate

Confirmed date of delivery. Date of which the customer can expect the arriving goods

": "{Date}",
14
                    "scheduledShippingDate
ScheduledShippingDate

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

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

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

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

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

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

Number of units ordered

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

Remaining number of units to be forwarded.

": "{Decimal}",
19
                    "allocatedStockQuantity
AllocatedStockQuantity

The quantity of this item which do have assignments from stock

": "{Decimal}",
20
                    "totals": {
21
                         "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
22
                         "remainingAmount
RemainingAmount

Total remaining value of item in document currency. The sum of remaining quantity and open forwarded quantity, multiplied with netprice

": "{Decimal}"
23
                    },
24
                    "measurementUnit": {
25
                         "measurementUnitId
MeasurementUnitId

Material unit reference

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

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

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

Material unit reference

": "{String}"
28
                    },
29
                    "product": {
30
                         "productId
ProductId

Product identifier

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

Name of the product

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

Description of the product

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

Type of product

Possible domain values can be found here

": "{String}",
34
                         "stock": {
35
                              "isNonStock
IsNonStock

True if this is a non-physical product which are no using assignments from the assignment archive

": "{Boolean}"
36
                         },
37
                         "productLink
ProductLink

Product reference

": "{String}"
38
                    },
39
                    "salesOrder": {
40
                         "salesOrderId
SalesOrderId

Sales order identifier

": "{Integer}",
41
                         "registrationDate
RegistrationDate

Date of registration

": "{Date}",
42
                         "location
Location

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

": {
43
                              "locationId
LocationId

Location identifier

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

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

Name of location

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

": "{String}",
45
                              "shortName
ShortName

Unique abbreviation/short name of the location

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

": "{String}",
46
                              "locationLink
LocationLink

Location reference

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

": "{String}"
47
                         },
48
                         "assignee
Assignee

The user who has been assigned to work with this object.

": {
49
                              "userId
UserId

User identifier

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

Name of the user

": "{String}",
51
                              "firstName
FirstName

First name of the user

": "{String}",
52
                              "userLink
UserLink

User reference

": "{String}"
53
                         },
54
                         "customer": {
55
                              "customerId
CustomerId

Customer identifier

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

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

": "{String}",
57
                              "firstName
FirstName

Secondary name of a company or firstname of a person

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

Customer reference

": "{String}"
59
                         },
60
                         "shipment": {
61
                              "onlyShipEntireSalesOrder
OnlyShipEntireSalesOrder

True if all items of a sales order should be shipped together. The items of a sales order should never be split into several shipments. If sales order is forwarded to shipping advice by bulk handling, this will be controlled by RamBase. Manually forward requires that the users controls this themselves.

": "{Boolean}",
62
                              "onlyShipEntireSalesOrderItems
OnlyShipEntireSalesOrderItems

True if the total quantity of a sales order item always should be shipped together. The quantity should never be split into several shipments. If sales order is forwarded to shipping advice by bulk handling, this will be controlled by RamBase. Manually forward requires that the users controls this themselves.

": "{Boolean}",
63
                              "avoidMultipleShipmentsOnSameDate
AvoidMultipleShipmentsOnSameDate

True if all items of a sales order with the same sheduled delivery date should be shipped together. If sales order is forwarded to shipping advice by bulk handling, this will be controlled by RamBase. Manually forward requires that the users controls this themselves.

": "{Boolean}"
64
                         },
65
                         "salesOrderLink
SalesOrderLink

API reference to the object

": "{String}"
66
                    },
67
                    "forwardedTo": {
68
                         "forwardedToItems": [
69
                              {
70
                                   "itemId
ItemId

Identifier of the object

": "{Integer}",
71
                                   "object": {
72
                                        "objectId
ObjectId

Identifier of the object

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

Type of object

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

API reference to the object

": "{String}"
75
                                   },
76
                                   "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

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

API reference to the item

": "{String}"
78
                              }
79
                         ]
80
                    },
81
                    "salesOrderItemLink
SalesOrderItemLink

API reference to the item

": "{String}"
82
               },
83
               "highlightedNotifications
HighlightedNotifications

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

": [
84
                    {
85
                         "notificationId
NotificationId

Notification identifier

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

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

Status of the notification

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

": "{Integer}",
87
                         "currentUserCanApprove
CurrentUserCanApprove

True if current user is allowed to approve the notification.

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

": "{Boolean}",
88
                         "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=ItemForShipping.HighlightedNotifications in your request URI to get this field

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

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

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

": {
91
                              "notificationTypeId
NotificationTypeId

Notification type identifier

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

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

": "{String}",
93
                              "priority
Priority

Priority of notification with this notification type.

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

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

Notification type reference

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

": "{String}"
95
                         },
96
                         "notificationLink
NotificationLink

Notification reference

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

": "{String}"
97
                    }
98
               ]
99
          }
100
     ],
101
     "paging
Paging

Detailed paging information for this list.

": {
102
          "pageSize
PageSize

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

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

Position of the first element in the list

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

Page index

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

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

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

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

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

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

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

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

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

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

": "{Integer}"
114
     }
115
}

Possible error codes the response might return:

Error 101013 HTTP 404 Sub-module not found
Error 102018 HTTP 403 You need permission {0}. Duties with this permission: {1}