API

Logistics APIs

GET logistics/shipment-packages

List of packages in shipments

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

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.

NotShipped() Named filter Packages belonging to shipments that are not sent
Shipped() Named filter Packages belonging to shipments that are shipped
Comment String Comment for this package.
Location String Unique abbreviation/short name of the location.
PackageNumber Integer Package identifier.
PackWeight Decimal Weight of this package. Measurement unit is specified in the location arthive.
RecipientFirstName String First name of the customer/supplier.
RecipientName String Name of the customer/supplier, or last name if it is a person..
ShipmentCountryCode String Two-character code (ISO 3166) identifying the country.
ShippingAddressAddressLine1 String First address line.
ShippingAddressAddressLine2 String Second address line.
ShippingAddressCity String City/town/village.
ShippingAddressCountry String English name of country.
ShippingAddressPostalCode String Postalcode/Postcode/ZIP.
ShippingAddressRegion String Region/province/state.
ShippingDate Date Date of which the shipment is ready/prepared to be shipped. Note that this may not be the date the shipment physically left the warehouse. Departing waybill holds this date. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
ShippingServiceName String Name of shipping service.
Status Integer Status of shipment.
TrackingNumber String Tracking number for this package.

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

PackageNumber Integer Package identifier
PackWeight Decimal Weight of this package. Measurement unit is specified in the location arthive
RecipientFirstName String First name of the customer/supplier
RecipientName String Name of the customer/supplier, or last name if it is a person.
ShippingAddressAddressLine1 String First address line
ShippingAddressAddressLine2 String Second address line
ShippingAddressCity String City/town/village
ShippingAddressCountry String English name of country.
ShippingAddressPostalCode String Postalcode/Postcode/ZIP
ShippingAddressRegion String Region/province/state
ShippingDate Date Date of which the shipment is ready/prepared to be shipped. Note that this may not be the date the shipment physically left the warehouse. Departing waybill holds this date.
Status Integer Status of shipment

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
<Packages>
2
     <Package>
3
          <PackageId
PackageId

Package identifier

>{Integer}</PackageId>
4
          <Comment
Comment

Comment for this package

>{String}</Comment>
5
          <Weight
Weight

Weight of this package. Measurement unit is specified in the location arthive

>{Decimal}</Weight>
6
          <Tracking>
7
               <TrackingNumber
TrackingNumber

Tracking number for this package

>{String}</TrackingNumber>
8
               <TrackingUri
TrackingUri

Tracking uri for the package. The uri is generated based on set-up in the archive of tracking number series, and might include the tracking number

>{String}</TrackingUri>
9
          </Tracking>
10
          <Shipment>
11
               <ShipmentId
ShipmentId

Shipment identifier

>{Long}</ShipmentId>
12
               <Status
Status

Status of shipment

Possible domain values can be found here

>{Integer}</Status>
13
               <ShippingDate
ShippingDate

Date of which the shipment is ready/prepared to be shipped. Note that this may not be the date the shipment physically left the warehouse. Departing waybill holds this date.

>{Date}</ShippingDate>
14
               <WeightUnit
WeightUnit

Unit used for measuring weight on the packages in this shipment

>{String}</WeightUnit>
15
               <ShippingAddress>
16
                    <AddressLine1
AddressLine1

First address line

>{String}</AddressLine1>
17
                    <AddressLine2
AddressLine2

Second address line

>{String}</AddressLine2>
18
                    <PostalCode
PostalCode

Postalcode/Postcode/ZIP

>{String}</PostalCode>
19
                    <City
City

City/town/village

>{String}</City>
20
                    <Region
Region

Region/province/state

>{String}</Region>
21
                    <CountryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

>{String}</CountryCode>
22
                    <Country
Country

English name of country.

>{String}</Country>
23
                    <AddressLink
AddressLink

Address reference

>{String}</AddressLink>
24
               </ShippingAddress>
25
               <ShippingService>
26
                    <ShippingServiceId
ShippingServiceId

Shipping service identifier

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

Name of shipping service

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

Shipping service reference

>{String}</ShippingServiceLink>
29
                    <Carrier>
30
                         <CarrierId
CarrierId

