AddShipmentInfo

The class to describe the AddShipmentInfo business object.

NameDescriptionTypeAdditional information
OrderId

Order identifier for which you want to add a shipment

integer

None.

WarehouseId

Optional Warehouse for which the shipment is created.

Allocated OrderRows for this shipment must have assigned this warehouse.

If not specified, the warehouse is determined based on the first OrderRow assigned to this shipment.

integer

None.

OrderRows

Optional collection of OrderRow identifiers

All orderrows must have been assigned the same warehouse.

If not specified, all shippable orderrows with allocation for the specified warehouse are added.

Collection of integer

None.

ShippingCode

Optional Shipping code for shipment.

If not provided, ShopCtrl will generate the shippingcode.

string

None.

PreferredShipDate

Optional preferred ship date.

date

None.

GeneratePickList

Optional toggle to indicate whether the picklist should be generated on creation of the shipment.

If you set this to false, you can still generate the PickList by calling the GeneratePickList API method.

If not specified (null), Generate PickList setting from Warehouse is used.

boolean

None.

GeneratePackingSlip

Optional toggle to indicate whether the packingslip should be generated on creation of the shipment.

If you set this to false, you can still generate the PackingSlip by calling the GeneratePackingSlip API method.

If not specified (null), Generate packingslip setting from shop settings are used.

boolean

None.

PackingSlipTemplateId

integer

None.

CarrierAccountId

Optional id of CarrierAccount that should be used for the shipment.

If not specified and CarrierAccountId is set for Order, CarrierAccountId from Order is used, otherwise CarrierAccountId remains blank.

CarrierAccountId can also implicitly set when you add the first parcel.

integer

None.

CashOnDeliveryPayment

optional amount to be paid to the postman when the shipment is delivered.

decimal number

None.

Parameters

Optional collection of key-value pairs.

Collection of OrderShipmentParam

None.