API

Logistics APIs

GET logistics/goods-transfers/{goodsTransferId}

Goods transfer details for provided identifier

HTTP method GET
URI https://api.rambase.net/logistics/goods-transfers/{goodsTransferId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {goodsTransferId} Goods transfer identifier
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 596, version 22

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
<GoodsTransfer>
2
     <GoodsTransferId
GoodsTransferId

Goods transfer identifier

>{Integer}</GoodsTransferId>
3
     <Status
Status

Status of goods transfer

Possible domain values can be found here

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

Date and time of creation

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

Three character code following the ISO 4217 standard

Possible domain values can be found here

>{String}</Currency>
6
     <ShippingDate
ShippingDate

Date of shipment departure

>{Date}</ShippingDate>
7
     <RequireSerialNumberBeforeShipping
RequireSerialNumberBeforeShipping

True if serial number is required before shipping. Note that if the product has set this value to true, this can not be overridden.

>{Boolean}</RequireSerialNumberBeforeShipping>
8
     <Quantity
Quantity

Quantity to be transferred

>{Decimal}</Quantity>
9
     <Note
Note

Additional information regarding the object (free text). This note might be visible to customers/suppliers.

>{String}</Note>
10
     <TransferToAddressAttention
TransferToAddressAttention

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

>{String}</TransferToAddressAttention>
11
     <TransferToAddressPhone
TransferToAddressPhone

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}</TransferToAddressPhone>
12
     <TransferToAddressEmail
TransferToAddressEmail

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

>{String}</TransferToAddressEmail>
13
     <TransferTo>
14
          <LocationId
LocationId

Location identifier

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

Name of location

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

Unique abbreviation/short name of the location

>{String}</ShortName>
17
          <Address>
18
               <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>
19
               <AddressLine1
AddressLine1

First address line

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

Second address line

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

Postalcode/Postcode/ZIP

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

City/town/village

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

Region/province/state

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

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

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

English name of country.

>{String}</Country>
26
          </Address>
27
          <LocationLink
LocationLink

Location reference

>{String}</LocationLink>
28
     </TransferTo>
29
     <TransferFrom>
30
          <LocationId
LocationId

Location identifier

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

Name of location

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

Unique abbreviation/short name of the location

>{String}</ShortName>
33
          <Address>
34
               <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>
35
               <AddressLine1
AddressLine1

First address line

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

Second address line

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

Postalcode/Postcode/ZIP

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

City/town/village

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

Region/province/state

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

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

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

English name of country.

>{String}</Country>
42
          </Address>
43
          <LocationLink
LocationLink

Location reference

>{String}</LocationLink>
44
     </TransferFrom>
45
     <TransferOf>
46
          <GoodsReceptionItemId
GoodsReceptionItemId

Item-/line-number of the goods reception

>{Integer}</GoodsReceptionItemId>
47
          <ProductDescription
ProductDescription

Description of the product, it's by default copied from product

>{String}</ProductDescription>
48
          <Price>
49
               <Currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

>{String}</Currency>
50
               <GrossPrice
GrossPrice

Represents the price per unit before any discounting is applied.

>{Decimal}</GrossPrice>
51
               <NetPrice
NetPrice

Final price per unit after deducting all discounts etc.

>{Decimal}</NetPrice>
52
          </Price>
53
          <MeasurementUnit>
54
               <MeasurementUnitId
MeasurementUnitId

Material unit reference

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

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

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

Material unit reference

>{String}</MeasurementUnitLink>
57
          </MeasurementUnit>
58
          <Product>
59
               <ProductId
ProductId

Product identifier

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

Name of the product

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

Type of product

Possible domain values can be found here

>{String}</Type>
62
               <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
63
          </Product>
64
          <Manufacturer>
65
               <ManufacturerId
ManufacturerId

Manufacturer identifier

>{Integer}</ManufacturerId>
66
               <Name
Name

Company name of the manufacturer.

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

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

Shortname/code of the manufacturer

>{String}</ShortName>
68
               <ManufacturerLink
