Shipments

Queryable, Introduced in version 23.1

GET https://localhost:8001/sv/001.1/api/v1/Sales/Shipments

Represents a shipment.

GUID

4E8AEFBC-74B0-427C-A043-5AA7D91ED387

Required permission

Show shipment

Properties

Name Type Summary Introduced in
Id Int64 The business key identifier of the shipment.
ShipmentNumber String The human readable identifier of the shipment.

  • Max length is 20
  • Not nullable
  • Unique
ConsignmentNo String The real consignment/shipment number from the shipper.

  • Max length is 35
UnifaunOnlineFirstParcelNo String The unifaun online first parcel number of the shipment.

  • Max length is 35
UnifaunOnlineFirstPrintLink String The unifaun online first print link of the shipment.

  • Max length is 4000
LogTradeTrackingNo String The log trade tracking number of the shipment.

  • Max length is 400
DeliveryMethodId Int64? The business key identifier of the shipments delivery method.
DeliveryTermId Int64? The business key identifier of the shipments delivery term.
DeliveryTermStandardCode String The delivery term standard code of the shipment.

  • Max length is 10
DeliveryTermLocation String The delivery term location of the shipment.

  • Max length is 80
ShippingAgentType Int32 The shipping agent type of the shipment.

  • Other: 0
  • DHL: 1
  • Schenker: 2
  • PostNord: 3
  • DSV: 4
ShipmentPayer Int32 The shipment payer of the shipment.

  • BuyerPays: 1
  • SellerPays: 2
  • OtherPayer: 3
  • Incoterms: 4
ShipmentPayerReference String The shipment payer reference of the shipment.

  • Max length is 80
TransportDate DateTimeOffset The transport date of the shipment.
StoredShipment Boolean Indicates if the shipment is stored.
PickupDate DateTimeOffset? The pickup date of the shipment.
PickupTimeFrom DateTimeOffset? The pickup time from of the shipment.
PickupTimeTo DateTimeOffset? The pickup time to of the shipment.
ExportDate DateTimeOffset? The export date of the shipment.
DeliveryDate DateTimeOffset? The delivery date of the shipment.
DeliveryTime DateTimeOffset? The delivery time of the shipment.
PickupText1 String The first pickup text of the shipment.

  • Max length is 50
PickupMisc String The pickup misc. text of the shipment.

  • Max length is 50
SchenkerOpalNumber String The Schenker opal number of the shipment.

  • Max length is 50
IsConsolidated Boolean Indicates if the shipment is consolidated.
ConsolidateKey String The consolidate key of the shipment.

  • Max length is 80
TotalEurPallets Int32 The total number of euro pallets on the shipment.
CurrentInformationSourceType Int32 The current shipment information source type of the shipment.

  • CustomerOrder: 0
  • Supplier: 1
  • PickingList: 2
  • Customer: 3
  • PickingListWithPackageStructure: 4
  • Subcontract: 5
  • ReturnOrder: 6
Status Int32 The status of the shipment.

  • Registered: 1
  • ShipmentFailed: 2
  • ShipmentInformationNotSufficient: 3
  • Sent: 4
  • Booked: 5
  • Shipped: 6
ShippingAgentId Int64 The business key identifier of the shipping agent of the shipment.
RecipientAdressId Int64? The business key identifier of the recipient adress of the shipment.
RecipientAdress Addresses The recipient adress of the shipment.

  • Expandable
RecipientInvoiceAddressId Int64? The business key identifier of the recipient invoice adress of the shipment.
RecipientInvoiceAddress Addresses The recipient invoice adress of the shipment.

  • Expandable
FreightPayerAddressId Int64? The business key identifier of the freight payer adress of the shipment.
FreightPayerAddress Addresses The freight payer adress of the shipment.

  • Expandable
ConsignmentId String The consignment id of the shipment.

  • Max length is 25
ConsignmentIdForReturn String The consignment id for return of the shipment.

  • Max length is 25
OurReferenceName String Our reference name of the shipment.

  • Max length is 80
OurReferencePhoneNumber String Our reference phone number of the shipment.

  • Max length is 80
