shop

query

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

Query a store's information, including the store ID, store name, currency, and other details.

Return

contactEmail ● String!non-null

The merchant's email address for customer communication.

name ● String!non-null

Store name.

handle ● String!non-null

The store's unique identifier, which is the prefix of the store's domain name. For example, if a store's domain name is open001.myshopline.com, the store handle is open001.

id ● ID!non-null

Store's unique ID.

currencyCode ● CurrencyCode!non-null

The settlement currency used by the buyer when placing orders in the store. The value of this parameter is a three-letter currency code that follows the ISO 4217 standard. For example, USD.

ianaTimezone ● String!non-null

The time zone set for the store.

allProductCategories ● [ProductCategory!]non-null

List of the store's standard product types.
Maximum size: 1000.

features ● ShopFeatures!non-null

Availability of store features. For example, if giftCards returns true, it indicates that creating gift cards is allowed in the store.

resourceLimits ● ShopResourceLimits!non-null

Store resource limits.

uploadedImagesByIds ● [Image!]non-null

List of images uploaded to the store.

productTypes ● StringConnection!non-null

List of custom product types added to store products.

productTags ● StringConnection!non-null

List of product tags assigned to store products.

productVendors ● StringConnection!non-null

List of suppliers associated with store products.

Status and error codes

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

Example

Query store name, ID, email, currency, handle, time zone, and available features.

Code

query Shop {
    shop {
       contactEmail
       name
       handle
       id
       currencyCode
       ianaTimezone
       allProductCategories {
        productTaxonomyNode {
            isRoot
            name
            fullName
            id
            isLeaf
        }
       }
       features {
        giftCards
        shopId
       }
       resourceLimits {
        maxProductOptions
        maxProductVariants
        shopId
       }
    }
}

Response

{
	"data": {
		"shop": {
			"allProductCategories": [
				{
					"productTaxonomyNode": {
						"isLeaf": true,
						"isRoot": false,
						"name": "Gift Cards & Certificates",
						"fullName": "Gift Giving < Party & Celebration < Arts & Entertainment < Gift Cards & Certificates",
						"id": "gid://shopline/ProductTaxonomyNode/53"
					}
				}
			],
			"contactEmail": "ssc56474@gmail.com",
			"ianaTimezone": "Asia/Shanghai",
			"resourceLimits": {
				"maxProductOptions": 5,
				"maxProductVariants": 500,
				"shopId": "1672369729606"
			},
			"currencyCode": "USD",
			"name": "OpenAPI 测试店铺",
			"features": {
				"shopId": "1672369729606",
				"giftCards": true
			},
			"handle": "openapiceshidianpu",
			"id": "1672369729606"
		}
	},
	"extensions": {
		"cost": {
			"actualQueryCost": 6,
			"requestedQueryCost": 6,
			"throttleStatus": {
				"restoreRate": 5000,
				"currentlyAvailable": 4994,
				"maximumAvailable": 5000
			}
		}
	}
}

Was this article helpful to you?

SHOPLINE

Legal