Skip to content

Get delivery options for an account

GET
/api/public/delivery/options
curl --request GET \
--url 'https://api.usegro.co/api/public/delivery/options?shop=example'
shop
required
string

Shopify shop domain

Delivery options for the account

Media typeapplication/json
object
data
required
object
delivery_enabled
required
boolean
available
required
boolean
countries
required
Array<object>
object
name
string
code
string
states
Array<object>
object
name
string
code
string
uses_postcodes
required
boolean
uses_states
required
boolean

Example generated

{
"data": {
"delivery_enabled": true,
"available": true,
"countries": [
{
"name": "example",
"code": "example",
"states": [
{
"name": "example",
"code": "example"
}
]
}
],
"uses_postcodes": true,
"uses_states": true
}
}

Bad request

Media typeapplication/json

Example

{
"error": "Shop parameter required"
}

Shop not found

Media typeapplication/json

Example

{
"error": "Shop not found"
}