Browse the API v2 reference

API v2 referenceBeta← Guides

v2 (beta)v1 (legacy)

Account

Help Docs

• GETRetrieve the help docs

Integrations

• GETList integrations
• PATCHUpdate an integration
• POSTFlows auto setup
• POSTConfirm flows for an integration
• POSTReset flows for an integration
• POSTSend flows test event for an integration
• POSTVerify flows for an integration
• GETRetrieve an integration
• POSTConnect an integration
• GETList events for an integration
• POSTDisconnect an integration
• GETRetrieve mailchimp audiences
• GETRetrieve postscript keywords

Languages

• GETList languages
• PATCHUpdate a language
• POSTReset locale

Locations

• GETList locations

Markets

• GETList markets
• PATCHUpdate a market

Plan Usage

• GETRetrieve the plan usage

Sending

• GETRetrieve the sending
• PATCHUpdate the sending
• POSTVerify domain

Settings

• GETRetrieve the settings

Setup

• GETRetrieve the setup

Setup Guide

• GETRetrieve the setup guide
• POSTSkip setup guide

Templates

• GETList translations for a template
• GETRetrieve email style
• PATCHUpdate email style
• POSTEmail style logo
• DELRemove an email style logo from a template

Theme Integrations

• GETList theme integrations
• POSTCreate a theme integration
• GETRetrieve a theme integration
• PATCHUpdate a theme integration

Translations

• GETList translations

Web Pixel

• POSTEnable web pixel

Back In Stock

App Proxy

• GETRetrieve detect
• GETVerify app proxy

Customers

• GETList customers
• GETRetrieve a customer
• DELDelete a customer
• POSTSubscribe a customer
• POSTUnsubscribe a customer
• POSTBulk delete customers

Notification Settings

• GETList notification settings
• GETRetrieve a notification setting
• PATCHUpdate a notification setting

Notifications

• GETList notifications
• GETRetrieve a notification

Orders

• GETList orders

Products

• GETList products
• PATCHUpdate a product

Reports

• GETList reports
• GETRetrieve conversions
• GETRetrieve engagement
• GETRetrieve notifications
• GETRetrieve product revenue
• GETRetrieve products in demand
• GETRetrieve signups
• GETRetrieve summary
• GETRetrieve wait duration

Sending History

• GETRetrieve the sending history
• GETRetrieve the sending history (GET /back_in_stock/sending_history/{id})

Settings

• GETRetrieve the settings
• PATCHUpdate the settings
• GETRetrieve alerts
• PATCHUpdate alerts
• GETRetrieve channels
• PATCHUpdate channels
• GETRetrieve compliance
• PATCHUpdate compliance
• GETRetrieve delivery
• PATCHUpdate delivery
• GETRetrieve tagging
• PATCHUpdate tagging
• GETRetrieve widget
• PATCHUpdate widget

Signups

• GETList signups
• POSTCreate a signup
• GETRetrieve a signup
• DELDelete a signup
• GETList history for a signup
• POSTNotify a signup
• POSTBulk delete signups
• GETRetrieve notification status
• POSTNotify signups
• POSTNotify variants
• POSTResend optin
• POSTTransfer signups

Templates

• GETList templates
• GETRetrieve a template
• PATCHUpdate a template
• POSTSend test for a template
• GETList translations for a template
• POSTVerify flow for a template

Widget Templates

• GETList widget templates
• POSTCreate a widget template
• PATCHUpdate a widget template
• DELDelete a widget template

Customers

Status

• GETRetrieve status

Preorders

Notification Settings

• GETList notification settings
• GETRetrieve confirmation
• PATCHUpdate confirmation

Offer Lookup

• GETFind offer lookup

Offers

