API

Logistics APIs

GET logistics/objects-pending-picking

Shipping advices, stock transfers and supplier returns ready for picking.

HTTP method GET
URI https://api.rambase.net/logistics/objects-pending-picking
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 3709, version 19

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

GoodsTransfers() Named filter List of goods transfers
RequiresApprovals() Named filter Cannot be processed because approvals are required
ShippingAdvices() Named filter List of shipping advices
Stopped() Named filter Cannot be processed because of blocking or that validation failed.
CarrierId Integer Carrier identifier.
CreatedAt Datetime Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
Location String Unique abbreviation/short name of the location.
ObjectId Integer Identifier of the object.
ObjectType String Type of object.
RecipientFirstName String First name of the customer/supplier.
RecipientName String Name of the customer/supplier, or last name if it is a person..
ReferenceNumber String Reference number.
ShippingService String Name of shipping service.
Status Integer Status of the item/object.

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

CarrierId Integer Carrier identifier
CreatedAt Datetime Date and time of creation
Location String Unique abbreviation/short name of the location
ObjectId Integer Identifier of the object
ObjectType String Type of object
RecipientFirstName String First name of the customer/supplier
RecipientName String Name of the customer/supplier, or last name if it is a person.
ReferenceNumber String Reference number
ShippingService 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
<ObjectsPendingPicking>
2
     <ObjectPendingPicking>
3
          <FirstScheduledShippingDate
FirstScheduledShippingDate

Scheduled shipping date from the shipping advice item that has the earliest scheduled shipping date

>{Datetime}</FirstScheduledShippingDate>
4
          <ReferenceNumber
ReferenceNumber

Reference number

>{String}</ReferenceNumber>
5
          <NumberOfItems
NumberOfItems

The number of items in a transaction document

>{Integer}</NumberOfItems>
6
          <Recipient>
7
               <ObjectId
ObjectId

Identifier of the object

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

Type of object

>{String}</ObjectType>
9
               <Name
Name

Name of the customer/supplier, or last name if it is a person.

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

First name of the customer/supplier

>{String}</FirstName>
11
               <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

>{String}</RamBaseKey>
12
               <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
13
          </Recipient>
14
          <Object>
15
               <ObjectId
ObjectId

Identifier of the object

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

Type of object

Possible domain values can be found here

>{String}</ObjectType>
17
               <Status
Status

Status of the item/object.

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

Date and time of creation

>{Datetime}</CreatedAt>
19
               <Assignee
Assignee

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

>
20
                    <UserId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

>{String}</UserLink>
24
               </Assignee>
25
               <Location
Location

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

>
26
                    <LocationId
LocationId

Location identifier

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

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

Name of location

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

>{String}</Name>
28
                    <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=ObjectPendingPicking.Object.Location in your request URI to get this field

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

Location reference

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

>{String}</LocationLink>
30
               </Location>
31
               <Shipment>
32
                    <Carrier>
33
                         <CarrierId
CarrierId

Carrier identifier

>{Integer}</CarrierId>
34
                         <Name
Name

Name of carrier

>{String}</Name>
35
                         <CarrierLink
CarrierLink

Carrier reference

>{String}</CarrierLink>
36
                    </Carrier>
37
                    <ShippingService>
38
                         <ShippingServiceId
ShippingServiceId

Shipping service identifier

>{Integer}</ShippingServiceId>
39
                         <Name
Name

Name of shipping service

>{String}</Name>
40
                         <ShippingServiceLink
ShippingServiceLink

Shipping service reference

>{String}</ShippingServiceLink>
41
                    </ShippingService>
42
               </Shipment>
43
               <Totals>
44
                    <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
45
                    <TotalAmount
TotalAmount

The total amount in object currency, including VAT

>{Decimal}</TotalAmount>
46
               </Totals>
47
               <HighlightedNotifications
HighlightedNotifications

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

>
48
                    <Notification
Notification

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

>
49
                         <NotificationId
NotificationId

Notification identifier

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

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

