shop

query

An access token is required to call this API. Refer to Authorization for more information about how to obtain the token.

Query store information associated with storefront access token.

Return

name ● String!non-null

Store name.

id ● ID!non-null

Store's unique ID.

brand ● StoreBrand

Store's brand information.

metafield ● Metafield

The metafield associated with the store.

metafields ● [Metafield]

List of metafields associated with the store.

Status and error codes

For detailed information about common codes, see Status and error codes.

Example

Query store information.

Code

query Shop {
    shop {
       name
       id
       brand {
        coverImage {
            image {
                url
            }
            mediaContentType
        }
        logo {
            image {
                url
            }
            mediaContentType
        }
        shortDescription
        squareLogo {
            image {
                url
            }
            mediaContentType
        }
        slogan
       }
    }
}

Response

{
	"data": {
		"shop": {
			"id": "1672369729606",
			"name": "OpenAPI test store",
			"brand": {
				"logo": null,
				"shortDescription": null,
				"slogan": null,
				"squareLogo": null,
				"coverImage": null
			}
		}
	}
}

Was this article helpful to you?

SHOPLINE

Legal