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

Area id

Unique identification of the area 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

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 Quantity

The packed number of the specified trade item.

numItemsPacked Long Read only

Abandoned

Indicates whether the delivery of this line has been abandoned. It may be necessary to give up the delivery of a line if, for example, the goods are out of stock.

abandoned Boolean Not Null

Sales price

The price at which the goods are sold.

salesPrice BigDecimal Max 999999.99

Amount

The total amount including discount.

totalAmount BigDecimal Read only

Guiding. price

Indicative price for the items delivered according to this line.

recommendedRetailPrice BigDecimal Max 999999.99

Discount in per cent.

Discounted per cent on this line.

discountPercentage BigDecimal Max 100.00

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

Times exposed

The number of times picked by this line has been postponed.

numTimesPostponed Integer Read only

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

barcode

The barcode of the ordered trade item.

globalTradeItemNumber String Read only

Shipment no.

Identification of shipment within the area.

shipmentNumber String Shipment

Shipment id

Unique identification of the shipment this line belongs to.

shipmentId Long Shipment

SKU

SKU for the item belonging to the line.

stockKeepingUnit String 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 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 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

Qty drawn

The number of packed items that are drawn from an item lot.

numItemsDrawn 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 Read only

HS Code

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

harmonizedSystemCode String Read only

Product unit

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

productUnit ProductUnit Read only

Filter

Shipment number

Expression that the number of the shipment must match.

shipmentNumberMatch String

Customer number

Only show lines from shipments for customers with a number matching this expression.

customerNumberMatch String

SKU

Expression that the SKU of the item must match.

stockKeepingUnitMatch String

GTIN

Only show lines refering to the item with this GTIN.

globalTradeItemNumber String

Delivery Date

Show only lines where the delivery date of the shipment equals this value.

deliveryDateExactMatch Date

Only abandoned

Show only lines that have been abandoned.

onlyShowAbandoned Boolean

Only not available

Show only lines that items are not available for.

onlyNotAvailable Boolean

Supplier number

Expression that the supplier number of the trade item must match.

supplierNumberMatch String

No delivery note

Only show lines from shipments with no delivery note yet.

onlyNoDeliveryNote Boolean

Only not cancelled

Only show lines belonging to shipments that are not cancelled.

onlyNotCancelled Boolean

From delivery date

Show only lines belonging to shipments with a delivery date on or after this date.

fromDeliveryDate Date

To delivery date

Show only lines belonging to shipment with a delivery date on or before this date.

toDeliveryDate Date

Shipment ids

Only show lines belong to shipments with one of these ids.

shipmentIds List