Shipment

Definition

A shipment typically covers the expedition of a single sales order. However, a shipment may also cover the expedition of multiple sales orders with the same customer and delivery point. Finally, it is also possible that a shipment can cover the expedition of a part of an order.

Shipment

Constraints

You must supply either an id or a number of a customer. You can not have more than 1000 lines on a shipment.

Fields

Id

Synthetic key that uniquely identifies the shipment. This key must be used for updates and deletions of the shipment.

id Long Read only

No.

Unique identification of the shipment within an context.

shipmentNumber String Unique Length 1 to 36 Pattern [^\t^\n^\x0B^\f^\r]* Not Blank

Sellers ref.

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

sellersReference String Length 1 to 36

Carrier

Carrier that has been chosen for this shipment.

carrierName String Carrier

Carrier id

Unique identification of the carrier.

carrierId Long Carrier

Delivery address

Address where the shipment is to be transferred to or collected by the customer.

deliveryAddress Address

Sales channel address

Address of the sales channel through which this shipment was made.

sellerAddress Address Read only

Customer address

Address of the customer who is to receive this shipment.

customerAddress Address Read only

Delivery Date

Date of delivery.

deliveryDate Date Format yyyy-MM-dd

Incoterms

Incoterms agreed on for this shipment.

incoterms Incoterms

Deadline

Deadline for dispatch of this shipment.

shippingDeadline Date Format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'

Our reference

A text that indicates a reference to your use. For example, it may be the name of the person who has received the order for the order.

ourReference String Length 0 to 255

Your reference

The customers reference regarding this order. Could for instance be the number of the customers requisition.

customersReference String Length 0 to 255

Other reference

A text for optional use for further identification of the shipment.

otherReference String Length 0 to 255

Requisition

The number of the requisition received from the customer.

customersRequisitionNumber String Length 0 to 255

On hold

Indicates that the shipment is 'on hold' and therefore neither must be picked or packed.

onHold Boolean

Canceled

Indicates that this shipment will not be delivered anyway.

cancelled Boolean

Wave name

Name of the wave in which this shipment is or was picked and packed.

waveName String Wave

Wave id

Unique identification of the wave in which this shipment is or was picked and packed.

waveId Long Wave

Shipping prio.

The priority for the shipping. Translates into carrier specific products like 'standard' and 'express'.

shippingPriority Integer

Private

Indicates whether the receipient is a private person.

privateDelivery Boolean

Require receipt

Indicates whether customer must sign of on the receipt of the shipment.

requireReceiptOnDelivery Boolean

Unattended

Indicates whether delivery may happen without the attendance of the customer.

unattendedDelivery Boolean

Contact person

Person to be contacted by all inquiries regarding this shipment.

contactPerson ContactPerson

Sales channel contact person

Your contact person with the sales channel through which this shipment was made.

sellerContactPerson ContactPerson Read only

Created

The date on which this shipment was created.

timeCreated Date Format yyyy-MM-dd'T'HH:mm:ss.SSS'Z' Read only

Notes for packing

Notes relating to requirements or wishes for packing this shipment.

notesOnPacking String

Notes for shipment

Notes relating to requirements or wishes for dispatch of the shipment.

notesOnShipping String

Notes for delivery

Notes relating to requirements or wishes for the delivery of this shipment.

notesOnDelivery String

Terms & Conditions

The terms under which this shipment is shipped.

termsOfDelivery String Length 0 to 255

Payment terms

Payment terms for the items delivered on this shipment.

termsOfPayment String Length 0 to 255

Transport required

Indicates whether transport is required for the delivery of this shipment.

transportRequired Boolean

Deliver to PUP

Should this shipment be delivered to one of the carriers pick-up-points?

deliverToPickUpPoint Boolean

Pick-up point

The shipper's identification of the agreed pick-up point.

pickUpPointId String Length 1 to 36

Customer no.

Unique identification of the customer within this context.

customerNumber String Not Null Customer

Customer id

Unique identification of the customer related to this shipment.

customerId Long Not Null Customer

