API

Logistics APIs

GET logistics/shipments/{shipmentId}

Shipment details for provided identifier

HTTP method GET
URI https://api.rambase.net/logistics/shipments/{shipmentId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {shipmentId} Shipment identifier
Long, minimum 100000
Successful HTTP status code 200
API resource identifier 2444, version 25

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
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$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.
$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.
$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.

Read more about filters and sorting on how to use filter parameters and named filters.

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

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
<Shipment>
2
     <Database
Database

Company code/database the object belongs to

>{String}</Database>
3
     <ShipmentId
ShipmentId

Shipment identifier

>{Long}</ShipmentId>
4
     <CreatedAt
CreatedAt

Date and time of creation

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

Status of shipment

Possible domain values can be found here

>{Integer}</Status>
6
     <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
7
     <ContentType
ContentType

Type of content

Possible domain values can be found here

>{String}</ContentType>
8
     <ContentAmount
ContentAmount

The total amount of all contents in this shipment. Calculated by accumulating total amount from each of the content.

>{Decimal}</ContentAmount>
9
     <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>
10
     <Priority
Priority

Priority of the shipment

Possible domain values can be found here

>{Integer}</Priority>
11
     <ShippingAddressAttention
ShippingAddressAttention

Attention of the shipping address. When changing shipping address, the ShippingAddressAttention will be overridden by the attention of the new shipping address.

>{String}</ShippingAddressAttention>
12
     <ShippingAddressPhone
ShippingAddressPhone

Phone number of the shipping address. When changing shipping address, the ShippingAddressPhone will be overridden by the phone number of the new shipping address.

>{String}</ShippingAddressPhone>
13
     <ShippingAddressEmail
ShippingAddressEmail

Email address of the shipping address. When changing shipping address, the ShippingAddressEmail will be overridden by the email of the new shipping address.

>{String}</ShippingAddressEmail>
14
     <WeightUnit
WeightUnit

Unit used for measuring weight on the packages in this shipment

Possible domain values can be found here

>{String}</WeightUnit>
15
     <LengthUnit
LengthUnit

Unit used for measuring length, width and height of the packages in the shipment.

Possible domain values can be found here

>{String}</LengthUnit>
16
     <ExternalShipmentId
ExternalShipmentId

Used to store external shipping IDs. Example from integrations like Consignor or UniFaun

>{String}</ExternalShipmentId>
17
     <Totals>
18
          <Packages
Packages

Number of packages in this shipment

>{Integer}</Packages>
19
          <Weight
Weight

Total weight in weightunit

>{Decimal}</Weight>
20
          <Volume
Volume

Total volume of the shipment in cubic.

>{Decimal}</Volume>
21
     </Totals>
22
     <Tracking>
23
          <TrackingNumber
TrackingNumber

Carriers tracking number for the whole shipment

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

Tracking uri for the shipment. The uri is generated from the tracking number series, and might include the tracking number

>{String}</TrackingUri>
25
          <TrackingNumberSeries
TrackingNumberSeries

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

>
26
               <TrackingNumberSeriesId
TrackingNumberSeriesId

Tracking number series identifier

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

>{Integer}</TrackingNumberSeriesId>
27
               <TrackingNumberSeriesLink
TrackingNumberSeriesLink

Tracking number series reference

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

>{Integer}</TrackingNumberSeriesLink>
28
          </TrackingNumberSeries>
29
     </Tracking>
30
     <Location>
31
          <LocationId
LocationId

Location identifier

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

>{Integer}</LocationId>
32
          <ShortName
ShortName

Unique abbreviation/short name of the location

>{String}</ShortName>
33
          <Phone
Phone

Phone number for the location

>{String}</Phone>
34
          <Fax
Fax

Fax number for the location

>{String}</Fax>
35
          <Email
Email

Email address for the location

>{String}</Email>
36
          <Address
Address

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

>
37
               <Name
Name

Name of location

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

>{String}</Name>
38
               <Attention
Attention

Attention note.

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

>{String}</Attention>
39
               <AddressLine1
AddressLine1

First address line

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

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

Second address line

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

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

Postalcode/Postcode/ZIP

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

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

City/town/village

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

>{String}</City>
43
               <CountryCode
CountryCode

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

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

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

English name of country.

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

>{String}</Country>
45
          </Address>
46
          <LocationLink
LocationLink

Location reference

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

>{String}</LocationLink>
47
     </Location>
48
     <Recipient>
49
          <ObjectId
ObjectId

Identifier of the object

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

Type of object

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

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

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

First name of the customer/supplier

>{String}</FirstName>
53
          <VATRegistrationNumber
VATRegistrationNumber

Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT)

>{String}</VATRegistrationNumber>
54
          <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

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

API reference to the object

