Skip to main content
GET
Get Shop

Get Shop

Returns the shop’s account record and settings. The shop object is returned as-is (it is not transformed into a Shopify-style shop resource), so the field names match the platform’s store account.

Request

Response

The response uses the standard envelope. The shop record is nested under data.shop.
status
integer
HTTP status code (e.g., 200)
state
string
Result state — success on success, error on failure
message
string
Human-readable message, or null on success
data
object
Response data wrapper
Sensitive fields (password, verification code, internal payment-customer IDs, POS PIN) are always excluded from this response.

Example Response

Error Response

Errors return the same envelope with state set to error and a message.
StatusDescription
401Invalid or missing access token
403App doesn’t have read_shop scope
404Shop not found