Requests the preparation of all completed order item delivery base entities in a completed standard order with an completed order item delivery preparation status OnHold status

Calling this endpoint will update the preparation status of all completed order item delivery base entities with an completed order item delivery preparation status OnHold status to completed order item delivery preparation status Requested

Calling this endpoint will also set the order line CollectionStatus of all items in a completed order item delivery base with an order item delivery schedule type OnRequest schedule to order line collection status Collected

Licenses Required

  • Vista.Ocapi
Request
path Parameters
orderId
required
string

The unique identifier of the completed standard order

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 item delivery preparation cannot be started.

404

Order does not exist.

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