OurReferenceMobilePhoneNumber String Our reference mobile phone number of the shipment.

  • Max length is 80
OurReferenceMail String Our reference mail of the shipment.

  • Max length is 80
OurPickUpAddressId Int64? The business key identifier of our pick up address of the shipment.
OurPickUpAddress Addresses Our pick up adress of the shipment.

  • Expandable
OurInvoiceAdressId Int64? The business key identifier of our invoce address of the shipment.
OurInvoiceAddress Addresses Our invoice adress of the shipment.

  • Expandable
PalletRegistrationNo String The pallet registration number of the shipment.

  • Max length is 35
OurPalletRegistrationNo String Our pallet registration number of the shipment.

  • Max length is 35
BusinessContactReferenceName String The business contact reference name of the shipment.

  • Max length is 80
BusinessContactReferencePhoneNumber String The business contact reference phone number of the shipment.

  • Max length is 80
BusinessContactReferenceMobilePhoneNumber String The business contact reference mobile phone number of the shipment.

  • Max length is 80
BusinessContactReferenceMail String The business contact reference mail of the shipment.

  • Max length is 80
ShippingTemplate String The shipping template code of the shipment.

  • Max length is 35
ShippingTemplateId Int64? The business key identifier of the shipping template of the shipment.
ShippingServiceId Int64? The business key identifier of shipping service of the shipment.
ShippingService ShippingServices The shipping service of the shipment.

  • Expandable
ShippingServiceCode String The shipping service code of the shipment.

  • Max length is 35
SenderQuickId String The sender quick id of the shipment.

  • Max length is 30
SellerQuickId String The seller quick id of the shipment.

  • Max length is 30
ConsignorId String The consignor id of the shipment.

  • Max length is 30
PickupId String The pickup id of the shipment.

  • Max length is 30
LogTradePrintQueue String The log trade print queue of the shipment.

  • Max length is 25
ShippingAgentCode String The shipping agent code of the shipment.

  • Max length is 15
SenderReference String The sender reference of the shipment.

  • Max length is 35
RecipientReference String The recipient reference of the shipment.

  • Max length is 35
DeliveryInstruction String The delivery instruction of the shipment.

  • Max length is 80
BookTransport Boolean Indicates if the shipment has booked transport.
ReturnLabel Boolean Indicates if the shipment has return label.
ShipmentPrintSetting Int32 The print setting of the shipment.

  • WaybillAndParcel: 0
  • Waybill: 1
  • Parcel: 2
ActiveDeliveryAddressCustomerId Int64? The business key identifier of the active delivery address customer of the shipment.
ActiveDeliveryAddressSupplierId Int64? The business key identifier of the active delivery address supplier of the shipment.
ActiveDeliveryAddressCompanyId Int64? The business key identifier of the active delivery address company of the shipment.

  • References Company
ActiveDeliveryAddressDeliveryAddressId Int64? The business key identifier of the active delivery address delivery address of the shipment.
ActiveDeliveryAddressDeliveryAddress DeliveryAddresses The active delivery address delivery address of the shipment.

  • Expandable
ActiveFallbackDeliveryAddressDeliveryAddressId Int64? The business key identifier of the active fallback delivery address delivery address of the shipment.
ActiveFallbackDeliveryAddressDeliveryAddress DeliveryAddresses The active fallback delivery address delivery address of the shipment.

  • Expandable
SourceOfAlternativeDeliveryAddresses Int32 The source of alternative delivery addresses of the shipment.

  • CurrentCustomer: 0
  • Customer: 1
  • Supplier: 2
  • Company: 3
  • CurrentSupplier: 4
WarehouseShippingAgentCode String The warehouse shipping agent code of the shipment.

  • Max length is 20
CustomerGoodsAddressNumber String The customer goods address number of the shipment.

  • Max length is 80
CustomerShippingAgentCode String The customer shipping agent code of the shipment.

  • Max length is 20
WarehouseId Int64 The business key identifier of the shipments warehouse.
ShippingAgentAccountName String The shipping agent account name of the shipment.

  • Max length is 35
