| Name | Description | Type | Additional information |
|---|---|---|---|
| OrderId |
Order identifier for which you want to add a shipment |
integer |
None. |
| WarehouseId |
Optional Warehouse for which the shipment is created.<br /><br />Allocated OrderRows for this shipment must have assigned this warehouse.<br /><br /> If not specified, the warehouse is determined based on the first OrderRow assigned to this shipment. |
integer |
None. |
| OrderRows |
Optional collection of OrderRow identifiers<br /><br />All orderrows must have been assigned the same warehouse.<br /><br /> If not specified, all shippable orderrows with allocation for the specified warehouse are added. |
Collection of integer |
None. |
| ShippingCode |
Optional Shipping code for shipment.<br /><br /> 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.<br /><br />If you set this to false, you can still generate the PickList by calling the GeneratePickList API method.<br /><br />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.<br /><br />If you set this to false, you can still generate the PackingSlip by calling the GeneratePackingSlip API method.<br /><br />If not specified (null), Generate packingslip setting from shop settings are used. |
boolean |
None. |
| PackingSlipTemplateId |
Optional provide a specific PackingSlip document template Id. When not specified, the default configured template will be used. |
integer |
None. |
| CarrierAccountId |
Optional id of CarrierAccount that should be used for the shipment.<br /><br />If not specified and CarrierAccountId is set for Order, CarrierAccountId from Order is used, otherwise CarrierAccountId remains blank.<br /><br />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. |