>{String}</ObjectLink>
56
     </Recipient>
57
     <ShippingAddress>
58
          <AddressId
AddressId

Address identifier

>{Integer}</AddressId>
59
          <Name
Name

Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.

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

Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.

>{String}</Firstname>
61
          <AddressLine1
AddressLine1

First address line

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

Second address line

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

Postalcode/Postcode/ZIP

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

City/town/village

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

Region/province/state

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

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

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

English name of country.

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

Address reference

>{String}</AddressLink>
69
     </ShippingAddress>
70
     <SpecialHandling
SpecialHandling

Special handling to use for this shipment.

>
71
          <SpecialHandlingId
SpecialHandlingId

Special handling identifier

>{Integer}</SpecialHandlingId>
72
          <SpecialHandlingLink
SpecialHandlingLink

Special handling code reference

>{String}</SpecialHandlingLink>
73
     </SpecialHandling>
74
     <ShippingService>
75
          <ShippingServiceId
ShippingServiceId

Shipping service identifier

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

Name of shipping service

>{String}</Name>
77
          <PayersCustomerIdAtCarrier
PayersCustomerIdAtCarrier

The customer account id with the carrier, which shold pay the freight.

>{String}</PayersCustomerIdAtCarrier>
78
          <Carrier>
79
               <CarrierId
CarrierId

Carrier identifier

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

Name of carrier

>{String}</Name>
81
               <TransportManagementSystem
TransportManagementSystem

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

>
82
                    <CarrierId
CarrierId

Carrier id in the external Transport Management System

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

>{String}</CarrierId>
83
                    <APIKey
APIKey

Customer id in the external Transport Management System.

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

>{String}</APIKey>
84
                    <APISecret
APISecret

Api key used in communication with external Transport Management System.

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

>{String}</APISecret>
85
               </TransportManagementSystem>
86
               <CarrierLink
CarrierLink

Carrier reference

>{String}</CarrierLink>
87
          </Carrier>
88
          <CarrierService
CarrierService

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

>
89
               <CarrierServiceId
CarrierServiceId

Identifier from archive for shipping services

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

>{Integer}</CarrierServiceId>
90
               <CarriersId
CarriersId

Carrier service identifier

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

>{String}</CarriersId>
91
               <CarrierServiceLink
CarrierServiceLink

Service reference

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

>{String}</CarrierServiceLink>
92
          </CarrierService>
93
          <ShippingServiceLink
ShippingServiceLink

Shipping service reference

>{String}</ShippingServiceLink>
94
     </ShippingService>
95
     <FreightTable
FreightTable

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

>
96
          <FreightTableId
FreightTableId

Freight table identifier

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

>{Integer}</FreightTableId>
97
          <FreightTableLink
FreightTableLink

Freight table reference

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

>{String}</FreightTableLink>
98
     </FreightTable>
99
     <DepartingWaybill>
100
          <DepartingWaybillId
DepartingWaybillId

Departing waybill identifier

>{Integer}</DepartingWaybillId>
101
          <DepartingWaybillLink
DepartingWaybillLink

Departing waybill reference

>{String}</DepartingWaybillLink>
102
     </DepartingWaybill>
