Developer Guides
  • Introduction
    • Welcome
  • Core
    • Overview
    • Frontend
      • Implementation & Testing
      • Using the API endpoints
      • Gift cards
        • Gift Card validation API (Optional)
      • Check stock
      • Sibling products
      • Rewards program
      • Customer signatures
      • Retail transactions
      • Shopify Local Pick-up
  • API
    • Overview
    • Quick Start
    • Accounts
    • Changelog
    • Reference
      • Customers
      • Inventory
      • Orders
      • Products
      • Rewards
      • Stores
      • Vouchers
      • Staff
Powered by GitBook
On this page
  • Shopify App proxy
  • Usage

Was this helpful?

Export as PDF
  1. Core
  2. Frontend

Using the API endpoints

PreviousImplementation & TestingNextGift cards

Last updated 1 year ago

Was this helpful?

Shopify App proxy

Online store must not have the password page enable when calling the app proxy

The DotApparel app itself is hosted in a serverless environment on Google Cloud. Each time the frontend needs to make an API request to the app to retrieve data, it will call a designated API endpoint for that type of data.

Rather than making direct requests to the Google Cloud endpoints, we strongly recommend using the . Using the app proxy means that if your Shopify store is hosted on , you would make a request to the following endpoint.

  • https://acme.myshopify.com/apps/dotapparel/[endpoint]

  • [Deprecated] https://acme.myshopify.com/apps/dotapparel21/[endpoint]

Using the app proxy means that the browser is only making requests to the current domain, which negates the need to handle and other cross-origin concerns.

When the DotApparel app is installed into your store, the API endpoints listed in this guide will always be available at /apps/dotapparel. The remainder of this guide will use the above domain as an example.

Usage

Each of the API endpoints is documented in the specific section. For example, if you’re looking to access in-store orders, see retail transactions.

Shopify App proxy
http://acme.myshopify.com
CORS
http://acme.myshopify.com