Status of the notification

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

>{Integer}</Status>
51
                         <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=ObjectPendingPicking.Object.HighlightedNotifications in your request URI to get this field

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

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

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

>
54
                              <NotificationTypeId
NotificationTypeId

Notification type identifier

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

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

>{String}</Category>
56
                              <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=ObjectPendingPicking.Object.HighlightedNotifications in your request URI to get this field

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

Notification type reference

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

>{String}</NotificationTypeLink>
58
                         </NotificationType>
59
                         <NotificationLink
NotificationLink

Notification reference

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

>{String}</NotificationLink>
60
                    </Notification>
61
               </HighlightedNotifications>
62
               <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

>{String}</RamBaseKey>
63
               <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
64
          </Object>
65
     </ObjectPendingPicking>
66
     <Paging
Paging

Detailed paging information for this list.

>
67
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

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

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

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

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

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

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

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

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

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

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

>{Integer}</Size>
79
     </Paging>
80
</ObjectsPendingPicking>
1
{
2
     "objectsPendingPicking": [
3
          {
4
               "firstScheduledShippingDate
FirstScheduledShippingDate

Scheduled shipping date from the shipping advice item that has the earliest scheduled shipping date

": "{Datetime}",
5
               "referenceNumber
ReferenceNumber

Reference number

": "{String}",
6
               "numberOfItems
NumberOfItems

The number of items in a transaction document

": "{Integer}",
7
               "recipient": {
8
                    "objectId
ObjectId

Identifier of the object

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

Type of object

": "{String}",
10
                    "name
Name

Name of the customer/supplier, or last name if it is a person.

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

First name of the customer/supplier

": "{String}",
12
                    "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

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

API reference to the object

": "{String}"
14
               },
15
               "object": {
16
                    "objectId
ObjectId

Identifier of the object

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

Type of object

Possible domain values can be found here

": "{String}",
18
                    "status
Status

Status of the item/object.

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

Date and time of creation

": "{Datetime}",
20
                    "assignee
Assignee

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

": {
21
                         "userId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

": "{String}"
25
                    },
26
                    "location
Location

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

": {
27
                         "locationId
LocationId

Location identifier

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

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

Name of location

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

": "{String}",
29
                         "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=ObjectPendingPicking.Object.Location in your request URI to get this field

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

Location reference

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

": "{String}"
31
                    },
32
                    "shipment": {
33
                         "carrier": {
34
                              "carrierId
CarrierId

Carrier identifier

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

Name of carrier

": "{String}",
36
                              "carrierLink
CarrierLink

Carrier reference

": "{String}"
37
                         },
38
                         "shippingService": {
39
                              "shippingServiceId
ShippingServiceId

Shipping service identifier

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

Name of shipping service

": "{String}",
41
                              "shippingServiceLink
ShippingServiceLink

Shipping service reference

": "{String}"
42
                         }
43
                    },
44
                    "totals": {
45
                         "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
46
                         "totalAmount
TotalAmount

The total amount in object currency, including VAT

": "{Decimal}"
47
                    },
48
                    "highlightedNotifications
HighlightedNotifications

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

": [
49
                         {
50
                              "notificationId
NotificationId

Notification identifier

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

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

Status of the notification

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

": "{Integer}",
52
                              "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=ObjectPendingPicking.Object.HighlightedNotifications in your request URI to get this field

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

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

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

": {
55
                                   "notificationTypeId
NotificationTypeId

Notification type identifier

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

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

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

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

Notification type reference

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

": "{String}"
59
                              },
60
                              "notificationLink
NotificationLink

Notification reference

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

": "{String}"
61
                         }
62
                    ],
63
                    "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

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

API reference to the object

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

Detailed paging information for this list.

": {
69
          "pageSize
PageSize

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

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

Position of the first element in the list

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

Page index

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

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

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

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

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

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

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

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

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

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

": "{Integer}"
81
     }
82
}

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 100051 HTTP 400 When logged in as supplier {0} you do not have access to this API resource