getInventoryFulfillmentDeliveries
The method allows you to retrieve a list of fulfillment deliveries with optional filtering. Results are paginated with 100 results per page.
Input parameters
Output data:
A sample request in PHP:
| fulfillment_warehouse_id | int | (optional) Filter by fulfillment warehouse identifier |
| warehouse_id | int | (optional) Filter by source warehouse identifier |
| status | int | (optional) Filter by delivery status |
| date_from | int | (optional) Date from filter (unix timestamp) |
| date_to | int | (optional) Date to filter (unix timestamp) |
| filter_document_number | varchar(30) | (optional) Filter by document number (partial match) |
| page | int | (optional) Results page (0-based, 100 results per page) |
Output data
The method returns the data in JSON format.
| status | varchar(30) | SUCCESS - request executed correctly ERROR - an error occurred during an API request. Error details will be described in 2 additional returned fields: error_message and error_code |
| deliveries | array | Array of fulfillment deliveries |
| | - delivery_id | int | Delivery identifier |
| | - name | varchar(80) | Delivery name |
| | - document_number | varchar(30) | Full document number |
| | - date_created | int | Creation date (unix timestamp) |
| | - items_count | int | Number of items |
| | - status | int | Delivery status (0-draft, 1-packing, 2-registered, 3-in_transit, 4-unpacking, 5-completed, 6-cancelled) |
Sample
Input data:Output data:
A sample request in PHP: