API Reference

➡️ Everything implemented? Then let‘s run a test!

What happened before:

✅ a customer was consulted and ordered some articles
✅ the customer paid for the order and left
✅ you turned an order into a pickup order
✅ you requested the pickup status of an order with Get pickup status


Simulation codes for testing

You can simulate the flow of an order e.g. an order will be stored in the robot and then picked up – without actually doing so.

There are three cases available to simulate

  • loading and picking up of an order
  • loading and cancelling of an order
  • failing an order (to test your error handling)

To simulate this, there are different codes you can pass into the relatedNotes parameter when creating an order.

Depending on the simulation code you use, a different scenario will be simulated for you to test.

🤓 Each of those codes has variables to adjust the timing of the simulation. So feel free to play around with the values. Learn more about this below.

⬇️ Different simulation codes

ExamplePickup
Simulation code$pickup-RRR-PPP
ExplanationThe API will simulate that the order has been loaded in the robot RRR seconds after creation and then picked up PPP seconds after creation.
DetailsRRR: three digits that will be interpreted as seconds e.g. 020 will be loaded in the robot after 20 seconds.

PPP: three digits that will be interpreted as seconds e.g. 100 will be simulated as picked up 100 seconds after creation.
Examples$pickup-015-030 -> input after 15 seconds and pickup after 30 seconds from creation

$pickup-020-005 -> input after 20 seconds but not picked up because the time for the pickup is before the input.

🤓 This will mark the order as overdue (set the "state" to "OVERDUE" in the order status response).
ExampleCancel
Simulation code$cancel-RRR-CCC
ExplanationThe api will simulate that order has been loaded in the robot RRR seconds after
creation and then cancelled CCC seconds after creation.
DetailsRRR: three digits that will be interpreted as seconds e.g. 020 will be loaded in the robot after 20 seconds.

CCC: three digits that will be interpreted as seconds e.g. 050 will be canceled after 50 seconds.
Examples$cancel-002-007 -> input 2 seconds and canceled 7 seconds after the creation.

$cancel-010-001 -> this will cancel the order even before something has been loaded into the robot (e.g. a patient called that they don't need their order anymore because they got it elsewhere).
ExampleFail
Simulation Code$fail
ExplanationThe api will throw an unexpected error.
This will allow you to test your error-handling code.



Create a test order to simulate a order flow

When you have decided what kind of simulation you want to test, you can create a new order.
During creation, enter the simulation code into the relatedNotes parameter.

1440

Add your simulation code to test different flows of an order.

Checking the order status

After you have created your order with one of the available simulation codes, you can check the progress of the order by asking for an order with order number or by asking for an order with pickup code.

To get the order status, use the respective 'GET' method depending on if you like to query with the order number or pickup code.

Independenten of which method you use to get the order status, you'll receive the same response with the complete order details as well as the order status.

Whats next?

Depending on the order status you receive, you can continue with different events such as

  • sending out a "Confirmation" or "Thank you" E-Mail if a patient picked up an order successfully
  • sending out a reminder E-Mail if an order hasn't been picked up for a few days
  • and much more!


Ready to start with a first customer?

Then message us(LINK) and we will get back to you as soon as possible so that we can finish the implementation together with a customer.