API

Logistics APIs

GET logistics/shipping-advices/{shippingAdviceId}/items/{itemId}

Details about a specific item of an shipping advice

HTTP method GET
URI https://api.rambase.net/logistics/shipping-advices/{shippingAdviceId}/items/{itemId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {shippingAdviceId} Shipping advice identifier
Integer, minimum 100000
- URI parameter {itemId} Item-/line-number of the shipping advice
Integer, minimum 1
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 2012, version 38

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.
$showCustomFields Boolean, optional Set to "true" to include custom fields. Default value is false.

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
<ShippingAdviceItem>
2
     <ShippingAdviceItemId
ShippingAdviceItemId

Item-/line-number of the shipping advice

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

Status of the shipping advice item (0-9)

Possible domain values can be found here

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

Date and time of creation

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

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

>{Integer}</LineNumber>
6
     <ScheduledShippingDate
ScheduledShippingDate

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

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

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

>{String}</CustomersReferenceNumber>
8
     <CustomersProductName
CustomersProductName

Customers internal name of the product. Retrieved from the product.

>{String}</CustomersProductName>
9
     <EquivalentProductName
EquivalentProductName

Name of product with equivalent behavior and attributes. Can be used for same purpose.

>{String}</EquivalentProductName>
10
     <RequestedProductStructureRevision
RequestedProductStructureRevision

The revision will typically be a major change, as opposed to minor changes stored in the version of the product structure.

>{String}</RequestedProductStructureRevision>
11
     <ProductDescription
ProductDescription

Description of the item. If not specified, the description is by default copied from the product.

>{String}</ProductDescription>
12
     <Note
Note

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

>{String}</Note>
13
     <GrossMargin
GrossMargin

Gross margin of the item.

>{Decimal}</GrossMargin>
14
     <VATPercent
VATPercent

Value added tax percent

>{Decimal}</VATPercent>
15
     <DiscountPercent
DiscountPercent

The discount in percent for this item.

>{Decimal}</DiscountPercent>
16
     <Quantity
Quantity

Quantity of the shipping advice item

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

Remaining number of units to be forwarded.

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

Two-character code (ISO 3166) identifying the default country where the product is produced. This value is inherrited from the assigned goods reception(s). If not country of origin is specified for the goods reception(s), country of origin is retrieved from the product. If assigned to multiple goods receptions with different origin, the field will be empty.

>{String}</CountryOfOriginCode>
19
     <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>
20
     <EndCustomer
EndCustomer

End customer

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

>
21
          <CustomerId
CustomerId

Customer identifier

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

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

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

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

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

Secondary name of a company or firstname of a person

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

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

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

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

>{String}</VATRegistrationNumber>
25
          <CustomerLink
CustomerLink

Customer reference

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

>{String}</CustomerLink>
26
     </EndCustomer>
27
     <Warranty>
28
          <IsPaymentCoveredByWarranty
IsPaymentCoveredByWarranty

True if payment of item will be covered by warranty. For sales order items that are a part of the repair process, it means that these will not be invoiced.

>{Boolean}</IsPaymentCoveredByWarranty>
29
          <ExpirationDate
ExpirationDate

Date of warranty expiration.

>{Date}</ExpirationDate>
30
     </Warranty>
31
     <Price>
32
          <Currency
Currency

Three character code following the ISO 4217 standard

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

Represents the price per unit before any discounting is applied.

>{Decimal}</GrossPrice>
34
          <Discount
Discount

The discount for the item.

>{Decimal}</Discount>
35
          <NetPrice
NetPrice

Final price per unit after deducting all discounts etc.

>{Decimal}</NetPrice>
36
     </Price>
37
     <PriceConverted
PriceConverted

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

>
38
          <Currency
Currency

Three character code following the ISO 4217 standard

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

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

Represents the price per unit before any discounting is applied.

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

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

Final price per unit after deducting all discounts.

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

>{Decimal}</NetPrice>
41
     </PriceConverted>
42
     <Totals>
43
          <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
44
          <GrossAmount
GrossAmount

Represents the item amount before any discounts etc. is applied.