ManufacturerLink

Manufacturer reference

>{String}</ManufacturerLink>
69
          </Manufacturer>
70
          <ManufacturersProduct
ManufacturersProduct

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

>
71
               <ManufacturersProductId
ManufacturersProductId

Manufacturer product identifier

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

>{Integer}</ManufacturersProductId>
72
               <Name
Name

Manufacturers name of the product. Also known as Manufacturer Part Number (MPN).

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

>{String}</Name>
73
               <ManufacturersProductLink
ManufacturersProductLink

Manufacturers product reference

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

>{String}</ManufacturersProductLink>
74
          </ManufacturersProduct>
75
          <GoodsReception>
76
               <GoodsReceptionId
GoodsReceptionId

Goods reception identifier

>{Integer}</GoodsReceptionId>
77
               <GoodsReceptionLink
GoodsReceptionLink

Goods reception reference

>{String}</GoodsReceptionLink>
78
          </GoodsReception>
79
          <GoodsReceptionItemLink
GoodsReceptionItemLink

Goods reception item reference

>{String}</GoodsReceptionItemLink>
80
     </TransferOf>
81
     <GoodsReceptionItem
GoodsReceptionItem

The goods reception created at the new location. Will not be set before the goods transfer is completed.

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

>
82
          <GoodsReceptionItemId
GoodsReceptionItemId

Item-/line-number of the goods reception

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

>{Integer}</GoodsReceptionItemId>
83
          <GoodsReception
GoodsReception

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

>
84
               <GoodsReceptionId
GoodsReceptionId

Goods reception identifier

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

>{Integer}</GoodsReceptionId>
85
               <GoodsReceptionLink
GoodsReceptionLink

Goods reception reference

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

>{String}</GoodsReceptionLink>
86
          </GoodsReception>
87
          <GoodsReceptionItemLink
GoodsReceptionItemLink

Goods reception item reference

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

>{String}</GoodsReceptionItemLink>
88
     </GoodsReceptionItem>
89
     <Assignee
Assignee

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

>
90
          <UserId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

>{String}</UserLink>
94
     </Assignee>
95
     <Totals>
96
          <Currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

>{String}</Currency>
97
          <NetAmount
NetAmount

Final item amount after deducting all discounts etc.

>{Decimal}</NetAmount>
98
     </Totals>
99
     <Shipment>
100
          <Priority
Priority

Priority of the shipment

Possible domain values can be found here

>{Integer}</Priority>
101
          <DeliveryTerms
DeliveryTerms

Default delivery terms for the supplier. The delivery terms is based on the Incoterms rules from ICC (International Chamber of Commerce).

Possible domain values can be found here

>{String}</DeliveryTerms>
102
          <DeliveryTermPlace
DeliveryTermPlace

A named place, which, together with the content of Delivery terms, determines where and when the costs, responsibility and risk for a shipment are transferred from the seller to the buye

>{String}</DeliveryTermPlace>
103
          <DepartingShipment>
104
               <ShipmentId
ShipmentId

Shipment identifier

>{Long}</ShipmentId>
105
               <DepartingWaybill>
106
                    <DepartingWaybillId
DepartingWaybillId

Departing waybill identifier

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

Departing waybill reference

>{String}</DepartingWaybillLink>
108
               </DepartingWaybill>
109
               <ShipmentLink
ShipmentLink

Shipment reference

>{String}</ShipmentLink>
110
          </DepartingShipment>
111
          <ShippingService>
112
               <ShippingServiceId
ShippingServiceId

Shipping service identifier

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

Name of shipping service

>{String}</Name>
114
               <Carrier>
115
                    <CarrierId
CarrierId

Carrier identifier

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

Name of carrier

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

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

Carrier reference

>{String}</CarrierLink>
118
               </Carrier>
119
               <ShippingServiceLink
ShippingServiceLink

Shipping service reference

>{String}</ShippingServiceLink>
120
          </ShippingService>
121
     </Shipment>
122
     <PickOperation>
123
          <PickOperationId
