Support

Read stores and store attributes.

GET
/stores/{storeId}

Authorization

PAT commerce.store:read
AuthorizationBearer <token>

Personal Access Token (PAT). Include as Authorization: Bearer $GODADDY_PAT. Required scopes: commerce.store:read.

In: header

Scope: commerce.store:read

Path Parameters

storeId*string

Store ID

Formatuuid

Query Parameters

includeFields?array<>

Optional joins to fold into the response. Additive on top of the default field set, not a replacement filter — fields outside this enum are returned unconditionally. Comma-separate values to request multiple joins.

Note: the live (v1) gateway exposes this parameter as includeField (singular) and accepts repeated parameters. The v2 spelling here is the target shape for when v2 ships.

Header Parameters

X-Request-Id?string

Request ID

Formatuuid

Response Body

application/json

application/json

curl -X GET "https://example.com/stores/497f6eca-6276-4993-bfeb-53cbbbba6f08?includeFields=address%2Cattributes"
{  "id": "a4935421-1995-4b11-8cc3-99c6ad404007",  "businessId": "02a17e5b-0897-4d39-9123-b4345163e6df",  "displayName": "Global Ventures Apr 22133824",  "status": "ACTIVE",  "currency": "USD",  "timezone": "America/Los_Angeles",  "acquirer": "WORLDPAY",  "processor": "WORLDPAY",  "externalStoreId": "wp-retail-ce5ecce4",  "processorData": {},  "attributes": {},  "fixedLocation": true,  "mockProcessor": true,  "longitude": -122.162,  "latitude": 37.4457,  "defaultChannelId": "64bdf0cc-02d1-4326-b24e-9e611afc729f",  "defaultRetailChannelId": "c884df62-6c3b-4df0-81b7-80b8c4b73bcf",  "ownerId": "22264b76-d57b-4eb3-ab4e-1dbe5aeaeed1",  "createdAt": "2026-04-22T08:10:26Z",  "updatedAt": "2026-04-22T08:10:37Z"}
GET
/stores/{storeId}/attributes/{attrName}

Authorization

PAT commerce.store:read
AuthorizationBearer <token>

Personal Access Token (PAT). Include as Authorization: Bearer $GODADDY_PAT. Required scopes: commerce.store:read.

In: header

Scope: commerce.store:read

Path Parameters

storeId*string

Store ID

Formatuuid
attrName*string

Attribute name

Header Parameters

X-Request-Id?string

Request ID

Formatuuid

Response Body

application/json

application/json

curl -X GET "https://example.com/stores/497f6eca-6276-4993-bfeb-53cbbbba6f08/attributes/string"
{  "settlementRiskBlockOverride": "true"}

Last updated on

How is this guide?