>{Decimal}</GrossAmount>
45
          <DiscountAmount
DiscountAmount

The items discount amount.

>{Decimal}</DiscountAmount>
46
          <NetAmount
NetAmount

Final item amount after deducting all discounts etc.

>{Decimal}</NetAmount>
47
          <RemainingAmount
RemainingAmount

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

>{Decimal}</RemainingAmount>
48
     </Totals>
49
     <TotalsConverted
TotalsConverted

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

>
50
          <Currency
Currency

Three character code following the ISO 4217 standard

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

>{String}</Currency>
51
          <GrossAmount
GrossAmount

Total gross amount in company currency.

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

>{Decimal}</GrossAmount>
52
          <NetAmount
NetAmount

Total net amount in company currency.

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

>{Decimal}</NetAmount>
53
          <RemainingAmount
RemainingAmount

Total remaining amount in company currency.

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

>{Decimal}</RemainingAmount>
54
     </TotalsConverted>
55
     <Seller
Seller

Reference to the seller of the item

>
56
          <EmployeeId
EmployeeId

Employee identifier

>{Integer}</EmployeeId>
57
          <FirstName
FirstName

First name of employee

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

>{String}</FirstName>
58
          <LastName
LastName

Last name of employee

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

>{String}</LastName>
59
          <EmployeeLink
EmployeeLink

Employee reference

>{String}</EmployeeLink>
60
     </Seller>
61
     <MeasurementUnit>
62
          <MeasurementUnitId
MeasurementUnitId

Measurement unit identifier

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

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

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

Material unit reference

>{String}</MeasurementUnitLink>
65
     </MeasurementUnit>
66
     <Product>
67
          <ProductId
ProductId

Product identifier

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

Name of the product

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

Type of product

Possible domain values can be found here

>{String}</Type>
70
          <CustomField1
CustomField1

Custom field for grouping, sorting, categorizing and other purposes.

>{String}</CustomField1>
71
          <CustomField2
CustomField2

Custom field for grouping, sorting, categorizing and other purposes.

>{String}</CustomField2>
72
          <Weight
Weight

The weight of the product in kilograms.

>{Decimal}</Weight>
73
          <Manufacturer>
74
               <ManufacturerId
ManufacturerId

Manufacturer identifier

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

Company name of the manufacturer.

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

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

Shortname/code of the manufacturer

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

Manufacturer reference

>{String}</ManufacturerLink>
78
          </Manufacturer>
79
          <ProductClassification>
80
               <ProductClassificationId
ProductClassificationId

Product classification identifier

>{String}</ProductClassificationId>
81
               <ProductClassificationLink
ProductClassificationLink

Product classification reference

>{String}</ProductClassificationLink>
82
          </ProductClassification>
83
          <Stock>
84
               <IsNonStock
IsNonStock

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

>{Boolean}</IsNonStock>
85
          </Stock>
86
          <LatestProductRevision
LatestProductRevision

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

>
87
               <Revision
Revision

Revision number

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

>{String}</Revision>
88
          </LatestProductRevision>
89
          <ProductLink
ProductLink

Product reference

>{String}</ProductLink>
90
     </Product>
91
     <ProductStructure>
92
          <ProductStructureId
ProductStructureId

Product structure reference

>{Integer}</ProductStructureId>
93
          <ProductStructureLink
ProductStructureLink

Product structure reference

>{String}</ProductStructureLink>
94
     </ProductStructure>
95
     <LandedCost>
96
          <PurchaseCurrency
PurchaseCurrency

Purchase currency is the currency this product normally is purchased in. This is also the base currency used in the gross margin calculation. By default the purchase currency is retrieved from the product.

Possible domain values can be found here

>{String}</PurchaseCurrency>
97
          <PurchasePrice
PurchasePrice

Purchase price for each unit

>{Decimal}</PurchasePrice>
98
          <Freight
Freight

Estimated freight cost of getting each unit in stock. Used for calculating landed cost.

>{Decimal}</Freight>
99
          <Duty
Duty

Duty cost of getting each unit in stock. Used for calculating landed cost.

>{Decimal}</Duty>
100
          <Charge
