ProductName
Datakatalog

Shipment

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

Felter

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 area.

shipmentNumber String Unique Length 1 to 36

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

The number of the wave to which this shipment is to be processed.

wave Integer

Shipping prio.

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

shippingPriority Integer

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.SSSZ 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

Payment terms

Payment terms for the items delivered on this shipment.

termsOfPayment String

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

Consignmentid.

Transfer identification from the freight forwarder.

consignmentId String

Customer

Unique identification of the customer within this area.

customerNumber String Customer

Customer id

Unique identification of the customer related to this shipment.

customerId Long 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

Box

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

pickToBoxNumber Integer Read only

Send sms

Specifies whether to send a text message to the recipient before delivery.

sendSmsNotification Boolean

Send mail

Indicates whether the freight forwarder must send an e-mail to the recipient before delivery.

sendMailNotification Boolean

Freight Paid

The freight received by the consignee of the shipment.

freightCharged BigDecimal Max 999999.99

Discount given

The discount given on the total amount.

discountGiven BigDecimal Max 999999.99

VAT

Estimated VAT on this shipment.

vatAmount BigDecimal Max 999999.99

Amount Paid

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

paymentAmount BigDecimal Max 999999.99

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

Labels requested

The time at which the latest request for shipping labels was made.

timeShippingLabelsRequested Date

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.SSSZ 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.SSSZ Read only

Area id

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

Auto finalize

Automatically finalize the shipment, when the last item has been packed.

autoShipWhenPackingCompleted Boolean

Vatno.

The VAT number of the customer.

vatNumber String Read only

Request labels

Should the system request labels for this shipment when it is finished?

requestShippingLabels Boolean

Created event id

Unique identification of the shipment created event.

shipmentCreatedEventId String Read only

Label request id

Unique idenfication of the latest request for shipping labels for this shipment.

latestShippingLabelsRequestId 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

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.SSSZ Read only

Data document

JSON document containing additional information about this shipment.

dataDocument String JSON

shipment.requiresTrackAndTrace

shipment.requiresTrackAndTrace.description

requiresTrackAndTrace Boolean Read only

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 without a pick list

Only show shipments that have not yet been printed.

onlyNoPickingList Boolean

Only without delivery slip

Only show shipments that have not yet been printed.

onlyNoDeliveryNote 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

Can 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

Not consigned

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

onlyNoConsignmentNote Boolean

Carrier

Only show shipments for the carrier with this name.

carrierName 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

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

Del. note created

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

deliveryNoteWithinCommonTimeInterval CommonTimeInterval