API Integration
Feed Setup Guide
To use the custom API, a json feed is required with all the fields below. This feed should only contain open picking orders that have not yet been completed. See the table below to see which fields must contain a minimum value and which may be empty.
Depending on your platform, you can refresh this feed every X amount of time so that the latest orders also arrive in Order Picking App.
| Parameter | Description | Required | Not Empty |
|---|---|---|---|
| id | Order ID | X | X |
| name | Order name/number | ||
| order_status | Status of the order | X | |
| order_date | Date: Y-m-d | X | X |
| last_name | Last name of the customer | X | |
| shipping_method | Name of the shipping method | X | |
| order_total | Total amount/price of the order | X | X |
| products.product_id | Product ID of main product | X | X |
| products.variation_id | Variation ID if exist | X | |
| products.image_url | Thumbnail image url https://domain.nl/image.png | X | |
| products.price | Product price (Notation: 9.95 ) | X | X |
| products.sku | Product SKU | X | X |
| products.barcode | Product Barcode | ||
| products.second_barcode | Product EAN or GTIN | ||
| products.name | Product/Variation name | X | X |
| products.description | Product short description | X | |
| products.quantity | Order product amount | X | X |
| products.stock_quantity | Current stock amount of this product | X | |
| products.categories | Comma separated category name(s) | X |
Roadmap:
1. Realization of JSON feed via the stated requirements
2. Registration on Order Picking App with choice of Custom/API
3. Enter the feed URL
4. Set desired settings
5. Start picking
Webhook Setup Guide
You can connect your own system to the Order Picking App by setting a webhook URL in your account. This allows you to automatically receive real-time updates when certain events occur.
Supported Events
- Order status updates (e.g., created, shipped, completed)
- Stock changes (e.g., inventory increased or decreased)
How to Set It Up
- Log in to your Order Picking App account.
- Go to App Settings.
- Enter your Webhook URL (e.g.,
https://domain.nl/webhooks/webhook-sample.php). - Click Save.
- Download our sample script and create your own logic!
Any questions, mail us at support@orderpickingapp.nl
