Skip to content

Lookup delivery options for a location

GET
/api/public/delivery/lookup
curl --request GET \
--url 'https://api.usegro.co/api/public/delivery/lookup?country_code=example&shop=example'
country_code
required
string
state_code
string
postcode
string
shop
required
string

Shopify shop domain

timezone
string
days_ahead
number
min_date
string
max_date
string
ignore_cutoff
string

Offer dates past the production cutoff (admin override). Only allowed with the shop’s own API key in X-API-Key.

Delivery lookup result

Media typeapplication/json
object
available
required
boolean
message

Message when delivery is not available

string
requires_postcode

Whether postcode is required

boolean
configuration_id
string format: uuid
location_label
string
courier_lead_time_days
integer
dates
Array<object>
object
date
required
string
day_of_week
required
number
day_name
required
string
formatted_date
required
string
billing_date
required
string
production_date
required
string
slots
required
Array<object>
object
id
required
string
start_time
required
string
end_time
required
string
label
required
string
available
required
boolean
is_all_day
required
boolean

Example

{
"location_label": "Sydney Metro",
"courier_lead_time_days": 2
}

Ignore_cutoff sent without the shop API key

Media typeapplication/json

Example

{
"error": "ignore_cutoff needs this shop API key"
}