PickOperationId

Pick operation identifier

>{Integer}</PickOperationId>
124
          <PickOperationLink
PickOperationLink

Pick operation reference

>{String}</PickOperationLink>
125
     </PickOperation>
126
     <HighlightedNotification
HighlightedNotification

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

>
127
          <NotificationId
NotificationId

Notification identifier

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

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

Status of the notification

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

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

Date and time of creation

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

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

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

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

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

>
133
               <NotificationTypeId
NotificationTypeId

Notification type identifier

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

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

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

Notification type reference

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

>{String}</NotificationTypeLink>
136
          </NotificationType>
137
          <NotificationLink
NotificationLink

Notification reference

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

>{String}</NotificationLink>
138
     </HighlightedNotification>
139
</GoodsTransfer>
1
{
2
     "goodsTransfer": {
3
          "goodsTransferId
GoodsTransferId

Goods transfer identifier

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

Status of goods transfer

Possible domain values can be found here

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

Date and time of creation

": "{Datetime}",
6
          "currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

": "{String}",
7
          "shippingDate
ShippingDate

Date of shipment departure

": "{Date}",
8
          "requireSerialNumberBeforeShipping
RequireSerialNumberBeforeShipping

True if serial number is required before shipping. Note that if the product has set this value to true, this can not be overridden.

": "{Boolean}",
9
          "quantity
Quantity

Quantity to be transferred

": "{Decimal}",
10
          "note
Note

Additional information regarding the object (free text). This note might be visible to customers/suppliers.

": "{String}",
11
          "transferToAddressAttention
TransferToAddressAttention

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

": "{String}",
12
          "transferToAddressPhone
TransferToAddressPhone

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}",
13
          "transferToAddressEmail
TransferToAddressEmail

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

": "{String}",
14
          "transferTo": {
15
               "locationId
LocationId

Location identifier

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

Name of location

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

Unique abbreviation/short name of the location

": "{String}",
18
               "address": {
19
                    "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}",
20
                    "addressLine1
AddressLine1

First address line

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

Second address line

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

Postalcode/Postcode/ZIP

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

City/town/village

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

Region/province/state

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

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

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

English name of country.

": "{String}"
27
               },
28
               "locationLink
LocationLink

Location reference

": "{String}"
29
          },
30
          "transferFrom": {
31
               "locationId
LocationId

Location identifier

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

Name of location

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

Unique abbreviation/short name of the location

": "{String}",
34
               "address": {
35
                    "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}",
36
                    "addressLine1
AddressLine1

First address line

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

Second address line

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

Postalcode/Postcode/ZIP

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

City/town/village

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

Region/province/state

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

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

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

English name of country.

": "{String}"
43
               },
44
               "locationLink
LocationLink

Location reference

": "{String}"
45
          },
46
          "transferOf": {
47
               "goodsReceptionItemId
GoodsReceptionItemId

Item-/line-number of the goods reception

": "{Integer}",
48
               "productDescription
ProductDescription

Description of the product, it's by default copied from product

": "{String}",
49
               "price": {
50
                    "currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

": "{String}",
51
                    "grossPrice
GrossPrice

Represents the price per unit before any discounting is applied.

": "{Decimal}",
52
                    "netPrice
NetPrice

Final price per unit after deducting all discounts etc.

": "{Decimal}"
53
               },
54
               "measurementUnit": {
55
                    "measurementUnitId
MeasurementUnitId

Material unit reference

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

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

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

Material unit reference

": "{String}"
58
               },
59
               "product": {
60
                    "productId
ProductId

Product identifier

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

Name of the product

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

Type of product

Possible domain values can be found here

": "{String}",
63
                    "productLink
ProductLink

Product reference

": "{String}"
64
               },
65
               "manufacturer": {
66
                    "manufacturerId
ManufacturerId

Manufacturer identifier

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

Company name of the manufacturer.

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

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

Shortname/code of the manufacturer

": "{String}",
69
                    "manufacturerLink
ManufacturerLink

Manufacturer reference

": "{String}"
70
               },
71
               "manufacturersProduct
ManufacturersProduct

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

": {
72
                    "manufacturersProductId
ManufacturersProductId

Manufacturer product identifier

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

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

Manufacturers name of the product. Also known as Manufacturer Part Number (MPN).

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

": "{String}",
74
                    "manufacturersProductLink
ManufacturersProductLink

Manufacturers product reference

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

": "{String}"
75
               },
76
               "goodsReception": {
77
                    "goodsReceptionId
GoodsReceptionId

Goods reception identifier

": "{Integer}",
78
                    "goodsReceptionLink
GoodsReceptionLink

Goods reception reference

": "{String}"
79
               },
80
               "goodsReceptionItemLink
GoodsReceptionItemLink

Goods reception item reference

": "{String}"
81
          },
