PUT v1/Shipments/{shipmentId}/AddOrderRows

Add one or multiple orderrows to an existing 'open' shipment.

Request Information

Requires Authorization!

URI Parameters

NameDescriptionTypeAdditional information
shipmentId

integer

Required.

Body Parameters

AddOrderRowsToShipmentInfo
NameDescriptionTypeAdditional information
OrderRows

Optional collection of OrderRow identifiers

This collection should only contain orderrows that are allocated to the same warehouse that was set when the shipment was created.

Collection of integer

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.

Request Formats

application/json, text/json

Sample:
{
  "OrderRows": [
    1,
    2
  ],
  "GeneratePickList": true,
  "GeneratePackingSlip": true
}

application/xml, text/xml

Sample:
<AddOrderRowsToShipmentInfo xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <OrderRows>
    <OrderRowId>1</OrderRowId>
    <OrderRowId>2</OrderRowId>
  </OrderRows>
  <GeneratePickList>true</GeneratePickList>
  <GeneratePackingSlip>true</GeneratePackingSlip>
</AddOrderRowsToShipmentInfo>

Response Information

Response Codes

  • OK (200)
  • NotFound (404)
  • Conflict (409)

Resource Description


HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.