Skip to content
Products
/
/Picklists/
PL11 - List picklists

PL11 - List picklists

Request

Call Frequency
Recommended usage: Every 15 minutes
Maximum usage: Every 5 minutes
Pagination

This resource supports seek pagination (see documentation)

Sort fields

sort field can have the following values:

  • pickupDate (Default) - Sort by pickup date (asc by default)

Security
Shop-API-Key(Required scopes: ROLE_SHOP_ADMINROLE_PARTNER_PICKLIST_READ)
Query
pickrun_codestring

Pick run code for filtering.

pickup_date_minstring, (date-time)

Filter picklists with a pick-up date after the given date.

pickup_date_maxstring, (date-time)

Filter picklists with a pick-up date before the given date.

picklist_idArray of strings

Picklist id for filtering. This parameter can be supplied multiple times (picklist_id=OR01-A&picklist_id=OR02-A...).

picklist_stateArray of strings

Picklist state for filtering. This parameter can be supplied multiple times (picklist_state=WAITING_PREPARATION&picklist_state=IN_PREPARATION...).

order_line_idArray of strings

Order line id for filtering. This parameter can be supplied multiple times (order_line_id=OR01-A-1&order_line_id=OR02-A-1...).

shop_idinteger, (int64)

Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.

curl -i -X GET \
  'https://your-instance.mirakl.net/api/picklists?pickrun_code=string&pickup_date_min=2019-08-24T14%3A15%3A22Z&pickup_date_max=2019-08-24T14%3A15%3A22Z&picklist_id=string&picklist_state=string&order_line_id=string&shop_id=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
dataArray of objectsrequired

Page of data

next_page_tokenstring

Token to access the next page. Absent if the current page is the last one.

previous_page_tokenstring

Token to access the previous page. Absent if the current page is the first one.

Response
{
  "data": [
    { … },
    { … }
  ],
  "next_page_token": "bGltaXQ9MSZhZnRlcj0yMDIyLTEyLTI0VDAwOjAwOjAwWiZhZnRlcj04Y2ViNWQxZi05MjQ4LTQyYjEtYTdkNS05NzYwNzAxOGQzNGEmc29ydD1waWNrdXBEYXRlLEFTQw==",
  "previous_page_token": null
}