For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Dev Portal

Docs API Reference Learn Community Changelog

- About Our APIs
REST
GraphQL
MCP

About Our APIs
Overview
Overview
Carts
Get Cart
Create Cart
Delete Cart
Update Cart Currency
Add Cart Line Items
Update Cart Line Item
Delete Cart Line Item
Checkouts
Get Checkout
Update Customer Messages
Add Checkout Billing Address
Update Checkout Billing Address
Update Line Item
Delete Line Item
Create Consignment
Update Consignment
Delete Consignment
Add Coupon to Checkout
Delete Checkout Coupon
Add Gift Certificate to Checkout
Delete Gift Certificate
Checkout Spam Protection
Add Store Credit
Remove Store Credit
Consent
Set Cookie Consent Preferences
Customers
Create Customer
Subscriptions
Create Subscription
Form Fields
List Form Fields
Orders
Get Order
Pickup Options
Find Available Pickup Options
Overview
Overview
Create a Token
Revoke a Token
Create a Token
Create a Private API Token
Overview
Get Current Customer
Overview
Login Token
Brands
List Brands
Create Brand
Delete Brands
Get Brand
Update Brand
Delete Brand
List Brand Metafields
Create Multiple Metafields
Update Multiple Metafields
Delete Multiple Metafields
Create Brand Image
Delete Brand Image
List Brand Metafields
Create Brand Metafield
Get Brand Metafield
Update Brand Metafield
Delete Brand Metafield
Categories
List Categories
Create Category
Delete Categories
Get Category
Update Category
Delete Category
List Category Metafields
Create Multiple Metafields
Update Multiple Metafields
Delete Multiple Metafields
Create Category Image
Delete Category Image
List Category Metafields
Create Category Metafield
Get Category Metafield
Update Category Metafield
Delete Category Metafield
Get Product Sort Order
Update Product Sort Order
Category Trees
List Category Trees
Upsert Category Trees
Delete Category Trees
Get Category Tree
List Categories
Create Categories
Update Categories
Delete Categories
Products
List Products
Update Products (batch)
Create Product
Delete Products
Get Product
Update Product
Delete Product
List Product Metafields
Create Multiple Metafields
Update Multiple Metafields
Delete Multiple Metafields
List Bulk Pricing Rules
Create Bulk Pricing Rule
Get Bulk Pricing Rule
Update Bulk Pricing Rule
Delete Bulk Pricing Rule
List Products Category Assignments
Create Products Category Assignments
Delete Products Category Assignments
List Products Channel Assignments
Create Products Channel Assignments
Delete Products Channel Assignments
List Complex Rules
Create Complex Rule
Get Product Complex Rule
Update Product Complex Rule
Delete Product Complex Rule
List Product Custom Fields
Create Product Custom Field
Get Product Custom Field
Update Product Custom Field
Delete Product Custom Field
List Product Images
Create Product Image
Get Product Image
Update Product Image
Delete Product Image
List Product Metafields
Create Product Metafield
Get Product Metafield
Update Product Metafield
Delete Product Metafield
List Product Reviews
Create Product Review
Get Product Review
Update Product Review
Delete Product Review
Get Catalog Summary
List Product Videos
Create Product Video
Get Product Video
Update Product Video
Delete Product Video
Product Modifiers
List Product Modifiers
Create Product Modifier
Get Product Modifier
Update Product Modifier
Delete Product Modifier
Create Product Modifier Image
List Product Modifier Values
Create Product Modifier Value
Get Product Modifier Value
Update Product Modifier Value
Delete Product Modifier Value
Product Variants
List Product Variants
Create Product Variant
Get Product Variant
Update Product Variant
Delete Product Variant
List Product Variant Metafields
Create Multiple Metafields
Update Multiple Metafields
Delete Multiple Metafields
Create Product Variant Image
List Product Variant Metafields
Create Product Variant Metafield
Get Product Variant Metafield
Update Product Variant Metafields
Delete Product Variant Metafield
List Variants
Update Variants (batch)
Product Variant Options
List Product Variant Options
Create Product Variant Option
Get Product Variant Option
Update Product Variant Option
Delete Product Variant Option
List Product Variant Option Values
Create Product Variant Option Value
Get Product Variant Option Value
Update Product Variant Option Value
Delete Product Variant Option Value
Abandoned Cart Emails
API Reference
List Abandoned Cart Email Templates
Create Abandoned Cart Email Template
Get Email Template
Update Email Template
Delete Email Template
Get Default Email Template
Get Email Template Settings
Update Email Template Settings
Custom Template Associations
API Reference
List Custom Template Associations
Upsert Custom Template Associations
Delete Custom Template Associations
Email Templates
API Reference
List Email Templates
Get Email Template
Update Template
Delete Email Template Override
Pages
API Reference
List Pages
Create Pages
Update Pages
Delete Pages
Get Page
Update Page
Delete Page
Marketing
API Reference
List Banners
Create Banner
Delete All Banners
Get Banner
Update Banner
Delete Banner
Get Count of Store Banners
List Coupons
Create Coupon
Delete All Coupons
Get Count of Coupons
Update Coupon
Delete Coupon
Get Gift Certificate
Update Gift Certificate
Delete Gift Certificate
List Gift Certificates
Create Gift Certificate
Delete All Gift Certificates
List Scripts
Create Script
Get Script
Update Script
Delete Script
Store Content
API Reference
List Blog Posts
Create Blog Post
Delete Blog Posts
Get Blog Post
Update Blog Post
Delete Blog Post
Get Count of Blog Posts
List Blog Tags
List Pages (deprecated)
Create Page (deprecated)
Get Page (deprecated)
Update Page (deprecated)
Delete Page (deprecated)
List Redirects
Create Redirect
Delete All Redirects
Get Redirect
Update Redirect
Delete Redirect
Get Count of Redirects
List Redirects
Upsert Redirects
Delete Redirects
List Redirect Import-Export Jobs
Create Redirects Export Job
Create Redirects Import Job
Open Redirect Export Event Stream
Open Redirect Import Event Stream
Download Redirect Export
Themes
API Reference
List Themes
Upload Theme
Get Theme
Delete Theme
Download Theme
Activate Theme
Get Theme Configuration
Validate Theme Configuration
List Custom Templates
Get Theme Job
Widgets
API Reference
List Placements
Create Placement
Get Placement
Update Placement
Delete Placement
List Theme Regions
List Widgets
Create Widget
Get Widget
Update Widget
Delete Widget
List Widget Templates
Create Widget Template
Render Widget Template
Get Widget Template
Update Widget Template
Delete Widget Template
Page Widgets
API Reference
Get Page Snapshot
Publish or Overwrite Page Content
Abandoned Carts
Get Abandoned Cart
Get Global Abandoned Cart Settings
Update Global Abandoned Cart Settings
Get Channel Abandoned Cart Settings
Update Channel Abandoned Cart Settings
Carts
List Cart Metafields
Create Multiple Metafields
Update Multiple Metafields
Delete Multiple Metafields
Create Cart
Get Cart
Update Customer ID
Delete Cart
Add Cart Line Items
Update Cart Line Item
Delete Cart Line Item
List Cart Metafields
Create Cart Metafield
Get Cart Metafield
Update Cart Metafield
Delete Metafield
Create Cart Redirect URL
Get Global Cart Settings
Update Global Cart Settings
Get Channel Cart Settings
Update Channel Cart Settings
Channels
List Channels
Create Channel
Get Channel
Update Channel
Get Channel Active Theme
List Channel Metafields
Create Multiple Metafields
Update Multiple Metafields
Delete Multiple Metafields
List Channels Currency Assignments
Create Multiple Channels Currency Assignments
Update Multiple Channels Currency Assignments
List Channel Currency Assignments
Create Channel Currency Assignments
Update Channel Currency Assignments
Delete Channel Currency Assignments
List Channel Listings
Create Channel Listings
Update Channel Listings
Get Channel Listing
List Channel Menus
Create Channel Menus
Delete Channel Menus
List Channel Metafields
Create Channel Metafield
Get Channel Metafield
Update Channel Metafield
Delete Channel Metafield
Get Channel Site
Create Channel Site
Update Channel Site
Delete Channel Site
Upsert Siteʼs Checkout URL
Delete Siteʼs Checkout URL
Checkouts
Get Checkout
Update Customer Messages
Add Checkout Billing Address
Update Checkout Billing Address
Add Consignment to Checkout
Update Checkout Consignment
Delete Checkout Consignment
Add Coupon to Checkout
Delete Checkout Coupon
Add Discount to Checkout
Add Order Level Fees to Checkout
Update Order Level Fees in Checkout
Delete Order Level Fees from Checkout
Create Order
Get Checkout Settings
Update Checkout Settings
Get Channel-Specific Checkout Settings
Update Channel-Specific Checkout Settings
Create Checkout Token
Currencies
Get Currency
Update Currency
Delete Currency
List Currencies
Create Currency
Delete All Currencies
V3
List Customers
Create Customers
Update Customers
Delete Customers
List Customer Addresses
Create Customer Address
Update Customer Address
Delete Customer Address
List Customer Attribute Values
Upsert Customer Attribute Values
Delete Customer Attribute Values
List Customer Attributes
Create Customer Attribute
Update Customer Attribute
Delete Customer Attributes
Get Customer Settings per Channel
Update Customer Settings per Channel
Get Customer Consent
Update Customer Consent
List Customer Form Field Values
Upsert Customer Form Field Values
Get Customer Settings
Update Customer Settings
List Customer Metafields
Create Customer Metafields
Get Customer Metafield
Update Metafield
Delete Customer Metafield
List Customer Metafields
Create Multiple Metafields
Update Multiple Metafields
Delete Multiple Metafields
List Stored Instruments
Validate Customer Credentials
V2
List Customers
Create Customer
Delete Customers
Get Customer
Update Customer
Delete Customer
Get Count of Customers
List Customer Addresses
Create Customer Address
Delete Customer Address
Get Customer Address
Update Customer Address
Delete Customer Address
Get Count of Customer Addresses
List Customer Groups
Create Customer Group
Get Customer Group
Update Customer Group
Delete Customer Group
Get Count of Customer Groups
Validate Password
Customer Segmentation
List Segments
Create Segments
Update Segments
Delete Segments
List Segments for Shopper Profile
List Shopper Profiles
Create Shopper Profiles
Delete Shopper Profiles
List Shopper Profiles in Segment
Add Shopper Profiles to Segment
Remove Shopper Profiles from Segment
Geography
List Countries
Get Country
Get Count of Countries
List Countryʼs States
Get Countryʼs State
Get Count of States
List States
Get Count of Country’s States
Infrastructure Hosting
List Projects
Create a Project
Delete Projects
Delete a Project
Create a Deployment
Generate Upload Signature
Get Deployment Event Stream
Tail Worker Logs
Inventory
Absolute Adjustment
Relative Adjustment
List Inventory at Locations
Get Inventory at Location
Update Inventory Settings for Location
Create Locations
List Locations
Update Locations
Delete Locations
List Metafields
Create Metafield
Get Metafield
Update Metafield
Delete Metafield
List Metafields
Create Multiple Metafields
Update Multiple Metafields
Delete Multiple Metafields
Orders
Get Order
Update Order
Archive Order
Get Count of Orders
List Orders
Create Order
Delete All Orders
List Consignments
List Consignment Shipping Quotes
List Order Coupons
List Fees
List Order Messages
List Order Products
Get Order Product
List Order Shipments
Create Order Shipment
Delete Order Shipments
Get Count of Order Shipments
Get Shipment
Update Shipment
Delete Order Shipment
List Order Shipping Addresses
Get Shipping Address
Update Shipping Address
List Order Shipping Quotes
List Order Statuses
Get Single Order Status by ID
List Order Taxes
Order Operations
List Transactions
List Order Metafields
Create Multiple Metafields
Update Multiple Metafields
Delete Multiple Metafields
List Order Metafields
Create Metafields
Get Metafield
Update Metafield
Delete Metafield
Get Global Order Settings
Update Global Order Settings
Get Channel Order Settings
Update Channel Order Settings
Capture Order Payment
Void
Create Refund Quote
List Refunds for Order
Create Refund
Get Refund
List Refunds
Pickup
List Pickups
Create Pickups
Update Pickups
Delete Pickups
List Pickup Methods
Create Pickup Methods
Update Pickup Methods
Delete Pickup Methods
Find Available Pickup Options
Pickup Methods
List Pickup Methods
Create Pickup Methods
Update Pickup Methods
Delete Pickup Methods
List Pickups
Create Pickups
Update Pickups
Delete Pickups
Find Available Pickup Options
Pickup Options
Find Available Pickup Options
List Pickups
Create Pickups
Update Pickups
Delete Pickups
List Pickup Methods
Create Pickup Methods
Update Pickup Methods
Delete Pickup Methods
Pricing
Get Prices (batch)
Price Lists
List Price Lists
Create Price List
Delete All Price Lists
Get Price List
Update Price List
Delete Price List
Get Price List Assignments
Create Price List Assignments
Delete Price List Assignments
Upsert Price List Assignment
Create Batch of Price Lists Records
Create or Update Batch of Price Lists Records
List Price List Records
Create Price List Records
Upsert Price List Records
Delete Price List Record
List Price Records by Variant
Get Price Record by Currency Code
Set Price List Record by Currency Code
Delete Price Record by Currency Code
Promotions
List Coupon Codes
Delete Multiple Coupon Codes
Generate Multiple Coupon Codes
Create Coupon Code
Get Coupon Code
Delete Coupon Code
Delete Coupon Code by ID
List Promotions
Delete Multiple Promotions
Create Promotion
Get Promotion
Update Promotion
Delete Promotion
Promotion Settings
Get Global Promotion Settings
Update Global Promotion Settings
Redirects
List Redirects
Upsert Redirects
Delete Redirects
List Redirect Import-Export Jobs
Create Redirects Export Job
Create Redirects Import Job
Open Redirect Export Event Stream
Open Redirect Import Event Stream
Download Redirect Export
Scripts
Create Script
List Scripts
Get Script
Update Script
Delete Script
Settings
List Web Analytics Providers
Get Web Analytics Provider
Update Web Analytics Provider
Get Catalog Settings
Update Catalog Settings
Get Transactional Email Settings
Update Transactional Email Settings
Create Favicon Image
Get Inventory Settings
Update Inventory Settings
Get Inventory Notifications Settings
Update Inventory Notifications Settings
Get Store Logo Settings
Update Store Logo Settings
Create Logo Image
List Enabled Filters
Update Enabled Filters
List Available Filters
List Contextual Filters
Upsert Contextual Filters
Get Locale Settings
Update Locale Settings
Get Store Profile Settings
Update Store Profile Settings
Get Storefront Category Settings
Update Storefront Category Settings
Get Storefront Product Settings
Update Storefront Product Settings
Get Robots.txt Settings
Update Robots.txt Settings
Get Storefront Search Settings
Update Storefront Search Settings
Get Storefront Security Settings
Update Storefront Security Settings
Get Storefront SEO Settings
Update Storefront SEO Settings
Get Storefront Status
Update Storefront Status
Get Units of Measurement Settings
Update Units of Measurement Settings
Shipping
List Customs Information
Upsert Customs Information
Delete Customs Information
Get Shipping Settings
Update Shipping Settings
Get Shipping Settings per Channel
Update Shipping Settings per Channel
Create Carrier Connection
Update Carrier Connection
Delete Carrier Connection
List Shipping Methods in Zone
Create Shipping Method
Get Shipping Method
Update Shipping Method
Delete Shipping Method
List Shipping Zones
Create Shipping Zone
Get Shipping Zone
Update Shipping Zone
Delete Shipping Zone
Sites
Create Site
List Sites
Get Site
Update Site
Delete Site
Get Site’s SSL TLS Certificate Information
Upsert Site’s SSL TLS Certificate Information
List Site Certificates
Get Site’s Routes
Create Site Route
Update Site’s Routes
Get Site Route
Update Site Route
Delete Site Route
V3
List Store Metafields
Create Multiple Metafields
Update Multiple Metafields
Delete Multiple Metafields
Get Store Metafield
Update Store Metafield
Delete Metafield
V2
Get Store Information
Get System Timestamp
Subscribers
List Subscribers
Create Subscriber
Delete Subscribers
Get Subscriber
Update Subscriber
Delete Subscriber
System Logs
List System Logs
Tax
Tax Classes
V3
Create tax classes
Update tax classes
Delete tax classes
V2
List Tax Classes
Get Tax Class
List Tax Customers
Update Tax Customers
Delete Tax Customers
List Tax Properties
Create Tax Properties
Update Tax Properties
Delete Tax Properties
List Product Tax Properties
Update Product Tax Properties
Delete Product Tax Properties
List Tax Zones
Create Tax Zones
Update Tax Zones
Delete Tax Zones
List Tax Rates
Create Tax Rates
Update Tax Rates
Delete Tax Rates
Get Tax Settings
Update Tax Settings
Check Zone for Address
Wishlists
List Wishlists
Create Wishlist
Get Wishlist
Update Wishlist
Delete Wishlist
Delete Wishlist Item
Add Wishlist Item
Payments
Process Payments
Attach Instrument to Customer
API Reference
Create Payment Access Token
Stored Instruments (Beta)
Create Instrument Access Token
List Instruments
Bulk Import Instruments
Update Instrument
Bulk Delete Instruments
Remove Instrument from Store and Gateway
List Available Payment Method Ids
Methods
V3
List Accepted Payment Methods
V2
List Payment Methods
API Reference
Transactions (Beta)
Create Purchase Transaction
Create Authorization Transaction
Overview
Shipping Provider
Request Shipping Rates
Validate Connection Options
Tax Provider
Estimate Taxes
Void Tax Quote
Commit Tax Quote
Adjust Tax Quote
Get Connection Status
Update Connection
Delete Connection
Webhooks
List Webhooks
Create Webhook
Get Webhook
Update Webhook
Delete Webhook
Get Admin Info
Upsert Email Notifications
Overview
Storefront
API Reference
Authentication
Get Storefront authToken Within Stencil
Get Storefront authToken for Specific Customer
Catalog
Get Product Variants Info
Get Variant Information
Get Detailed Variant Information
Company
List Countries
Get Address Edit Permission
List Company Addresses
Create Company Address
Search Company Addresses
Search Addresses with Multiple Filters
Get Address
Update Address Information
Mark Address as Active or Inactive
Get Company Default Addresses
Create Company
Get Company Extra Fields
Get Company by User ID
List Company Users
Validate Frontend User Email
Check Existence of Customer Email
List Users
Create User
Get User Information
Update User Information
Delete User
Orders
List Orders
Create Order
List Order Images
List Order Products
Get Order Details
List Ordered Products
Request for Quote
List Quotes
Create Quote
Get Quote Details
Send Quote Message
Generate Cart and Checkout URL for Quote
Assign Quote to BigCommerce Order
Export Quote PDF
Get Quote Configs
Send Quote Email
Get Quote Store Info
Sales Rep
Get Super Admin's Assigned Companies
Get Super Admin's Current Masquerading Company
Begin Super Admin Masquerade
End Super Admin Masquerade
Shopping List
List Shopping Lists
Create Shopping List
Update Shopping List
Get Shopping List ID and Name
Add Shopping List Items
Update Shopping List Items
List Shopping List Items Extension
Delete Shopping List Item
Delete Shopping List
Duplicate Shopping List
Store Settings
List Available Currencies
List Store-Level Order Statuses
Management
Overview
API Reference
Addresses
Get Country
Get State
List Addresses
Create Company Address
Get Address
Update Address
Delete Address
Bulk Create Addresses
List Address Extra Field Configs
Authentication
Get Storefront authToken with Credentials
Get B2B Storefront Token
Get Storefront API authToken
Get Server to Server Token
Delete Backend API Tokens
List Server to Server Tokens
Channels
List Channels
Get Channel Details by Channel ID
Company
List Company Subsidiaries
Delete Company Subsidiary
Attach Company as The Parent of Current Company
List Company Hierarchy
Companies
List Companies
Create Company
Get Company Details
Update Company
Delete Company
Convert BigCommerce Customer Group into Company
Bulk Create Companies
Update Companies (batch)
Update Company Catalog
Update Company Status
List Company Extra Field Configs
List Company Attachments
Add Company Attachment
Delete Company Attachment
List Company Permissions
Create Company Permission
Update Company Permission
Delete Company Permission
List Company Roles
Create Company Role
Get Company Role Details
Update Company Role
Delete Company Role
Invoice Management
Get Invoice Detail
Update Invoice
Delete Invoice
List Invoices
Create Invoice
Create Invoice from Order
Download Invoice PDF
Get Invoice Extra Field Configs
List Payments
Get Payment Detail
Delete Payment
Get Payment Operation
Perform Payment Operation
Update Payment Processing Status
List Payment Transactions
Create Offline Payment
Update Offline Payment
List Receipts
Get Receipt
Delete Receipt
List Receipt Lines
List Lines of Receipt
Get Receipt Line Detail
Delete Receipt Line
Orders
List Orders
Create Order
Get Order
Update Order
Reassign Orders to Different Company
List Order Products
Assign Customer Orders to Company
List Order Extra Field Configs
Payment
List Payment Methods
List Company Payment Methods
Update Company Payment Methods
List Active Payment Methods
Get Company Credit Status
Update Company Credit Status
Get Company-Level Payment Terms
Update Company-Level Payment Terms
Quotes
List Quotes
Create Quote
List B2B Quote Custom Shipping Methods
Send Quote Email
List Quote Extra Fields Configs
Get Quote Details
Update Quote
Delete Quote
Generate Cart and Checkout URL for Quote
Assign Quote to BigCommerce Order
Export Quote PDF
Select Shipping Rate for Quote
Remove Selected Shipping Rate from Quote
Get Available Shipping Rates for Quote
Sales Staff
List Sales Staff
Get Sales Staff Account Details
Update Sales Staff Assignments
Shopping List
List Shopping Lists
Create Shopping List
Get Shopping List
Update Shopping List
Delete Shopping List
Delete Shopping List Item
Super Admin
Create Super Admin
Create Super Admins (batch)
List Companies with Assigned Super Admins
Update Super Admin Company Assignments
Get Super Admin's Assigned Companies
Get Super Admin Details
Update Super Admin Details
List Super Admins with Assigned Companies
List Super Admins Assigned to Company
Update Company Super Admins Assignments
Users
List B2B Users
Create Company User
Bulk Create Users
Get User Details
Update User Details
Delete User
Get User Details by BigCommerce Customer ID
List Extra Fields for Users
Overview
site
channel
customer
node
inventory
shopperPreferences
store
geography
createCart
deleteCart
addCartLineItems
updateCartLineItem
deleteCartLineItem
updateCartCurrency
assignCartToCustomer
unassignCartFromCustomer
createCartMetafield
updateCartMetafield
deleteCartMetafield
createCartRedirectUrls
updateCheckout
createCheckout
addCheckoutBillingAddress
updateCheckoutBillingAddress
updateCheckoutCustomerMessage
selectCheckoutShippingOption
applyCheckoutCoupon
unapplyCheckoutCoupon
applyCheckoutGiftCertificate
unapplyCheckoutGiftCertificate
applyCheckoutSpamProtection
addCheckoutShippingConsignments
updateCheckoutShippingConsignment
deleteCheckoutConsignment
completeCheckout
login
logout
createWishlist
addWishlistItems
deleteWishlistItems
updateWishlist
deleteWishlists
loginWithCustomerLoginJwt
submitContactUs
generateSessionSyncJwt
validateSessionSyncJwt
productViewedEvent
pageViewedEvent
visitStartedEvent
searchProductEvent
previewGiftCertificate
registerCompany
addProductReview
changePassword
requestResetPassword
resetPassword
registerCustomer
updateCustomer
addCustomerAddress
updateCustomerAddress
deleteCustomerAddress
payment
subscribe
unsubscribe
client
store
system
node
nodes
i18n
createAppExtension
updateAppExtension
deleteAppExtension
createChannel
removeProductBasicInformationOverrides
removeProductSeoInformationOverrides
removeProductOptionsOverrides
removeProductStorefrontDetailsOverrides
removeProductPreOrderSettingsOverrides
setProductBasicInformation
setProductIsFeatured
removeProductIsFeaturedOverride
setProductSeoInformation
setProductStorefrontDetails
setProductPreOrderSettings
setProductOptionsInformation
setProductUrlPath
removeProductUrlPathOverride
setProductModifiersInformation
removeProductModifiersOverrides
removeProductCustomFieldsOverrides
updateProductCustomFields
addImagesToProduct
removeImagesFromProduct
updateProductImageProperties
removeProductImagePropertiesOverrides
setSharedProductModifiersInformation
removeSharedProductModifiersOverrides
setSharedProductOptionsInformation
removeSharedProductOptionsOverrides
settings
updateTranslations
deleteTranslations
addLocale
deleteLocale
updateLocale
createEventBridgeWebhook
createPubSubWebhook
updatePubSubWebhook
updateEventBridgeWebhook
createHttpsWebhook
deleteWebhook
updateHttpsWebhook
createMetafield
updateMetafield
deleteMetafield
reassignMetafieldsOwner
Overview
account
node
nodes
system
addUserToAccount
removeUserFromAccount
createCheckout
cancelSubscription
createUserWithPassword
createUser
addUserToStore
removeUserFromStore
createEventSource
deleteEventSource
companyRoles
companyRole
companyPermissions
accountSettings
customerAccountSettings
invoices
invoice
invoiceStats
invoiceCustomerInformation
invoicePaymentModules
invoiceBcOrderAllowMethods
invoicePaymentBcCart
invoicePaymentFees
receipts
receipt
allReceiptLines
receiptLine
receiptLines
order
allOrders
orderProducts
orderedProducts
customerOrders
customerOrder
createdByUser
shoppingLists
shoppingList
shoppingListsIdName
customerShoppingLists
customerShoppingList
customerShoppingListsIdName
companyExtraFields
userCompany
companyValidateEmail
companyUserInfo
accountFormFields
companyCreditConfig
companyPaymentTerms
companySubsidiaries
superAdminCompanies
superAdminMasquerading
quotes
customerQuotes
quote
quoteUserStoreInfo
quoteConfig
quoteExtraFieldsConfig
users
user
userEmailCheck
customerEmailCheck
userExtraFields
currentUser
customerInfo
userLoginState
userMasqueradingCompany
orderStatuses
bcOrderStatuses
currencies
autoLoader
storeLimitations
storeBasicInfo
storefrontScript
storefrontDefaultLanguage
storefrontProductSettings
storefrontSettings
storeConfigSwitchStatus
storeCheckoutConfig
storefrontConfig
storefrontConfigs
productVariantsInfo
variantSku
productsInventory
productsLoad
productsSearch
taxZoneRates
productPurchasable
validateProduct
validateProducts
priceProducts
addresses
address
countries
defaultShippingAddress
defaultBillingAddress
customerAddresses
customerAddress
addressConfig
addressExtraFields
productUpload
productAnonUpload
updateAccountSettings
updateCustomerAccountSettings
invoicePdf
invoicesExport
invoiceCreateBcCart
invoiceFinishBcPayment
createOrder
shoppingListsCreate
shoppingListsUpdate
shoppingListsDelete
shoppingListsDuplicate
shoppingListsItemsCreate
shoppingListsItemsUpdate
shoppingListsItemsDelete
customerShoppingListsCreate
customerShoppingListsUpdate
customerShoppingListsDelete
customerShoppingListsDuplicate
customerShoppingListsItemsCreate
customerShoppingListsItemsUpdate
customerShoppingListsItemsDelete
quoteCreate
quoteUpdate
quoteCheckout
quoteOrdered
quoteEmail
quotePdfExport
quoteAttachFileDelete
quoteAttachFileCreate
quoteFrontendPdf
superAdminBeginMasquerade
superAdminEndMasquerade
companyCreate
login
checkoutLogin
authorization
userCreate
userUpdate
userDelete
storeFrontToken
customerCreate
customerSubscribersCreate
userMasqueradingCompanyBegin
userMasqueradingCompanyEnd
addressCreate
addressUpdate
addressDelete
customerAddressCreate
customerAddressUpdate
customerAddressDelete
Overview
Tool Resynchronization
B2C Storefront

Dev Portal

GraphQL Storefront Mutations

subscribe

Example Query

1 mutation ExampleMutation($input: CreateSubscriberInput!) {
2   newsletter {
3     subscribe(input: $input) {
4       errors
5     }
6   }
7 }

Variables

1 {
2   "input": {
3     "email": "example",
4     "firstName": "example",
5     "lastName": "example"
6   }
7 }

Example response

1 {
2   "data": {
3     "newsletter": {
4       "subscribe": {
5         "errors": [
6           {
7             "message": "example"
8           }
9         ]
10       }
11     }
12   }
13 }

Subscribe to newsletter mutation.

Arguments

inputCreateSubscriberInputRequired

Input for subscribing to the newsletter.

Returns

a CreateSubscriberResult

errorslist of CreateSubscriberErrors

A list of errors that occurred during the subscription process.

Was this page helpful?

Built with