BigCommerce

Get a single coupon by ID.

Delete a category from the catalog. Warning: This will also delete all subcategories. Products in deleted categories will be moved to no category.

Get a single webhook by ID.

List brands from the catalog with filtering and pagination. Brands can be assigned to products to organize and filter catalog items.

Get a single brand by ID. Returns full brand details including SEO settings and custom URL.

Create a new brand. Returns the created brand with its assigned ID.

Update an existing brand. All fields are optional - only provided fields will be updated.

Delete a brand from the catalog. Warning: Products using this brand will have their brand association removed.

List categories from the catalog with filtering and pagination. Categories can be organized hierarchically using parent_id.

Get a single category by ID. Returns full category details including SEO settings, sort order, and custom URL.

Create a new category in the catalog. Set parentId to 0 for root-level categories, or specify a parent category ID for subcategories.

Update an existing category. All fields are optional - only provided fields will be updated.

List customers with filtering and pagination. Supports filtering by email, name, company, customer group, and date range.

Get a single customer by ID. Returns full customer details including contact info, notes, and store credit.

Create a new customer. Required fields: email, firstName, lastName. Returns the created customer.

Update an existing customer. All fields are optional - only provided fields will be updated.

Delete a customer. Warning: This will also delete all associated addresses and order history.

List addresses for customers. Can filter by customer ID to get addresses for a specific customer.

Create a new address for a customer.

Update an existing customer address.

Delete a customer address.

List customer groups. Customer groups can have special pricing and category access rules.

Get a single customer group by ID. Returns group details including discount rules and category access.

List coupons with filtering and pagination. Coupons provide discount codes that customers can apply at checkout.

Create a new coupon. Coupon types: - per_item_discount: Fixed amount off each item - per_total_discount: Fixed amount off order total - percentage_discount: Percentage off - shipping_discount: Fixed amount off shipping - free_shipping: Free shipping

Update an existing coupon.

Delete a coupon.

List promotions. Promotions are more flexible than coupons and can be automatic or require codes.

Get a single promotion by ID.

Delete a promotion.

Get store information including name, domain, plan, settings, and features. Returns store configuration including: - Store name, domain, and secure URL - Plan information (name, level) - Currency, timezone, and language settings - Admin contact information - Feature flags (multi-storefront, stencil, etc.)

List orders with filtering and pagination. Supports filtering by status, customer, date range, total amount, and payment method.

Get a single order by ID. Returns full order details including billing address, totals, and resource URLs.

Get the count of orders matching criteria. Useful for analytics and reporting without fetching full order data.

Update an existing order. Use this to change order status, add staff notes, or update customer messages.

Delete an order. Warning: This will mark the order as deleted. Use with caution.

List products/line items in an order.

Get details of a specific product in an order.

List shipments for an order.

Get details of a specific shipment.

Create a shipment for an order. This will trigger shipment notification emails to the customer.

Update a shipment. Use this to add or update tracking information.

Delete a shipment from an order. Note: This does not change the order status.

List shipping addresses for an order. Orders can have multiple shipping addresses for split shipments.

List products from the catalog with filtering and pagination. Supports filtering by name, SKU, visibility, brand, categories, availability, and featured status. Use include parameter to fetch related data like images, variants, and custom fields.

Get a single product by ID with optional related data. Returns full product details including pricing, inventory, dimensions, categories, and optional related data.

Create a new product in the catalog. Required fields: name, type (physical, digital), price, weight. Returns the created product.

Update an existing product. All fields are optional - only provided fields will be updated.

Delete a product from the catalog. Warning: This action is permanent and cannot be undone.

List variants for a product. Variants are different versions of a product (e.g., size/color combinations).

Get a single product variant by ID.

Update an existing price list.

Update a product variant. Use this to update variant-specific pricing, inventory, or other attributes.

List images for a product.

Add an image to a product by URL.

Delete an image from a product.

List custom fields for a product. Custom fields store additional product metadata displayed on the storefront.

Add a custom field to a product.

Update a product custom field.

Delete a custom field from a product.

List reviews for a product.

Create a review for a product.

Update a product review.

Delete a product review.

Delete a price list.

List webhooks configured for the store. Webhooks send HTTP POST notifications when events occur in your store.

Create a new webhook. Common scopes: - store/order/created, store/order/updated, store/order/statusUpdated - store/product/created, store/product/updated, store/product/deleted - store/customer/created, store/customer/updated - store/cart/created, store/cart/converted - store/shipment/created, store/shipment/updated

Update an existing webhook.

Delete a webhook.

List scripts installed on the storefront. Scripts allow injecting custom JavaScript into storefront pages.

Get a single script by UUID.

Create a new storefront script. Scripts can be injected via HTML or external source URL.

Update an existing script.

Delete a script from the storefront.

List price lists. Price lists allow different pricing for different customer groups or channels.

Get a single price list by ID.

Create a new price list.

List sales channels. Channels represent different storefronts or sales platforms.

Get a single channel by ID.