Shipment line

Definition

A shipping line tells you how much is to be delivered by a given item on a given shipment.

ShipmentLine

Constraints

You must provide either an id or a SKU for a trade item. You must provide either an id or a number of a shipment.

Fields

Id

Unique identification of this shipping line across subscriptions and territories.

id Long Read only

Context id

Unique identification of the context that this line belongs to.

contextId Long Context

Ordered quantity

The ordered quantity of the specified trade item. The field does NOT contain the ordered quantity of the product. For example, if each copy of the trade item contains 6 pieces of the product and the customer has ordered 18 pieces of the product, then this field must have the value 3.

numItemsOrdered Long Not Null Min 1 Max 9999999

Units contained

The number of units contained in one piece of the trade item related to this line.

numUnitsContained Long Read only

Sellers ref.

Sellers reference to this shipment line. Could for instance be the identification of the corresponding order line.

sellersReference String

Packed qty

The packed number of the specified trade item.

numItemsPacked Long Read only

Picked qty

Number of item specimens that has been picked for this line.

numItemsPicked Long Read only

Abandoned

Indicates whether the packing of the remaining quantity has been abandoned. If the item is not stocked and not eligable for cross-docking this field is set from the creation of the line. You may choose to set this field, if the item against expectation is not on stock. Abandoned lines will not prevent the finishing of the packing.

abandoned Boolean Not Null

Sales price

The price at which the goods are sold.

salesPrice BigDecimal Min 0.00 Max 99999999.9999 Integer 8, Fraction 4

Amount

The total amount including discount.

totalAmount BigDecimal Read only

Recommended retail price

Indicative price for the items delivered according to this line.

recommendedRetailPrice BigDecimal Min 0.00 Max 999999.99 Integer 6, Fraction 2

Discount in per cent.

Discounted per cent on this line.

discountPercentage BigDecimal Min 0.00 Max 100.00 Integer 3, Fraction 2

VAT pct.

VAT as a percentage of the amount on this line.

vatPercentage BigDecimal Min 0.00 Max 100.00 Integer 3, Fraction 2

Standard cost price

Standard cost price of the trade item related to this line.

standardCostPrice BigDecimal Read only

Order reference

Reference to the order on which this shipment line is based.

orderReference String

Note to picker

Note to picker. For example, please describe which items to pick (batch number, serial number, etc.).

notesOnPicking String

Customers itemno.

Number used by the customer to identify the item sold on this line.

customersItemNumber String

Reservation id

Unique identification of the reservation previously made of the goods to be delivered according to this line.

reservationId Long Reservation

GTIN

The barcode of the ordered trade item.

globalTradeItemNumber String Read only

Shipment no.

Identification of shipment within the context.

shipmentNumber String Not Null Length 1 to 36 Shipment

Shipment id

Unique identification of the shipment this line belongs to.

shipmentId Long Not Null Shipment

SKU

SKU for the item belonging to the line.

stockKeepingUnit String Not Null Length 1 to 36 GlobalTradeItem

Product No.

The number of the product that this shipmentLine applies to.

productNumber String Read only

Product name

The name of the product that this shipmentLine applies to.

productName String Read only

Trade item id

Unique identification of the trade item.

globalTradeItemId Long Not Null GlobalTradeItem

Variant

Information that identifies this trade item as a variant of the product.

productVariantKey ProductVariantKey Read only

Product id

Unique identification of the product contained in the trade item related to this line.

productId Long Not Null Read only Product

Reservation priority

Priority of the reservation made for items for this line.

reservationPriority Integer Read only

Reservation text

Text assigned to the reservation made of items for this line.

reservationText String Read only

Reserved quantity

The quantity of the reservation that this line is attached to.

numItemsReserved Long Read only

Available quantity

The quantity available to the reservation that this line is attached to.

numItemsAvailable Long Read only

Available

Shows whether the items for this shipment line is currently available.

available Boolean

HS Code

Harmonized System Code of the product contained in the trade item related to this line.

harmonizedSystemCode String Read only

Import/Export text

Text used on im- and export to describe the product contained in the trade item that this lines relates to.

importExportText String Read only

Weight each

The weight of one instance of the trade item that this line relates to.

weight BigDecimal Read only

Product unit

Unit of the product contained in the trade item this line refers to.

productUnit ProductUnit Read only

Customs tariff no.

The customs tariff number of the item in the country of delivery.

customsTariffNumber String Read only

Delivery note id

Unique identification of the delivery note that has been created for the shipment that this line belongs to.

deliveryNoteId Long Read only Document

Cost of sales list id

Unique identification of the cost of sales list that has been created for the shipment that this line belongs to.

costOfSalesListId Long Read only Document