Get pickup status

What happened before

✅ You have turned an Order into a Pickup Order with the help of our Turn an Order into a Pickup Order article.

Send request to get an Order

The response of adding an Order is an object called OrderResponse.
This object contains the orderNumber and the pickupCode which both can be used to get the pickup status. Therefore we can reuse the SendRequest-Method from the "Adding an Order"-Step.

Parameters

⬇️ with orderNumber

This get request expects you to pass a string for the parameter orderNumber.
In our example down below we use the value my-order-number for the orderNumber string.
You should use the orderNumber you provided to the API during the creation of the order.
Find out how you turn your order into a Pickup Order

uri: https://api.pickup.bd.com/api/{api_version}/orders/by-ordernumber/orderNumber

ApiKey: You've received the API Key directly from us via E-Mail.
If not, contact us here!

httpMethod: GET

content: Null

➡️ Notice: Fill in the API Version for the Parameter {api_version}.
{api_version} should be replaced with the Version you want to use e.g. v1.1 so the url should be http://api.pickup.bd.com/api/v1.1/orders.

or

⬇️ with pickupCode

This get request expects you to pass a string for the parameter pickupCode.
In our example down below we use the value my-pickup-code for the pickupCode string.
You should use the pickupCode you provided to the API during the creation of the order.
Find out how you turn your order into a Pickup Order .

uri: https://api.pickup.bd.com/api/{api_version}/orders/by-pickupcode/pickupCode

ApiKey: You've received the API Key directly from us via E-Mail.
If not, contact us here!

httpMethod: GET

content: Null

Example success response in detail

{
  "orderNumber": "your-order-number",
  "requestCustomerToFillData": false,
  "relatedNotes": "Should be stored in the refrigerator",
  "dosageInformation": "1 tablet in the morning, one in the evening – at least 7hr gap. Take with a glass of water.",
  "state": "READYFORINPUT",
  "creationDate": "2021-10-18T13:42:11.585743+00:00",
  "lastUpdateDate": null,
  "pickedUpDate": null,
  "canceledDate": null,
  "firstInputDate": null,
  "isOverdue": false,
  "pickupCode": "customer_ED7BE3A4AF144537B1DC6582D49D9D98",
  "storageCode": "pickup_A116ABAD8AC84E0E81E31C17F4A34549",
  "cancellationReason": ""
}