Sales Channel

The number of the device / company / web-shop that has sold the goods.

sellerNumber String Seller

Sales channel id

Unique identification of the sales channel that this shipment was created through.

sellerId Long Seller

Delivery note number

The number of the delivery note used for this shipment.

deliveryNoteNumber Long Read only

Delivery note id

Unique identification of the delivery note that belongs to this shipment.

deliveryNoteId Long Read only Document

Pick list no.

Number of the picking list that includes this shipment.

pickingListNumber Long Read only

Picking list id

Unique identification of the picking list belonging to this shipment.

pickingListId Long Read only Document

Transport booking no.

The number of the transport booking made with the carrier for this shipment.

transportBookingNumber Long Read only

Transport booking id

Unique identification of the booking made with the carrier for this shipment.

transportBookingId Long Read only Document

Transport booked

Time of creation of the transport booking related to this shipment.

transportBookingTimeCreated Date Format yyyy-MM-dd'T'HH:mm:ss.SSS'Z' Read only

Box

The number of the box to which these items are or are being picked.

pickToBoxNumber Integer Read only

Freight Paid

The freight received by the consignee of the shipment.

freightCharged BigDecimal Min 0.00 Max 999999.99 Integer 6, Fraction 2

Discount given

The discount given on the total amount.

discountGiven BigDecimal Min 0.00 Max 999999.99 Integer 6, Fraction 2

VAT

Estimated VAT on this shipment.

vatAmount BigDecimal Min 0.00 Max 999999.99 Integer 6, Fraction 2

Amount Paid

The amount of any payment made in connection with the creation of the order for this shipment.

paymentAmount BigDecimal Min 0.00 Max 999999.99 Integer 6, Fraction 2

Currency code

Currency code applicable to all amounts on this shipment.

currencyCode CurrencyCode

Exchange rate

Exchange rate applicable to all amounts on this shipment.

currencyExchangeRate BigDecimal Max 999999.999999 Min 0.000001 Integer 6, Fraction 6

Show on handheld

Indicates whether this shipment should appear in the package summary of handheld devices.

showOnMobile Boolean

status

Summary of this order's status in a single field.

shippingStatus ShippingStatus Read only

Carriers reference

Number assigned to this shipment by the carrier or forwarder.

carriersShipmentNumber String

Pick list created

Creation time of the pick list that includes this shipment.

pickingListTimeCreated Date Format yyyy-MM-dd'T'HH:mm:ss.SSS'Z' Read only

Follow-up note created

The time of creation of the delivery note for this shipment.

deliveryNoteTimeCreated Date Format yyyy-MM-dd'T'HH:mm:ss.SSS'Z' Read only

Context id

Unique identification of the context in which this shipment is created.

contextId Long Context

Lines

Lines that tell you which items are to be picked, packed and included in this shipment.

shipmentLines List ShipmentLine

Shipping containers

Shipping containers included in this shipment.

shippingContainers List

Vatno.

The VAT number of the customer.

vatNumber String Read only

Created event id

Unique identification of the shipment created event.

shipmentCreatedEventId String Read only

Consignmentno.

Number of the consignment note created when this shipment was picked up.

consignmentNoteNumber Long Read only

Consignment note id

Unique identification of the consignment note that includes this shipment.

consignmentNoteId Long Read only Document

Cost of sales list no.

Number of the cost of sales list that this shipment is contained in.

costOfSalesListNumber Long Read only

Cost of sales list id

Unique identification of the cost of sales list containing this shipment.

costOfSalesListId Long Read only Document

Cost of sales list created

Time of creation of the cost of sales list that contains this shipment.

costOfSalesListTimeCreated Date Format yyyy-MM-dd'T'HH:mm:ss.SSS'Z' Read only

Consignment note created

Time of the creation of the consignment note that includes this shipment.

consignmentNoteTimeCreated Date Format yyyy-MM-dd'T'HH:mm:ss.SSS'Z' Read only

Data document

JSON document containing additional information about this shipment.

dataDocument String JSON

Filter

Delivery Horizon

