Requests the preparation of a completed order item delivery base with an completed order item delivery preparation status OnHold status

This endpoint can only be used for completed order item delivery base entities with an order item delivery schedule type OnRequest schedule.

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 the completed order item delivery base to order line collection status Collected

Licenses Required

  • Vista.Ocapi
Request
path Parameters
orderId
required
string

The unique identifier of the completed standard order

itemDeliveryId
required
string

The unique identifier of the completed order item delivery base that is to be prepared

header Parameters
Connect-Region-Code
string

Region Code

Responses
200

Success

400

Order item delivery preparation cannot be started.

404

Order or item delivery does not exist.

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