Skip to content

Check if a user may enter a specific pickup based on pickup rules

GET
/api/stores/{storeId}/pickups/{pickupDate}/eligibility

Authorizations

api_key

Requests manipulating data need to supply a CSRF token

TypeAPI Key (header: X-CSRF-Token)

Parameters

Path Parameters

storeId*
Typestring
Required
Pattern"[1-9][0-9]*"
pickupDate*
Typestring
Required
Pattern"[0-9]{4}-((0[13578]|1[02])-(0[1-9]|[12][0-9]|3[01])|(0[469]|11)-(0[1-9]|[12][0-9]|30)|(02)-(0[1-9]|[12][0-9]))T(0[0-9]|1[0-9]|2[0-3]):(0[0-9]|[1-5][0-9]):(0[0-9]|[1-5][0-9])\\.[0-9]{3,6}Z"

Responses

Success

application/json
JSON
{
"isEligible": true
}

Playground

Authorization
Variables
Key
Value

Samples

cURL
JavaScript
PHP
Python