Carrier identifier

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

Name of carrier

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

Carrier reference

>{String}</CarrierLink>
33
                    </Carrier>
34
               </ShippingService>
35
               <Location>
36
                    <ShortName
ShortName

Unique abbreviation/short name of the location

>{String}</ShortName>
37
               </Location>
38
               <Recipient>
39
                    <Name
Name

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

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

First name of the customer/supplier

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

Internal RamBase identifier of the object/item

>{String}</RamBaseKey>
42
                    <ReceiverLink
ReceiverLink

API reference to the object

>{String}</ReceiverLink>
43
               </Recipient>
44
               <ShipmentLink
ShipmentLink

Shipment reference

>{String}</ShipmentLink>
45
          </Shipment>
46
          <PackageLink
PackageLink

Shipping service reference

>{String}</PackageLink>
47
     </Package>
48
     <Paging
Paging

Detailed paging information for this list.

>
49
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
52
          <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>
53
          <FirstPage
FirstPage

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

>{String}</FirstPage>
54
          <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>
55
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
56
          <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>
57
          <NextPage
NextPage

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

>{String}</NextPage>
58
          <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>
59
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
61
     </Paging>
62
</Packages>
1
{
2
     "packages": [
3
          {
4
               "packageId
PackageId

Package identifier

": "{Integer}",
5
               "comment
Comment

Comment for this package

": "{String}",
6
               "weight
Weight

Weight of this package. Measurement unit is specified in the location arthive

": "{Decimal}",
7
               "tracking": {
8
                    "trackingNumber
TrackingNumber

Tracking number for this package

": "{String}",
9
                    "trackingUri
TrackingUri

Tracking uri for the package. The uri is generated based on set-up in the archive of tracking number series, and might include the tracking number

": "{String}"
10
               },
11
               "shipment": {
12
                    "shipmentId
ShipmentId

Shipment identifier

": "{Long}",
13
                    "status
Status

Status of shipment

Possible domain values can be found here

": "{Integer}",
14
                    "shippingDate
ShippingDate

Date of which the shipment is ready/prepared to be shipped. Note that this may not be the date the shipment physically left the warehouse. Departing waybill holds this date.

": "{Date}",
15
                    "weightUnit
WeightUnit

Unit used for measuring weight on the packages in this shipment

": "{String}",
16
                    "shippingAddress": {
17
                         "addressLine1
AddressLine1

First address line

": "{String}",
18
                         "addressLine2
AddressLine2

Second address line

": "{String}",
19
                         "postalCode
PostalCode

Postalcode/Postcode/ZIP

": "{String}",
20
                         "city
City

City/town/village

": "{String}",
21
                         "region
Region

Region/province/state

": "{String}",
22
                         "countryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

": "{String}",
23
                         "country
Country

English name of country.

": "{String}",
24
                         "addressLink
AddressLink

Address reference

": "{String}"
25
                    },
26
                    "shippingService": {
27
                         "shippingServiceId
ShippingServiceId

Shipping service identifier

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

Name of shipping service

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

Shipping service reference

": "{String}",
30
                         "carrier": {
31
                              "carrierId
CarrierId

Carrier identifier

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

Name of carrier

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

Carrier reference

": "{String}"
34
                         }
35
                    },
36
                    "location": {
37
                         "shortName
ShortName

Unique abbreviation/short name of the location

": "{String}"
38
                    },
39
                    "recipient": {
40
                         "name
Name

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

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

First name of the customer/supplier

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

Internal RamBase identifier of the object/item

": "{String}",
43
                         "receiverLink
ReceiverLink

API reference to the object

": "{String}"
44
                    },
45
                    "shipmentLink
ShipmentLink

Shipment reference

": "{String}"
46
               },
47
               "packageLink
PackageLink

Shipping service reference

": "{String}"
48
          }
49
     ],
50
     "paging
Paging

Detailed paging information for this list.

": {
51
          "pageSize
PageSize

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

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

Position of the first element in the list

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

Page index

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

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

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

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

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

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

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

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

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

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

": "{Integer}"
63
     }
64
}

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 101013 HTTP 404 Sub-module not found
Error 101420 HTTP 404 Setting definition not found