Charge

Other costs of getting each unit in stock. Used for calculating landed cost.

>{Decimal}</Charge>
101
          <GrossPrice
GrossPrice

Total cost (landed cost or true cost) of getting each unit in stock, including purchase price, duties, charges, freight etc.

>{Decimal}</GrossPrice>
102
          <PurchaseExchangeRate
PurchaseExchangeRate

Exchange rate between document currency and purchase currency. Used in landed cost calculations.

>{Decimal}</PurchaseExchangeRate>
103
          <IsDerivedFromUserInput
IsDerivedFromUserInput

True if landed cost is derived from manual user input. Landed cost can only be manually updated for products without assignments

>{Boolean}</IsDerivedFromUserInput>
104
          <IsDerivedFromAssignedStock
IsDerivedFromAssignedStock

True if landed cost for this item is derived from assigned stock. This means that the item has reserved goods in stock.

>{Boolean}</IsDerivedFromAssignedStock>
105
          <DerivedFrom>
106
               <PurchaseQuoteItemId
PurchaseQuoteItemId

Purchase quote item identifier

>{Integer}</PurchaseQuoteItemId>
107
               <PurchaseQuote>
108
                    <Database
Database

Database of the object

>{String}</Database>
109
                    <PurchaseQuoteId
PurchaseQuoteId

Purchase quote identifier

>{Integer}</PurchaseQuoteId>
110
                    <PurchaseQuoteLink
PurchaseQuoteLink

Purchase quote reference

>{String}</PurchaseQuoteLink>
111
               </PurchaseQuote>
112
               <PurchaseQuoteItemLink
PurchaseQuoteItemLink

Purchase quote item link

>{String}</PurchaseQuoteItemLink>
113
          </DerivedFrom>
114
     </LandedCost>
115
     <LandedCostConverted
LandedCostConverted

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

>
116
          <Currency
Currency

Three character code following the ISO 4217 standard

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

>{String}</Currency>
117
          <PurchasePrice
PurchasePrice

Purchase price in sales currency.

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

>{Decimal}</PurchasePrice>
118
          <Freight
Freight

Freigth cost in sales currency.

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

>{Decimal}</Freight>
119
          <Duty
Duty

Duty costs in sales currency.

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

>{Decimal}</Duty>
120
          <Charge
Charge

Other cost in sales currency

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

>{Decimal}</Charge>
121
          <GrossPrice
GrossPrice

Total cost (landed cost or true cost) in sales currency

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

>{Decimal}</GrossPrice>
122
     </LandedCostConverted>
123
     <Accounting
Accounting

Accounting details for the item, including fixed/system dimensions. For all dimensions, see seperate resource.

>
124
          <VATCodeDefinition>
125
               <VATCode
VATCode

Code that determines VAT rules used for VAT calculations.

>{String}</VATCode>
126
               <Description
Description

Description of VAT Code definition

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

>{String}</Description>
127
          </VATCodeDefinition>
128
          <GeneralLedgerAccount>
129
               <GeneralLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

>{Integer}</GeneralLedgerAccountId>
130
               <GeneralLedgerAccountLink
GeneralLedgerAccountLink

General ledger account reference

>{String}</GeneralLedgerAccountLink>
131
          </GeneralLedgerAccount>
132
          <Department
Department

The department related to the item. One of the system/fixed account dimensions.

>
133
               <DepartmentId
DepartmentId

Department identifier

>{Integer}</DepartmentId>
134
               <DepartmentLink
DepartmentLink

Finance department reference

>{String}</DepartmentLink>
135
          </Department>
136
          <FinanceProject
FinanceProject

The finance project related to the item. One of the system/fixed account dimensions.

>
137
               <FinanceProjectId
FinanceProjectId

Finance project identifier

>{Integer}</FinanceProjectId>
138
               <FinanceProjectLink
FinanceProjectLink

Finance project reference

>{String}</FinanceProjectLink>
139
          </FinanceProject>
140
          <Asset
Asset

The asset related to the item. One of the system/fixed account dimensions.

>
141
               <AssetId
AssetId

Asset identifier

