POST api/externalpicking/batchcompleted?wmsbatchid={wmsbatchid}

External picking application has finished a picking batch (a group of items to pick, which might be called a job, a task, a picking list etc.). Returns 200 OK on success, non-2xx response on failure.

Request Information

URI Parameters

Name	Description	Type	Additional information
wmsbatchid	Identifier of the WMS picking task resource which was completed.	string	Required

Body Parameters

Object specifying information about the completed batch

BatchCompletedEventArgs

Name	Description	Type	Additional information
WMSBatchID	Identifier of the WMS batch	string	None.
PrinterDeviceID	DeviceID of the printer to which the job summary list or waybill or similar should be printed, or -1 to not print anything. Null, zero and negative values, except -1, are considered invalid.	integer	None.
BatchStartedTimestamp	Date and time when the picker started the batch, in format YYYY-MM-DDTHH:MM:SS for local time as receiver perceives it, or YYYY-MM-DDTHH:MM:SSZ for UTC. This argument is required.	string	None.
BatchEndedTimestamp	Date and time when the picker finished the batch, in format YYYY-MM-DDTHH:MM:SS for local time as receiver perceives it, or YYYY-MM-DDTHH:MM:SSZ for UTC. This argument can be null or empty, in which case the server uses current timestamp as end time.	string	None.

Request Formats

application/json, text/json

Sample:

{
  "WMSBatchID": "sample string 1",
  "PrinterDeviceID": 2,
  "BatchStartedTimestamp": "sample string 3",
  "BatchEndedTimestamp": "sample string 4"
}

application/xml, text/xml

Sample:

<BatchCompletedEventArgs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WMS.WebApiService.DTOs">
  <BatchEndedTimestamp>sample string 4</BatchEndedTimestamp>
  <BatchStartedTimestamp>sample string 3</BatchStartedTimestamp>
  <PrinterDeviceID>2</PrinterDeviceID>
  <WMSBatchID>sample string 1</WMSBatchID>
</BatchCompletedEventArgs>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'BatchCompletedEventArgs'.

Response Information

Resource Description

PostBatchCompletedJson

Name	Description	Type	Additional information
Status	Return status	string	None.
wmsbatchid	current batch id	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Status": "sample string 1",
  "wmsbatchid": "sample string 2"
}

application/xml, text/xml

Sample:

<PostBatchCompletedJson xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WMS.WebApiService.DTOs">
  <Status>sample string 1</Status>
  <wmsbatchid>sample string 2</wmsbatchid>
</PostBatchCompletedJson>