103
</Shipment>
1
{
2
     "shipment": {
3
          "database
Database

Company code/database the object belongs to

": "{String}",
4
          "shipmentId
ShipmentId

Shipment identifier

": "{Long}",
5
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
6
          "status
Status

Status of shipment

Possible domain values can be found here

": "{Integer}",
7
          "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
8
          "contentType
ContentType

Type of content

Possible domain values can be found here

": "{String}",
9
          "contentAmount
ContentAmount

The total amount of all contents in this shipment. Calculated by accumulating total amount from each of the content.

": "{Decimal}",
10
          "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}",
11
          "priority
Priority

Priority of the shipment

Possible domain values can be found here

": "{Integer}",
12
          "shippingAddressAttention
ShippingAddressAttention

Attention of the shipping address. When changing shipping address, the ShippingAddressAttention will be overridden by the attention of the new shipping address.

": "{String}",
13
          "shippingAddressPhone
ShippingAddressPhone

Phone number of the shipping address. When changing shipping address, the ShippingAddressPhone will be overridden by the phone number of the new shipping address.

": "{String}",
14
          "shippingAddressEmail
ShippingAddressEmail

Email address of the shipping address. When changing shipping address, the ShippingAddressEmail will be overridden by the email of the new shipping address.

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

Unit used for measuring weight on the packages in this shipment

Possible domain values can be found here

": "{String}",
16
          "lengthUnit
LengthUnit

Unit used for measuring length, width and height of the packages in the shipment.

Possible domain values can be found here

": "{String}",
17
          "externalShipmentId
ExternalShipmentId

Used to store external shipping IDs. Example from integrations like Consignor or UniFaun

": "{String}",
18
          "totals": {
19
               "packages
Packages

Number of packages in this shipment

": "{Integer}",
20
               "weight
Weight

Total weight in weightunit

": "{Decimal}",
21
               "volume
Volume

Total volume of the shipment in cubic.

": "{Decimal}"
22
          },
23
          "tracking": {
24
               "trackingNumber
TrackingNumber

Carriers tracking number for the whole shipment

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

Tracking uri for the shipment. The uri is generated from the tracking number series, and might include the tracking number

": "{String}",
26
               "trackingNumberSeries
TrackingNumberSeries

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

": {
27
                    "trackingNumberSeriesId
TrackingNumberSeriesId

Tracking number series identifier

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

": "{Integer}",
28
                    "trackingNumberSeriesLink
TrackingNumberSeriesLink

Tracking number series reference

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

": "{Integer}"
29
               }
30
          },
31
          "location": {
32
               "locationId
LocationId

Location identifier

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

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

Unique abbreviation/short name of the location

": "{String}",
34
               "phone
Phone

Phone number for the location

": "{String}",
35
               "fax
Fax

Fax number for the location

": "{String}",
36
               "email
Email

Email address for the location

": "{String}",
37
               "address
Address

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

": {
38
                    "name
Name

Name of location

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

": "{String}",
39
                    "attention
Attention

Attention note.

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

": "{String}",
40
                    "addressLine1
AddressLine1

First address line

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

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

Second address line

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

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

Postalcode/Postcode/ZIP

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

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

City/town/village

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

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

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

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

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

English name of country.

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

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

Location reference

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

": "{String}"
48
          },
49
          "recipient": {
50
               "objectId
ObjectId

Identifier of the object

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

Type of object

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

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

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

First name of the customer/supplier

": "{String}",
54
               "vATRegistrationNumber
VATRegistrationNumber

Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT)

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

Internal RamBase identifier of the object/item

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

API reference to the object

": "{String}"
57
          },
58
          "shippingAddress": {
59
               "addressId
AddressId

Address identifier

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

Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.

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

Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.

": "{String}",
62
               "addressLine1
AddressLine1

First address line

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

Second address line

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

Postalcode/Postcode/ZIP

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

City/town/village

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

Region/province/state

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

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

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

English name of country.

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

Address reference

": "{String}"
70
          },
71
          "specialHandling
SpecialHandling

Special handling to use for this shipment.

": {
72
               "specialHandlingId
SpecialHandlingId

Special handling identifier

": "{Integer}",
73
               "specialHandlingLink
SpecialHandlingLink

Special handling code reference

": "{String}"
74
          },
75
          "shippingService": {
76
               "shippingServiceId
ShippingServiceId

Shipping service identifier

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

Name of shipping service

": "{String}",
78
               "payersCustomerIdAtCarrier
PayersCustomerIdAtCarrier

The customer account id with the carrier, which shold pay the freight.

": "{String}",
79
               "carrier": {
80
                    "carrierId
CarrierId

Carrier identifier

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

Name of carrier

": "{String}",
82
                    "transportManagementSystem
TransportManagementSystem

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

": {
83
                         "carrierId
CarrierId

Carrier id in the external Transport Management System

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

": "{String}",
84
                         "aPIKey
APIKey

Customer id in the external Transport Management System.

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

": "{String}",
85
                         "aPISecret
APISecret

Api key used in communication with external Transport Management System.

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

": "{String}"
86
                    },
87
                    "carrierLink
CarrierLink

Carrier reference

": "{String}"
88
               },
89
               "carrierService
CarrierService

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

": {
90
                    "carrierServiceId
CarrierServiceId

Identifier from archive for shipping services

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

": "{Integer}",
91
                    "carriersId
CarriersId

Carrier service identifier

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

": "{String}",
92
                    "carrierServiceLink
CarrierServiceLink

Service reference

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

": "{String}"
93
               },
94
               "shippingServiceLink
ShippingServiceLink

Shipping service reference

": "{String}"
95
          },
96
          "freightTable
FreightTable

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

": {
97
               "freightTableId
FreightTableId

Freight table identifier

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

": "{Integer}",
98
               "freightTableLink
FreightTableLink

Freight table reference

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

": "{String}"
99
          },
100
          "departingWaybill": {
101
               "departingWaybillId
DepartingWaybillId

Departing waybill identifier

": "{Integer}",
102
               "departingWaybillLink
DepartingWaybillLink

Departing waybill reference

": "{String}"
103
          }
104
     }
105
}

Possible error codes the response might return:

Error 101013 HTTP 404 Sub-module not found
Error 101420 HTTP 404 Setting definition not found