>{Integer}</AssetId>
142
               <AssetLink
AssetLink

Asset reference

>{String}</AssetLink>
143
          </Asset>
144
     </Accounting>
145
     <InitialSalesOrderItem
InitialSalesOrderItem

Reference to the initial/first/original sales order item in the document flow for this item.

>
146
          <SalesOrderItemId
SalesOrderItemId

Sales order item identifier

>{Integer}</SalesOrderItemId>
147
          <SalesOrder>
148
               <SalesOrderId
SalesOrderId

Sales order identifier

>{Integer}</SalesOrderId>
149
               <SalesOrderLink
SalesOrderLink

Sales order reference

>{String}</SalesOrderLink>
150
          </SalesOrder>
151
          <SalesOrderItemLink
SalesOrderItemLink

Reference to the sales order item.

>{String}</SalesOrderItemLink>
152
     </InitialSalesOrderItem>
153
     <ForwardedFrom
ForwardedFrom

The preceding/previous/source item.

>
154
          <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
155
          <ForwardedNetAmount
ForwardedNetAmount

The net amount forwarded to this item.

>{Decimal}</ForwardedNetAmount>
156
          <ForwardedQuantity
ForwardedQuantity

The quantity forwarded to this item.

>{Decimal}</ForwardedQuantity>
157
          <ForwardedFromItem>
158
               <ItemId
ItemId

Identifier of the object

>{Integer}</ItemId>
159
               <Object>
160
                    <ObjectId
ObjectId

Identifier of the object

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

Type of object

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

API reference to the object

>{String}</ObjectLink>
163
               </Object>
164
               <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

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

API reference to the item

>{String}</ItemLink>
166
          </ForwardedFromItem>
167
     </ForwardedFrom>
168
     <ForwardedTo
ForwardedTo

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

>
169
          <OpenForwardedQuantity
OpenForwardedQuantity

When items are forwarded they end up in one or more open items. Open items in this context means items that are not registered (status 0 or 1). OpenForwardedQuantity will be the sum of ForwardedQuantity of all items this item has been forwarded to.

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

>{Decimal}</OpenForwardedQuantity>
170
          <ForwardedToItems
ForwardedToItems

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

>
171
               <Item
Item

Item this item was forwarded to.

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

>
172
                    <ItemId
ItemId

Identifier of the object

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

>{Integer}</ItemId>
173
                    <Object
Object

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

>
174
                         <ObjectId
ObjectId

Identifier of the object

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

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

Type of object

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

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

API reference to the object

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

>{String}</ObjectLink>
177
                    </Object>
178
                    <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

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

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

API reference to the item

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

>{String}</ItemLink>
180
               </Item>
181
          </ForwardedToItems>
182
     </ForwardedTo>
183
     <PickOperation>
184
          <PickOperationId
PickOperationId

Pick operation identifier

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

Pick operation reference

>{String}</PickOperationLink>
186
     </PickOperation>
187
     <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

>
188
          <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>
189
          <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>
190
          <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>
191
          <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>
192
          <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>
193
          <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

>
194
               <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>
195
               <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>
196
               <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>
197
          </NotificationType>
198
          <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>
199
     </HighlightedNotification>
200
     <Rental
Rental

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

>
201
          <SerialNumberSpecification
SerialNumberSpecification

For shipping advice items of type RENTALORDER, each item can have a serial number specified.

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

>
202
               <SerialNumber
SerialNumber

Serial number

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

>{String}</SerialNumber>
203
          </SerialNumberSpecification>
204
     </Rental>
