getOrderPickLists
Returns up to 100 paper pick lists belonging to the authenticated user. Results are sorted by pick_list_id. You can filter them by pick_list_id or id_from.
Input parameters
| pick_list_id | int | (optional) Exact paper pick-list identifier. Cannot be combined with id_from. |
| id_from | int | (optional) The pick list ID number from which subsequent pick lists are to be retrieved. Cannot be combined with pick_list_id. |
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 |
| picklists | array | Matching paper order pick lists, ordered by pick_list_id ascending. A maximum of 100 items is returned. |
| | - pick_list_id | int | Paper pick-list identifier. |
| | - barcode | varchar(15) | Barcode scanner value printed on the paper pick list. |
| | - date_added | int | Pick-list creation date as a Unix timestamp. |
| | - orders_count | int | Number of orders assigned to the pick list. |
| | - order_ids | array | Order identifiers assigned to the pick list, sorted ascending. |
| | - creator_profile_id | int | Identifier of the profile that created the pick list (-1 for API). |
| | - is_printed | bool | Whether the pick list has been printed successfully. |
Sample
Input data:Output data:
A sample request in PHP: