Skip to main content

Get Storefront Block

Retrieve a single draft widget from a storefront (Creator page).

The response is the block object only — not wrapped in items, and with no preview_url. The shape matches an item on Get Storefront Blocks and Get Storefront with include=blocks. Hidden widgets are still returned.

Request​

GET /storefronts/{storefrontId}/blocks/{id}

Path Parameters​

ParameterTypeRequiredDescription
storefrontIdstringYesStorefront UUID
idstringYesBlock UUID

Example Request​

curl -X GET "https://cart.easy.tools/api/v1/storefronts/b10f5980-d653-4494-ad1c-6a9d68c96d19/blocks/566cf11d-e6e2-4485-a828-e1b3d7da10a5" \
-H "Authorization: Bearer YOUR_API_TOKEN"

Response​

Success Response (200)​

Returns a single widget.

{
"id": "566cf11d-e6e2-4485-a828-e1b3d7da10a5",
"type": "product",
"layout": "6x3",
"order": 1,
"is_hidden": false,
"is_hidden_on_mobile": false,
"config": {
"use_block_padding": true,
"use_block_surface": true,
"is_block_highlighted": true,
"product_id": "3288e647-aab0-4289-957f-dac92e9b3ffe",
"ownership_status": "hide_owned",
"cta_label": { "value": "Get the newest", "is_hidden": false },
"owned_cta_label": "Open"
}
}

Product references in config are product UUIDs. A product that no longer exists is returned as null.

Response Fields​

The object is documented on the Block object.

Error Responses​

Bad Request (400)​

Returned when {storefrontId} or {id} is not a UUID. Both path values are checked before existence. A malformed storefront UUID returns Invalid storefront ID; a malformed block UUID returns Invalid block ID.

{
"message": "Invalid storefront ID"
}
{
"message": "Invalid block ID"
}

Not Found Error (404)​

Returned when the storefront UUID does not exist, belongs to another store, or points at a deleted storefront (Storefront not found), or when the block UUID does not exist on this storefront (Block not found). A widget that belongs to a different storefront of the same store is Block not found.

{
"message": "Storefront not found"
}
{
"message": "Block not found"
}

Unauthorized (401)​

{
"message": "Unauthenticated."
}

Forbidden (403)​

Returned when your API key has not been granted access to the requested store.

{
"message": "You do not have API access to the requested store."
}

Too Many Requests (429)​

Returned when you exceed the rate limit. The Retry-After response header gives the number of seconds to wait.

{
"message": "Too many requests. Please retry after 60 seconds."
}