82
          "goodsReceptionItem
GoodsReceptionItem

The goods reception created at the new location. Will not be set before the goods transfer is completed.

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

": {
83
               "goodsReceptionItemId
GoodsReceptionItemId

Item-/line-number of the goods reception

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

": "{Integer}",
84
               "goodsReception
GoodsReception

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

": {
85
                    "goodsReceptionId
GoodsReceptionId

Goods reception identifier

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

": "{Integer}",
86
                    "goodsReceptionLink
GoodsReceptionLink

Goods reception reference

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

": "{String}"
87
               },
88
               "goodsReceptionItemLink
GoodsReceptionItemLink

Goods reception item reference

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

": "{String}"
89
          },
90
          "assignee
Assignee

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

": {
91
               "userId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

": "{String}"
95
          },
96
          "totals": {
97
               "currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

": "{String}",
98
               "netAmount
NetAmount

Final item amount after deducting all discounts etc.

": "{Decimal}"
99
          },
100
          "shipment": {
101
               "priority
Priority

Priority of the shipment

Possible domain values can be found here

": "{Integer}",
102
               "deliveryTerms
DeliveryTerms

Default delivery terms for the supplier. The delivery terms is based on the Incoterms rules from ICC (International Chamber of Commerce).

Possible domain values can be found here

": "{String}",
103
               "deliveryTermPlace
DeliveryTermPlace

A named place, which, together with the content of Delivery terms, determines where and when the costs, responsibility and risk for a shipment are transferred from the seller to the buye

": "{String}",
104
               "departingShipment": {
105
                    "shipmentId
ShipmentId

Shipment identifier

": "{Long}",
106
                    "departingWaybill": {
107
                         "departingWaybillId
DepartingWaybillId

Departing waybill identifier

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

Departing waybill reference

": "{String}"
109
                    },
110
                    "shipmentLink
ShipmentLink

Shipment reference

": "{String}"
111
               },
112
               "shippingService": {
113
                    "shippingServiceId
ShippingServiceId

Shipping service identifier

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

Name of shipping service

": "{String}",
115
                    "carrier": {
116
                         "carrierId
CarrierId

Carrier identifier

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

Name of carrier

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

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

Carrier reference

": "{String}"
119
                    },
120
                    "shippingServiceLink
ShippingServiceLink

Shipping service reference

": "{String}"
121
               }
122
          },
123
          "pickOperation": {
124
               "pickOperationId
PickOperationId

Pick operation identifier

": "{Integer}",
125
               "pickOperationLink
PickOperationLink

Pick operation reference

": "{String}"
126
          },
127
          "highlightedNotification
HighlightedNotification

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

": {
128
               "notificationId
NotificationId

Notification identifier

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

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

Status of the notification

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

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

Date and time of creation

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

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

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

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

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

": {
134
                    "notificationTypeId
NotificationTypeId

Notification type identifier

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

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

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

Notification type reference

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

": "{String}"
137
               },
138
               "notificationLink
NotificationLink

Notification reference

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

": "{String}"
139
          }
140
     }
141
}

Possible error codes the response might return:

Error 100147 HTTP 404 Notification type not found
Error 100053 HTTP 403 You have only admittance to your own suppliers