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

This method should be called when the user of the external picking application has starting to batch. So this method should always be called exactly once per batch. 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 started batch

BatchStartedEventArgs

Name	Description	Type	Additional information
pickerCode	Identifier of the picker which performed the task	string	None.
WMSBatchID	Identifier of the WMS batch	string	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.

Request Formats

application/json, text/json

Sample:

{
  "pickerCode": "sample string 1",
  "WMSBatchID": "sample string 2",
  "BatchStartedTimestamp": "sample string 3"
}

application/xml, text/xml

Sample:

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

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 'BatchStartedEventArgs'.

Response Information

Resource Description

PostLineStartedJson

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:

<PostLineStartedJson 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>
</PostLineStartedJson>