Only show shipments for delivery within this number of days.

deliveryHorizonInDays Integer

Shipment number

Only show shipments whose number matches this term.

shipmentNumberMatch String

Kunde

Vis kun forsendelser til kunder hvis nummer matcher dette udtryk.

customerNumberMatch String

Delivery address

Only show shipments where a portion of the shipping address matches this term.

deliveryAddressMatch String

Status

Only show shipments with this status.

shippingStatus ShippingStatus

Zip code

Only show shipments where the shipping address postcode matches this term.

postalCodeMatch String

Only no picking list

Only include shipments without a picking list.

onlyNoPickingList Boolean

Only delivery note

Only include shipments with a delivery note.

onlyDeliveryNote Boolean

Only no delivery note

Only include shipments without a delivery note.

onlyNoDeliveryNote Boolean

Only no cost of sales list

Show only shipments not yet included on any cost of sales list.

onlyNoCostOfSalesList Boolean

Picking List

Show only one shipment whose pick list has this number.

pickingListNumber Long

Sales Channel

Expressions like the number of the sales channel after the shipment must match.

sellerNumberMatch String

Only not on-hold

Only show shipments that are not 'on-hold'.

onlyNotOnHold Boolean

Only non-canceled

Only show shipments that have not been canceled.

onlyNotCancelled Boolean

Only on hold

Only show shipments that are on hold.

onlyOnHold Boolean

Next date

Only show shipments where the delivery slip is created on this date.

dateDeliveryNoteCreated Date

Partially delivered

Only show shipments where it has been necessary to abandon to deliver one or more lines in full.

onlyPartlyDelivered Boolean

Delivery date

Only show shipments with this delivery date.

deliveryDate Date

Carriers no.

Show only shipments where the carrier's shipment number matches this expression.

carriersShipmentNumberMatch String

No consignment note

Show only shipments that have not yet been consigned to the carrier.

onlyNoConsignmentNote Boolean

Selected carriers

Only show shipments with selected carriers.

carrierNamesEnabled Boolean

Carriers

Only show shipments for selected carriers.

carrierNames List

Incoterms

Show only shipments with these incoterms.

incoterms Incoterms

Terms of delivery

Only show shipments where terms of delivery matches this expression.

termsOfDeliveryMatch String

Wave name

shipmentFilter.waveNameMatch.description

waveNameMatch String

Country code

Only show shipments with this country code.

countryCode CountryCode

Delivery note

Show only one shipment that the accompanying note with this number belongs to.

deliveryNoteNumber Long

Consignment note

The number of the consignment note that includes this shipment.

consignmentNoteNumber Long

Cost of sales list

The number of the cost of sales list that includes this shipment.

costOfSalesListNumber Long

Only prepackaged

Only show shipments that have been pre-packaged. That is, all items are packed. There is no need to print the delivery slip and the packages do not have to be closed.

onlyPackingFinished Boolean

Our reference

Only show shipments where our reference matches this term.

ourReferenceMatch String

Sellers reference

Only show shipments with a sellers reference matching this expression.

sellersReferenceMatch String

Delivery note from

Only show shipments where delivery note was made on or after this time.

deliveryNoteFromTime Date

Delivery note to

Only show shipments where delivery note was made before or at this time.

deliveryNoteToTime Date

Delivery date from

Only show shipments with a delivery date on or after this date.

deliveryDateFromDate Date

Delivery date til

Only show shipments with a delivery date on or before this date.

deliveryDateToDate Date

Consignment note from

Only show shipments where consignment note was made on or after this time.

consignmentNoteFromTime Date

Consignment to

Only show shipments where consignment note was made before or at this time.

consignmentNoteToTime Date

Del. note created

Only show shipment for which delivery note was created within the chosen time interval.

deliveryNoteWithinCommonTimeInterval CommonTimeInterval

Oprettet

Only show shipments created within this time interval.

createdWithinCommonTimeInterval CommonTimeInterval

Transport booking

Only show the shipment that the booking with this number relates to.

transportBookingNumber Long