API: Deliveries
Table of Contents
The ERP API Deliveries endpoint provides a list of outgoing deliveries and their associated delivery lines' information from the Enapps ERP system. By default, this method returns 100 records per page. Additionally, it should be used in conjunction with the Delivery Lines API.
| Base URL | |
| https://<server>:<port>/api/v1 |
| Endpoint | /stock_pickings |
| Method | GET |
Retrieve Deliveries
Request parameters | |||
| Name | Type |
Required |
Description |
| _id | integer |
No |
ID of a specific Stock Picking to obtain only 1 Delivery Note record. |
| partner_id | integer |
Yes |
ID of a partner obtained from Partners API response. |
| create_date | date_time |
No |
Filter records created from the specified date and later (%Y-%m-%d %H:%M:%S) |
| order_id | integer |
No |
ID of a specific Sale Order |
| additional_fields | array/list |
No |
Provide field names of additional fields not part of the standard Endpoint. For more information please refer to Additional Fields |
| page | integer |
No |
Optional pagination parameter. |
Response parameters | ||
| Name | Type |
Description |
| id | integer |
Delivery unique ID |
| name | string |
Picking Number |
| delivery_note_ref | string |
Delivery Tracking number of other notes |
| delivery_date | date |
Planned Dispatch Date or Dispatch date (%Y-%M-%D) |
| state | string |
Stock Picking/Delivery state |
| move_lines | array |
An array of IDs of Delivery Lines for each delivery (see “Retrieve Delivery Lines” endpoint below) |
Examples | |
| HTTP |
GET /api/v1/stock_pickings HTTP/1.1 WebKitFormBoundary7MA4YWxkTrZu0gW ------WebKitFormBoundary7MA4YWxkTrZu0gW |
Retrieve Delivery Lines
The ERP API Delivery Lines endpoint provides a list of delivery lines and their associated information from the Enapps ERP system for a specific delivery. By default, this method returns 100 records per page.
| Endpoint | /stock_moves | |
| Method | GET |
Request parameters | |||
| Name | Type |
Required |
Description |
| picking_id | integer |
Yes |
ID of a specific delivery. |
| page | integer |
No |
Optional pagination parameter. |
| additional_fields | array/list |
No |
Provide field names of additional fields not part of the standard Endpoint. For more information please refer to Additional Fields |
Response params | ||
| Name | Type |
Description |
| id | integer |
Delivery Line unique ID |
| name | string |
Product reference and full name |
| product_id | integer |
Product ID |
| original_qty | numeric |
Ordered product quantity |
| product_qty | numeric |
Delivered/Planned quantity |
Examples | |
| HTTP |
GET /api/v1/stock_moves/ HTTP/1.1 ------WebKitFormBoundary7MA4YWxkTrZu0gW |