apomap partnerAPIAppearance
QUICK OVERVIEW
This section shows how quickly and easily you can use apomap API; for example, to transfer an order from the POS system to apomap via our API.
ORDER TRANSFER
In order to transfer an order (delivery or pickup) to apomap, the following structure must be used.
HTTP-Method: POST
URL: https://europe-west3-apomapdreinull.cloudfunctions.net/api/createTask
Content-Type: application/json
Codepage: UTF-8
| JSON-Parameter: Name | Data Type | Description | Required |
|---|---|---|---|
| api_key | String (255 characters max.) | Unique API key (viewable in the apomap backend) | Yes |
| task_description | Text (255 characters) | Free text field "Remark" from the input field | No |
| task_type | String (255 characters max.) | Delivery type options are "delivery" or "pickup" -> Default is delivery | |
| email_address | Email address | Customer email address for queries and customer app | No |
| contact_number (mobil_number) | String (255 characters max.) | Customer phone number for queries and possibly also SMS status information | No |
| customer_name | String (255 characters max.) | Customer's last name | Yes |
| customer_fname | String (255 characters max.) | Customer's first name | Yes |
| delivery_address | String (255 characters max.) Format: street, house number, zip code, city | Delivery address of the customer. Example: Musterstraße 12, 12345 Musterstadt | Yes |
| delivery_date | UNIX-Timestamp | Desired delivery time (delivery from this time) | Yes |
| delivery_date_from | UNIX-Timestamp | Time window Desired delivery from | No |
| delivery_date_to | UNIX-Timestamp | Time window delivery to | No |
| task_priority | integer | Priority of delivery - 1 very high | No |
| task_process_time | integer | Time spent on site (in minutes) | No |
| job_no | String (255 characters max.) | Order number from Wawi | No |
| payment_total | Float | Payable or Outstanding amount | Yes |
| refrigeration_mandatory | Boolean | Do the goods have to be refrigerated? | No |
| refrigeration_type | String (255 characters max.) | What temperature range (e.g. 3-8 degrees) | No |
| btm | Boolean | Anesthetic | No |
EXAMPLE
{
"api_key": "apomap.e852edfb96a00c2836f9ef37cb4902ca",
"customer_name": "Tester",
"customer_fname": "thorben",
"email_address": "info@mail.com",
"contact_number": "0800/837383",
"task_type": "pickup",
"delivery_date": "1631696139",
"delivery_date_to": "",
"delivery_date_from": "",
"task_priority": 10,
"task_process_time": 5,
"task_description": "hello",
"delivery_address": "Remmeswiese 30, 59955 Winterberg",
"payment_total": 2.23,
"job_no": 123512,
„refrigeration_mandatory": true,
"refrigeration_type": „2-8Deg“,
"btm": true
}