205
</ShippingAdviceItem>
1
{
2
     "shippingAdviceItem": {
3
          "shippingAdviceItemId
ShippingAdviceItemId

Item-/line-number of the shipping advice

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

Status of the shipping advice item (0-9)

Possible domain values can be found here

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

Date and time of creation

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

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

": "{Integer}",
7
          "scheduledShippingDate
ScheduledShippingDate

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

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

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

": "{String}",
9
          "customersProductName
CustomersProductName

Customers internal name of the product. Retrieved from the product.

": "{String}",
10
          "equivalentProductName
EquivalentProductName

Name of product with equivalent behavior and attributes. Can be used for same purpose.

": "{String}",
11
          "requestedProductStructureRevision
RequestedProductStructureRevision

The revision will typically be a major change, as opposed to minor changes stored in the version of the product structure.

": "{String}",
12
          "productDescription
ProductDescription

Description of the item. If not specified, the description is by default copied from the product.

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

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

": "{String}",
14
          "grossMargin
GrossMargin

Gross margin of the item.

": "{Decimal}",
15
          "vATPercent
VATPercent

Value added tax percent

": "{Decimal}",
16
          "discountPercent
DiscountPercent

The discount in percent for this item.

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

Quantity of the shipping advice item

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

Remaining number of units to be forwarded.

": "{Decimal}",
19
          "countryOfOriginCode
CountryOfOriginCode

Two-character code (ISO 3166) identifying the default country where the product is produced. This value is inherrited from the assigned goods reception(s). If not country of origin is specified for the goods reception(s), country of origin is retrieved from the product. If assigned to multiple goods receptions with different origin, the field will be empty.

": "{String}",
20
          "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}",
21
          "endCustomer
EndCustomer

End customer

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

": {
22
               "customerId
CustomerId

Customer identifier

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

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

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

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

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

Secondary name of a company or firstname of a person

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

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

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

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

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

Customer reference

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

": "{String}"
27
          },
28
          "warranty": {
29
               "isPaymentCoveredByWarranty
IsPaymentCoveredByWarranty

True if payment of item will be covered by warranty. For sales order items that are a part of the repair process, it means that these will not be invoiced.

": "{Boolean}",
30
               "expirationDate
ExpirationDate

Date of warranty expiration.

": "{Date}"
31
          },
32
          "price": {
33
               "currency
Currency

Three character code following the ISO 4217 standard

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

Represents the price per unit before any discounting is applied.

": "{Decimal}",
35
               "discount
Discount

The discount for the item.

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

Final price per unit after deducting all discounts etc.

": "{Decimal}"
37
          },
38
          "priceConverted
PriceConverted

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

": {
39
               "currency
Currency

Three character code following the ISO 4217 standard

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

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

Represents the price per unit before any discounting is applied.

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

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

Final price per unit after deducting all discounts.

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

": "{Decimal}"
42
          },
43
          "totals": {
44
               "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
45
               "grossAmount
GrossAmount

Represents the item amount before any discounts etc. is applied.

": "{Decimal}",
46
               "discountAmount
DiscountAmount

The items discount amount.

": "{Decimal}",
47
               "netAmount
NetAmount

Final item amount after deducting all discounts etc.

": "{Decimal}",
48
               "remainingAmount
RemainingAmount

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

": "{Decimal}"
49
          },
50
          "totalsConverted
TotalsConverted

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

": {
51
               "currency
Currency

Three character code following the ISO 4217 standard

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

": "{String}",
52
               "grossAmount
GrossAmount

Total gross amount in company currency.

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

": "{Decimal}",
53
               "netAmount
NetAmount

Total net amount in company currency.

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

": "{Decimal}",
54
               "remainingAmount
RemainingAmount

Total remaining amount in company currency.

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

": "{Decimal}"
55
          },
56
          "seller
Seller

Reference to the seller of the item

": {
57
               "employeeId
EmployeeId

Employee identifier

": "{Integer}",
58
               "firstName
FirstName

First name of employee

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

": "{String}",
59
               "lastName
LastName

Last name of employee

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

": "{String}",
60
               "employeeLink
EmployeeLink

Employee reference

": "{String}"
61
          },
62
          "measurementUnit": {
63
               "measurementUnitId
MeasurementUnitId

Measurement unit identifier

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

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

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

Material unit reference

": "{String}"
66
          },
