Options
All
  • Public
  • Public/Protected
  • All
Menu

Module CreateShipment

Create a new shipment

It is required to specify an Order. This can be done with OrderID or by sending OrderBackendID and OrderBackendSystemID.

To create a pending Shipment, set IsPending to true. A pending shipment has to be shipped with the ShipShipment service.

Index

Properties

Optional BackendID

BackendID: undefined | string

Optional BackendSystemID

BackendSystemID: undefined | string

Optional CustomFields

CustomFields: CustomFieldKeyValue[]

Optional additional custom fields

Optional ExpectedDeliveryDate

ExpectedDeliveryDate: undefined | string

Optional IsPending

IsPending: undefined | false | true

Optional Lines

Lines: ShipmentLine[]

Optional OrderBackendID

OrderBackendID: undefined | string

Reference to the order that is being shipped - required when OrderID is omitted

Optional OrderBackendSystemID

OrderBackendSystemID: undefined | string

Reference to the system from which the order originated - required when OrderID is omitted

Optional OrderFulfillmentID

OrderFulfillmentID: undefined | number

Entity type: OrderFulfillment

Optional OrderID

OrderID: undefined | number

ID of the order that is being shipped - required when OrderBackendID and OrderBackendSystemID are omitted Entity type: Order

Optional PackageID

PackageID: undefined | number

Optional. When only lines are provided, the PackageID can be used to create a package for all lines. Entity type: Package

Optional Packages

Packages: ShipmentPackage[]

Optional ReceiveMethod

ReceiveMethod: ShipmentReceiveMethods

Optional ShipmentDate

ShipmentDate: undefined | string

Optional ShippedFromOrganizationUnitID

ShippedFromOrganizationUnitID: undefined | number

Optional, will be determined based on the Order Entity type: OrganizationUnit

Optional TrackingCode

TrackingCode: undefined | string

Optional TrackingLink

TrackingLink: undefined | string