Jump to Content

Guides API Reference Changelog

API Reference

Guides API Reference Changelog

All

Pages

Start typing to search…

Pickup Cloud API

Getting started by requesting API access
Validate your API Key
Turn your order into a pickup order
Turn your order into a recurrent order
Get pickup status
Testing with a virtual pharmacy
Cancel a pickup order
Manually dispense a pickup order

REAL TIME PUSH-MECHANISM (SIGNALR)

Intro to the real time push mechanism
.NET Sample Client (C#)
Java Sample Client
JavaScript Sample Client
C++ Sample Client

Validation

Validate API Key and test connection to the APIget

Create an order

Create a new pickup order with articlespost
Create a new recurrent orderpost
RecurrentOrders
- Retrieves all recurrent orders according to provided criteriaget

Retrieve an order

Retrieve an order by order numberget
Retrieve an order by pickup codeget

Cancel an order

Cancel a pickup order by order numberpatch
Cancel a pickup order by pickup codepatch

Manually dispense an order

Manually dispense a pickup order by order numberpatch
Manually dispense a pickup order by unique pickup codepatch

Create an order on behalf of a 3rd party service

Create a new pickup order, with articles, on behalf of a 3rd party servicepost

Additional Resources

E-Mails via API (and the Pickup Cloud)

Powered by

Get pickup status

➡️ Get back the status report of a Pickup Order with all order details