67
          "product": {
68
               "productId
ProductId

Product identifier

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

Name of the product

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

Type of product

Possible domain values can be found here

": "{String}",
71
               "customField1
CustomField1

Custom field for grouping, sorting, categorizing and other purposes.

": "{String}",
72
               "customField2
CustomField2

Custom field for grouping, sorting, categorizing and other purposes.

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

The weight of the product in kilograms.

": "{Decimal}",
74
               "manufacturer": {
75
                    "manufacturerId
ManufacturerId

Manufacturer identifier

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

Company name of the manufacturer.

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

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

Shortname/code of the manufacturer

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

Manufacturer reference

": "{String}"
79
               },
80
               "productClassification": {
81
                    "productClassificationId
ProductClassificationId

Product classification identifier

": "{String}",
82
                    "productClassificationLink
ProductClassificationLink

Product classification reference

": "{String}"
83
               },
84
               "stock": {
85
                    "isNonStock
IsNonStock

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

": "{Boolean}"
86
               },
87
               "latestProductRevision
LatestProductRevision

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

": {
88
                    "revision
Revision

Revision number

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

": "{String}"
89
               },
90
               "productLink
ProductLink

Product reference

": "{String}"
91
          },
92
          "productStructure": {
93
               "productStructureId
ProductStructureId

Product structure reference

": "{Integer}",
94
               "productStructureLink
ProductStructureLink

Product structure reference

": "{String}"
95
          },
96
          "landedCost": {
97
               "purchaseCurrency
PurchaseCurrency

Purchase currency is the currency this product normally is purchased in. This is also the base currency used in the gross margin calculation. By default the purchase currency is retrieved from the product.

Possible domain values can be found here

": "{String}",
98
               "purchasePrice
PurchasePrice

Purchase price for each unit

": "{Decimal}",
99
               "freight
Freight

Estimated freight cost of getting each unit in stock. Used for calculating landed cost.

": "{Decimal}",
100
               "duty
Duty

Duty cost of getting each unit in stock. Used for calculating landed cost.

": "{Decimal}",
101
               "charge
Charge

Other costs of getting each unit in stock. Used for calculating landed cost.

": "{Decimal}",
102
               "grossPrice
GrossPrice

Total cost (landed cost or true cost) of getting each unit in stock, including purchase price, duties, charges, freight etc.

": "{Decimal}",
103
               "purchaseExchangeRate
PurchaseExchangeRate

Exchange rate between document currency and purchase currency. Used in landed cost calculations.

": "{Decimal}",
104
               "isDerivedFromUserInput
IsDerivedFromUserInput

True if landed cost is derived from manual user input. Landed cost can only be manually updated for products without assignments

": "{Boolean}",
105
               "isDerivedFromAssignedStock
IsDerivedFromAssignedStock

True if landed cost for this item is derived from assigned stock. This means that the item has reserved goods in stock.

": "{Boolean}",
106
               "derivedFrom": {
107
                    "purchaseQuoteItemId
PurchaseQuoteItemId

Purchase quote item identifier

": "{Integer}",
108
                    "purchaseQuote": {
109
                         "database
Database

Database of the object

": "{String}",
110
                         "purchaseQuoteId
PurchaseQuoteId

Purchase quote identifier

": "{Integer}",
111
                         "purchaseQuoteLink
PurchaseQuoteLink

Purchase quote reference

": "{String}"
112
                    },
113
                    "purchaseQuoteItemLink
PurchaseQuoteItemLink

Purchase quote item link

": "{String}"
114
               }
115
          },
116
          "landedCostConverted
LandedCostConverted

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

": {
117
               "currency
Currency

Three character code following the ISO 4217 standard

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

": "{String}",
118
               "purchasePrice
PurchasePrice

Purchase price in sales currency.

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

": "{Decimal}",
119
               "freight
Freight

Freigth cost in sales currency.

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

": "{Decimal}",
120
               "duty
Duty

Duty costs in sales currency.

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

": "{Decimal}",
121
               "charge
Charge

Other cost in sales currency

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

": "{Decimal}",
122
               "grossPrice
GrossPrice

Total cost (landed cost or true cost) in sales currency

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

": "{Decimal}"
123
          },
124
          "accounting
Accounting

Accounting details for the item, including fixed/system dimensions. For all dimensions, see seperate resource.

": {
125
               "vATCodeDefinition": {
126
                    "vATCode
VATCode

Code that determines VAT rules used for VAT calculations.

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

Description of VAT Code definition

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

": "{String}"
128
               },
