latestOpenAPI 3.1.02026-08-0854104180.4 KB

f39a4bfeca8e

Orders

Deal with an order close request

Handle an order close request.

  1. Set the order status to 'close_in_progress'.
  2. Set the 'close_request_at' timestamp in the order's metadata.
  3. Publish an SNS message that the order status has changed to 'close_in_progress'.

The current subscribers to this topic are the retrieval project close worker and the delivery order status updated worker.

post/orders/{order_id}/close-request

Path parameters

order_idstring required

Headers

version-datavantstring

Version of the Orders API to use with this call

Version of the Orders API to use with this call

Response

Successful Response