CalculatedFreightPrice Decimal? The calculated freight price of the shipment.
CalculatedFreightPriceCurrencyId Int64? The business key identifier of the calculated freight price currency of the shipment.
CalculatedFreightPriceCurrency Currencies The calculated freight price currency of the shipment.

  • Expandable
MobilePhoneNotificationNumber String The mobile phone notification number for phone advice of the shipment.

  • Max length is 35
GoodsTrackingUrl String The goods tracking URL of the shipment.

  • Max length is 4000
 Introduced in version 24.7

Example

{
  "Id": 0,
  "ShipmentNumber": null,
  "ConsignmentNo": null,
  "UnifaunOnlineFirstParcelNo": null,
  "UnifaunOnlineFirstPrintLink": null,
  "LogTradeTrackingNo": null,
  "DeliveryMethodId": null,
  "DeliveryTermId": null,
  "DeliveryTermStandardCode": null,
  "DeliveryTermLocation": null,
  "ShippingAgentType": 0,
  "ShipmentPayer": 0,
  "ShipmentPayerReference": null,
  "TransportDate": "0001-01-01T00:00:00+00:00",
  "StoredShipment": false,
  "PickupDate": null,
  "PickupTimeFrom": null,
  "PickupTimeTo": null,
  "ExportDate": null,
  "DeliveryDate": null,
  "DeliveryTime": null,
  "PickupText1": null,
  "PickupMisc": null,
  "SchenkerOpalNumber": null,
  "IsConsolidated": false,
  "ConsolidateKey": null,
  "TotalEurPallets": 0,
  "CurrentInformationSourceType": 0,
  "Status": 0,
  "ShippingAgentId": 0,
  "RecipientAdressId": null,
  "RecipientAdress": null,
  "RecipientInvoiceAddressId": null,
  "RecipientInvoiceAddress": null,
  "FreightPayerAddressId": null,
  "FreightPayerAddress": null,
  "ConsignmentId": null,
  "ConsignmentIdForReturn": null,
  "OurReferenceName": null,
  "OurReferencePhoneNumber": null,
  "OurReferenceMobilePhoneNumber": null,
  "OurReferenceMail": null,
  "OurPickUpAddressId": null,
  "OurPickUpAddress": null,
  "OurInvoiceAdressId": null,
  "OurInvoiceAddress": null,
  "PalletRegistrationNo": null,
  "OurPalletRegistrationNo": null,
  "BusinessContactReferenceName": null,
  "BusinessContactReferencePhoneNumber": null,
  "BusinessContactReferenceMobilePhoneNumber": null,
  "BusinessContactReferenceMail": null,
  "ShippingTemplate": null,
  "ShippingTemplateId": null,
  "ShippingServiceId": null,
  "ShippingService": null,
  "ShippingServiceCode": null,
  "SenderQuickId": null,
  "SellerQuickId": null,
  "ConsignorId": null,
  "PickupId": null,
  "LogTradePrintQueue": null,
  "ShippingAgentCode": null,
  "SenderReference": null,
  "RecipientReference": null,
  "DeliveryInstruction": null,
  "BookTransport": false,
  "ReturnLabel": false,
  "ShipmentPrintSetting": 0,
  "ActiveDeliveryAddressCustomerId": null,
  "ActiveDeliveryAddressSupplierId": null,
  "ActiveDeliveryAddressCompanyId": null,
  "ActiveDeliveryAddressDeliveryAddressId": null,
  "ActiveDeliveryAddressDeliveryAddress": null,
  "ActiveFallbackDeliveryAddressDeliveryAddressId": null,
  "ActiveFallbackDeliveryAddressDeliveryAddress": null,
  "SourceOfAlternativeDeliveryAddresses": 0,
  "WarehouseShippingAgentCode": null,
  "CustomerGoodsAddressNumber": null,
  "CustomerShippingAgentCode": null,
  "WarehouseId": 0,
  "ShippingAgentAccountName": null,
  "CalculatedFreightPrice": null,
  "CalculatedFreightPriceCurrencyId": null,
  "CalculatedFreightPriceCurrency": null,
  "MobilePhoneNotificationNumber": null,
  "GoodsTrackingUrl": null
}