Sets the order line collection status of all lines in a completed standard order to order line collection status Collected

Calling this endpoint confirms that all completed order print streams have been printed and will prevent any further calls to GetPrintStreams.

This endpoint will also start the preparation of any items in a completed standard order, so a further call to StartOrderPreparation is not necessary. The completed order print streams ItemCollectionVouchers will contain relevant collection details.

Licenses Required

  • Vista.Ocapi
Request
path Parameters
orderId
required
string

The unique identifier of the completed standard order being retrieved

header Parameters
Connect-Region-Code
string

Region Code

Request Body schema:

The additional request options

includeChildOrders
boolean

Gets a value indicating whether to include all linked completed standard order entities of type linked completed standard order relationship Child in the request

Responses
200

Success

400

Order has already been collected.

404

Order does not exist.

put/ocapi/v1/orders/completed/{orderId}/collection-status/collected
Request samples
{
  • "includeChildOrders": true
}
Response samples
application/json
{
  • "order": {
    },
  • "relatedData": {
    },
  • "linkedOrders": [
    ]
}