• GETList offers
• POSTCreate an offer
• GETRetrieve an offer
• PATCHUpdate an offer
• GETList advanced for an offer
• PATCHUpdate an advanced on an offer
• GETList batches for an offer
• PATCHUpdate a batch on an offer
• GETList countdown for an offer
• PATCHUpdate a countdown on an offer
• POSTDisable an offer
• POSTDiscard
• POSTDuplicate an offer
• POSTEnable an offer
• GETList integrations for an offer
• PATCHUpdate an integration on an offer
• GETList inventory for an offer
• PATCHUpdate an inventory on an offer
• GETList limits for an offer
• PATCHUpdate a limit on an offer
• GETList markets for an offer
• PATCHUpdate a market on an offer
• GETList payments for an offer
• PATCHUpdate a payment on an offer
• GETList products for an offer
• PATCHUpdate a product on an offer
• POSTAdd products variants to an offer
• POSTProducts advance batches
• POSTBulk products toggle inventory policy offers
• POSTRemove products variants from an offer
• GETList products variants for an offer
• GETList products variants for an offer (GET /preorders/offers/{id}/products/variants/{shopify_variant_id})
• PATCHUpdate a products variant on an offer
• POSTReset products variants count for an offer
• POSTProducts variants toggle inventory policy
• POSTBulk products variants update settings offers
• POSTRestore an offer
• POSTSchedule an offer
• GETList shipping for an offer
• PATCHUpdate a shipping on an offer
• GETList shipping schedulable orders for an offer
• GETList translations for an offer
• POSTTranslations clear locale
• POSTReset translations to defaults for an offer
• POSTSet translations for an offer
• POSTSet translations many for an offer
• POSTTranslations unset
• POSTUnschedule
• GETList widget for an offer
• PATCHUpdate a widget on an offer
• POSTBulk disable offers
• POSTBulk enable offers

Orders

• GETList orders
• GETRetrieve an order
• POSTCollect payment
• GETList fulfillment for an order
• POSTHold fulfillments
• GETList notifications for an order
• POSTOpen scheduled fulfillments
• GETList payments for an order
• POSTRelease an order
• POSTReschedule fulfillment
• POSTReschedule payment
• POSTSend confirmation for an order
• POSTSend shipping update for an order
• POSTSend sms confirmation for an order
• POSTSplit fulfillment orders
• GETList timeline for an order
• POSTBulk collect payment orders
• POSTBulk hold fulfillments orders
• POSTBulk open scheduled fulfillments orders
• POSTBulk release orders
• POSTBulk reschedule fulfillment orders
• POSTBulk reschedule payment orders
• POSTBulk send confirmation orders
• POSTBulk send shipping update orders
• POSTBulk split fulfillment orders orders
• GETList jobs for an order

Product Variants

• GETRetrieve a product variant
• POSTDetach from all offers from a product variant
• POSTRecalculate preorder count
• POSTReset metafields for a product variant
• POSTReset preorder count for a product variant
• POSTSync metafields for a product variant
• GETRetrieve availability
• POSTBulk recalculate preorder counts product variants
• POSTBulk reset metafields product variants
• POSTBulk sync metafields product variants
• GETList jobs for a product variant

Products

• GETList products
• PATCHUpdate a product
• POSTAdd to offer
• POSTBulk toggle inventory policy products
• GETRetrieve inventory policy conflicts
• POSTRemove from offers
• GETRetrieve tags
• GETRetrieve tags count

Reports

• GETList reports
• GETRetrieve by date
• GETRetrieve engagement
• GETRetrieve fulfillments
• GETRetrieve products
• GETRetrieve summary

Settings

• GETRetrieve developer
• PATCHUpdate developer
• GETRetrieve pages
• PATCHUpdate pages
• GETRetrieve reports
• PATCHUpdate reports
• GETRetrieve storefront text
• PATCHUpdate storefront text

Templates

• GETList templates
• GETRetrieve confirmation
• PATCHUpdate confirmation
• POSTSend confirmation test
• GETRetrieve payment failed
• PATCHUpdate payment failed
• GETUpdate shipping
• PATCHUpdate shipping (PATCH /preorders/templates/shipping_update)

Account · Resource

Copy pageView as Markdown

Locations

API v2 is in public beta: endpoints and fields can change before general availability. See the changelog

The shop's Shopify locations, for naming the locations whose stock STOQ counts.

Endpoints

• List locationsGET /account/locations

Endpoints

• GET/account/locations