PUT v1/Shipments/{shipmentId}/RemoveOrderRows

Remove one or multiple OrderRows from an 'open' shipment.

Request Information

Requires Authorization!

URI Parameters

NameDescriptionTypeAdditional information
shipmentId

Identifier of shipment

integer

Required.

Body Parameters

RemoveOrderRowsFromShipmentInfo
NameDescriptionTypeAdditional information
OrderRows

Collection of OrderRow identifiers to indicate which OrderRows from the shipment need to be removed.

Collection of integer

Required

GeneratePickList

Optional toggle to indicate whether the picklist should be (re-)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 (re-)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:
<RemoveOrderRowsFromShipmentInfo 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>
</RemoveOrderRowsFromShipmentInfo>

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.