Skip to main content
inputShipPackageCommandRequestInput

Fields

packageId
ID!
required

The ID of the package to be shipped.

shippingDate
DateTime

The shipping date. When not set, the package is shipped as of now.

trackingNumber
String

The tracking number, at most 255 characters. When not set, the package is shipped without tracking.

overwrite
Boolean

Specifies whether a package's shipping information should be overwritten if the package has already been shipped. Defaults to false, in which case shipping an already shipped package is rejected. Overwriting repeats the shipping completion of the delivery note, so the corrected shipment is reported to the sales channel and the shipping confirmation mail is sent again. Shipping methods that export the shipment themselves are not completed here and are therefore unaffected, and no mail is sent for a shipping method that has the shipping mail switched off.

idempotencyKey
String

Client-supplied idempotency key. When provided, a repeated request with the same key and payload replays the original result instead of re-executing the mutation.