StoreInfo Resource

Use the StoreInfo resource to access store-related information such as policies, payment methods, and other store attributes.

Resources:

Schema type

Use store-info to reference this resource in the template schema.

Querying

You do not need to query for store information. Including store-info in a template’s schema will give that template access to store information.

Sample Store Info

{
  "__SO_RESOURCE_TYPE__": "store_info",
  "item_reviews_enabled": false,
  "item_low_stock_threshold": 5,
  "accepting_orders": true,
  "allowed_to_sell": true,
  "fulfillment_support": {
    "DELIVERY": true,
    "PICKUP": true,
    "SHIPMENT": false,
    "DINE_IN": false,
    "MANUAL": false,
    "DIGITAL": false
  },
  "has_multi_location": true,
  "has_shippable_item": false,
  "has_time_based_categories": false,
  "language": "en",
  "locale": "en_US",
  "currency": "USD",
  "locations_counts": {
    "PICKUP": 1,
    "DELIVERY": 1,
    "DINE_IN": 0,
    "PICKUP_OR_DELIVERY": 1,
    "BRICK_AND_MORTAR_FULFILLMENT": 1,
    "SHIPMENT": 1,
    "TOTAL": 1
  },
  "return_policy": null,
  "seller_preferred_fulfillment": "DELIVERY",
  "shipping_policy": null,
  "show_low_stock_section": true,
  "show_on_sale_section": true,
  "show_out_of_stock_section": true,
  "show_pdp_buy_now_button": true,
  "shipping_location_id": "11eeed331bd924d18c6b089e019fd17a",
  "buyer_customer_accounts_enabled": false,
  "payment_methods": {
    "afterpay": {
      "enabled": false,
      "restrictions": {
        "item_price_min": {
          "amount": 10,
          "currency": "USD",
          "formatted": "$0.10"
        },
        "item_price_max": {
          "amount": 2000,
          "currency": "USD",
          "formatted": "$20.00"
        },
        "checkout_order_price_min": {
          "amount": 10,
          "currency": "USD",
          "formatted": "$0.10"
        },
        "checkout_order_price_max": {
          "amount": 2000,
          "currency": "USD",
          "formatted": "$20.00"
        }
      },
      "limits": {
        "min": 50,
        "max": 2000
      }
    },
    "apple_pay": {
      "enabled": true
    },
    "google_pay": {
      "enabled": true
    }
  },
  "application_id": "sq0ids-EN9qqqVN4ESrjjr-fgulBw"
}

StoreInfo Resources

StoreInfo

Store information.

Field Type Description  
item_reviews_enabled Boolean Whether product reviews are enabled for store items  
item_low_stock_threshold Integer The threshold at which items are marked as low in stock  
accepting_orders Boolean Whether the store is accepting orders  
allowed_to_sell Boolean Whether the store is allowed to sell products  
fulfillment_support FulfillmentSupport Supported fulfillment methods (e.g., PICKUP, DELIVERY)  
has_multi_location Boolean Whether the store has multiple locations  
has_shippable_item Boolean Whether the store has shippable items  
has_time_based_categories Boolean Whether the store has time-based product categories  
language String The primary language of the store  
locale String The locale of the store, such as en_US  
currency String The currency code used in the store, in ISO 4217 format (e.g., USD)  
locations_counts LocationsCounts Details about the number of locations that support each fulfillment method  
return_policy String The store’s shipping policy  
show_low_stock_section Boolean Indicates if the store shows a low stock section  
show_on_sale_section Boolean Indicates if the store shows an on-sale section  
show_out_of_stock_section Boolean Indicates if the store shows an out-of-stock section  
show_pdp_buy_now_button Boolean Indicates if the “Buy Now” button is shown on product detail pages (PDP)  
shipping_location_id String ID of the store’s shipping location  
merchant_id String The store’s merchant ID  
buyer_customer_accounts_enabled Boolean Indicates if buyer customer accounts are enabled  
payment_methods PaymentMethods The available payment methods for the store  
application_id String Application ID  

Back to top

FulfillmentSupport

Details about the store’s supported fulfillment methods.

Field Type Description
PICKUP Boolean Whether or not this online store can accept pickup orders
DELIVERY Boolean Whether or not this online store can accept delivery orders
SHIPMENT Boolean Whether or not this online store can accept shipping orders
DINE_IN Boolean Whether or not this online store can accept dine in orders
MANUAL Boolean Whether or not this online store can accept manual orders
DIGITAL Boolean Whether or not this online store can accept digital orders

Back to top

LocationsCounts

Details about the number of locations that support each fulfillment method.

Field Type Description
PICKUP Integer The number of locations that support pickup fulfillment
DELIVERY Integer The number of locations that support delivery fulfillment
SHIPMENT Integer The number of locations that support shipment fulfillment
DINE_IN Integer The number of locations that support dine-in fulfillment
PICKUP_OR_DELIVERY Integer The number of locations that support both pickup and delivery
BRICK_AND_MORTAR_FULFILLMENT Integer The number of brick-and-mortar locations supporting fulfillment
TOTAL Integer The number of locations that have at least one fulfillment method

Back to top

PaymentMethods

Details about the store’s supported payment methods.

Field Type Description
afterpay.enabed Boolean Whether or not Afterpay checkout is available for this site
afterpay.restrictions AfterpayRestrictions Min and max item and order amounts available for Afterpay
afterpay.limits.min Number Afterpay country-based minimum limit
afterpay.limits.max Number Afterpay country-based maximum limit
apple_pay.enabled Boolean Whether or not Apple Pay checkout is available for this site
google_pay.enabled Boolean Whether or not Google Pay checkout is available for this site

Back to top

AfterpayRestrictions

Information about Afterpay payment restrictions.

Field Type Description
item_price_min Money Lower bound for item prices
item_price_max Money Upper bound for item prices
checkout_order_price_min Money Lower bound for order totals
checkout_order_price_max Money Upper bound for order totals

Back to top

Money

Information about monetary amounts.

Field Type Description
amount Number Amount in the smallest subunit of the given currency
currency String The ISO 4217 three-letter currency code
formatted String Amount formatted with the symbol of the given currency. Formatted according to the site’s locale

Back to top