129
               "generalLedgerAccount": {
130
                    "generalLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

": "{Integer}",
131
                    "generalLedgerAccountLink
GeneralLedgerAccountLink

General ledger account reference

": "{String}"
132
               },
133
               "department
Department

The department related to the item. One of the system/fixed account dimensions.

": {
134
                    "departmentId
DepartmentId

Department identifier

": "{Integer}",
135
                    "departmentLink
DepartmentLink

Finance department reference

": "{String}"
136
               },
137
               "financeProject
FinanceProject

The finance project related to the item. One of the system/fixed account dimensions.

": {
138
                    "financeProjectId
FinanceProjectId

Finance project identifier

": "{Integer}",
139
                    "financeProjectLink
FinanceProjectLink

Finance project reference

": "{String}"
140
               },
141
               "asset
Asset

The asset related to the item. One of the system/fixed account dimensions.

": {
142
                    "assetId
AssetId

Asset identifier

": "{Integer}",
143
                    "assetLink
AssetLink

Asset reference

": "{String}"
144
               }
145
          },
146
          "initialSalesOrderItem
InitialSalesOrderItem

Reference to the initial/first/original sales order item in the document flow for this item.

": {
147
               "salesOrderItemId
SalesOrderItemId

Sales order item identifier

": "{Integer}",
148
               "salesOrder": {
149
                    "salesOrderId
SalesOrderId

Sales order identifier

": "{Integer}",
150
                    "salesOrderLink
SalesOrderLink

Sales order reference

": "{String}"
151
               },
152
               "salesOrderItemLink
SalesOrderItemLink

Reference to the sales order item.

": "{String}"
153
          },
154
          "forwardedFrom
ForwardedFrom

The preceding/previous/source item.

": {
155
               "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
156
               "forwardedNetAmount
ForwardedNetAmount

The net amount forwarded to this item.

": "{Decimal}",
157
               "forwardedQuantity
ForwardedQuantity

The quantity forwarded to this item.

": "{Decimal}",
158
               "forwardedFromItem": {
159
                    "itemId
ItemId

Identifier of the object

": "{Integer}",
160
                    "object": {
161
                         "objectId
ObjectId

Identifier of the object

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

Type of object

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

API reference to the object

": "{String}"
164
                    },
165
                    "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

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

API reference to the item

": "{String}"
167
               }
168
          },
169
          "forwardedTo
ForwardedTo

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

": {
170
               "openForwardedQuantity
OpenForwardedQuantity

When items are forwarded they end up in one or more open items. Open items in this context means items that are not registered (status 0 or 1). OpenForwardedQuantity will be the sum of ForwardedQuantity of all items this item has been forwarded to.

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

": "{Decimal}",
171
               "forwardedToItems
ForwardedToItems

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

": [
172
                    {
173
                         "itemId
ItemId

Identifier of the object

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

": "{Integer}",
174
                         "object
Object

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

": {
175
                              "objectId
ObjectId

Identifier of the object

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

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

Type of object

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

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

API reference to the object

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

": "{String}"
178
                         },
179
                         "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

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

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

API reference to the item

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

": "{String}"
181
                    }
182
               ]
183
          },
184
          "pickOperation": {
185
               "pickOperationId
PickOperationId

Pick operation identifier

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

Pick operation reference

": "{String}"
187
          },
188
          "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

": {
189
               "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}",
190
               "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}",
191
               "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}",
192
               "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}",
193
               "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}",
194
               "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

": {
195
                    "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}",
196
                    "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}",
197
                    "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}"
198
               },
199
               "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}"
200
          },
201
          "rental
Rental

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

": {
202
               "serialNumberSpecification
SerialNumberSpecification

For shipping advice items of type RENTALORDER, each item can have a serial number specified.

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

": {
203
                    "serialNumber
SerialNumber

Serial number

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

": "{String}"
204
               }
205
          }
206
     }
207
}

Possible error codes the response might return:

Error 100027 HTTP 400 Missing mandatory parameter {0}
Error 101420 HTTP 404 Setting definition not found