Cancel a pickup order by pickup code

patch

https://api.pickup.bd.com/api/v2/orders/cancellation/by-pickupcode/{pickupCode}

This method allows you to cancel an existing order and dispense the items which were loaded for it inside the robot,
if you supply the order pickup code.
If the pickup order has articles which should be directly available for dispensation without personal intervention
they are now available again as an input into the WWKS storage system.
NOTE: Please be aware that the loaded items are not dispensed if there are no real local devices setup. The cancellation and, if applicable, the customer email information is anyway successful. For developing purpose please assume later on the items to be dispensed successful.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

ℹ️
Cancel – short facts:
• Cancel = all related and already input articles get unreserved (by the Robot).
• Cancel = the order won't be deleted, instead it stays stored in the system.
• Cancel = the unique orderNumber will stay with this order and can be accessed any time.
• Cancel = the customer can be notified by E-Mail via the API. Therefore, the correct cancel reason must be selected by you.

Path Params

pickupCode

string

required

The unique pickup code which was generated when creating the order.

Body Params

Additional information required for cancelling the order:
where to dispense the articles, the reason for cancellation and if the api should notify the customer by email about the cancellation.

details about the order cancellation request

outputLocation

int32

the id of the location where the pharmacy robot will output the package.
if you send 1 instead of a number, the robot will output the package on the default location.

cancellationReason

string

enum

required

Allowed:

detailedCancellationReason

string | null

if cancellation reason is 'other', the detailed reason for cancelling the order.

sendCancellationEmail

boolean

if true, the api will also email the customer

Responses

409

The order is in a state which doesn't allow cancelling (has been picked up or is already cancelled)

Cancel – short facts:

200Successfully updated pickup order. Returns full details about the updated order. The order state changes to CANCELED right after the call.

400The request was incorrect, see the details field for information about what was wrong.

401You did not provide the x-api-key header.

403The x-api-key header you provided is invalid or doesn't have access to this API method.

404No order was found having the specified order number.

500An internal error has occured in the API (please retry your request at a later time).