Skip to main content

BigCommerce API Endpoints

Updated over a month ago

Base URLs

  • Sandbox/Test: https://api.bigcommerce.com

Table of Contents

Customer Endpoints

Get a Customer: (GET)

[Base URL]/customers?id:in={{customer_id}}

Get a Super Admin: (GET)

[Base URL]/super-admins/info/{{customer_id}}

Get a B2B Customer: (GET)

[Base URL]/super-admins/info/{{customer_id}}

GET a B2C Customer by Filter: (GET)

[Base URL]/customers?{BC_FIlter}&include=addresses,storecredit,attributes,formfields

GET a B2C Customer by ID including other responses (addresses, store credit, attributes and form fields): (POST)

[Base URL]/ customers?id:in={id}&include=addresses,storecredit,attributes,formfields

Create a User: (POST)

[Base URL]/users

Create a B2C Customer: (POST)

[Base URL]/customers

Update a B2C Customer: (PUT)

[Base URL]/customers/{{customer_id}}

Delete a B2B Customer: (DELETE)

[Base URL]/users/customer/{id}

Delete a B2C Customer: (DELETE)

[Base URL]/customers?id:in={id}

Customer Category Endpoints

Get a Customer Category: (GET)

[Base URL]/stores/{storeHash}/v2/customer_groups/{id}

Create a Customer Category: (POST)

[Base URL]/stores/{STORE_HASH}/v2/customer_groups

Update a Customer Category: (PUT)

[Base URL]/stores/{storeHash}/v2/customer_groups/{id}

Delete a Customer Category: (DELETE)

[Base URL]/stores/{storeHash}/v2/customer_groups/{id}

Customer Attribute Endpoints

Get a Customer Attribute: (GET)

[Base URL]/customers/attributes?name={name}

Create a Customer Attribute: (POST)

[Base URL]/customers/attributes

Update a Customer Attribute: (PUT)

[Base URL]/customers/attributes?id:in={id}

Update a Customer Attribute Value: (PUT)

[Base URL]/customers/attribute-values

Delete a Customer Attribute: (DELETE)

[Base URL]/customers/attributes?id:in={id}

Customer Address Endpoints

Get a Customer Address: (GET)

[Base URL]/customers/addresses?customer_id:in={{customer_id}}

Create a Customer Address: (POST)

[Base URL]/customers/addresses

Update a Customer Address: (PUT)

[Base URL]/customers/addresses/{{customer_id}}

Customer Relationship Endpoints

Get a Company: (GET)

[Base URL]/companies?{{company_id}}

Company Endpoints

Get a Company: (GET)

[Base URL]/companies?{{company_id}}

Create a Company: (POST)

[Base URL]/companies

Update a Company: (PUT)

[Base URL]/companies/{{company_id}}

Delete a Company: (DELETE)

[Base URL]/companies/{companyId}

Company Address Endpoints

Get a Company Address: (GET)

[Base URL]/addresses/{{address_id}}

Create a Company Address: (POST)

[Base URL]/addresses

Update a Company Address: (PUT)

[Base URL]/addresses/{{address_id}}

Company Relationship Endpoints

Get a Company Relationship: (GET)

[Base URL]/companies/{id}/super-admins

Get a Company Relationship: (GET)

[Base URL]/users?{BCFilter}

Gift Card Endpoints

Get a Gift Card: (GET)

[Base URL]/stores/{STORE_HASH}/v2/gift_certificates/{{giftcard_id}}

Create a Gift Card: (POST)

[Base URL]/stores/{STORE_HASH}/v2/gift_certificates

Update a Gift Card: (PUT)

[Base URL]/stores/{STORE_HASH}/v2/gift_certificates/{{giftcard_id}}

Delete a Gift Card: (PUT)

[Base URL]/stores/{STORE_HASH}/v2/gift_certificates/{{giftcard_id}}

Payment Method Endpoints

Get Payment Methods: (GET)

[Base URL]/stores/{STORE_HASH}/v2/payments/methods

Get B2B Payment Methods: (GET)

[Base URL]/api/v3/io/payments/payments

Product Endpoints

Create a Product: (POST)

[Base URL]/catalog/products

Update a Product: (PUT)

[Base URL]/catalog/products/{product_id}

Delete a Product: (DELETE)

[Base URL]/catalog/products/{product_id}

Update a storefront: (PUT)

[Base URL]/storefront/redirects

Product Brand Endpoints

Get a Product Brand: (GET)

[Base URL]/catalog/brands/{brand_id}

Create a Product Brand: (POST)

[Base URL]/catalog/brands

Update a Product Brand: (PUT)

[Base URL]/catalog/brands/{brand_id}

Delete a Product Brand: (DELETE)

[Base URL]/catalog/brands/{brand_id}

Product Custom Field Endpoints

Get Custom Fields of Product: (GET)

[Base URL]/catalog/products/{product_id}/custom-fields/{custom_field_id}

Create a new Custom Field of Product: (POST)

[Base URL]/catalog/products/{product_id}/custom-fields

Update an existing Custom Field of Product: (PUT)

[Base URL]/catalog/products/{product_id}/custom-fields/{custom_field_id}

Product Channel Assignments Endpoints

Get Product Channel Assignment: (GET)

[Base URL]/catalog/products/channel-assignments?channel_id:in={channel_id}&product_id:in={product_id}

Update Product Channel Assignment: (PUT)

[Base URL]/catalog/products/channel-assignments?channel_id:in={channel_id}&product_id:in={product_id}

Delete Product Channel Assignment: (DELETE)

[Base URL]/catalog/products/channel-assignments?channel_id:in={channel_id}&product_id:in={product_id}

Product Images Endpoints

Get Image Details of a Product: (GET)

[Base URL]/catalog/products/{product_id}/images/{image_id}

Create a new Product Image: (POST)

[Base URL]/catalog/products/{product_id}/images

Update a Product Image: (PUT)

[Base URL]/catalog/products/{product_id}/images/{image_id}

Delete a Product Image: (DELETE)

[Base URL]/catalog/products/{product_id}/images/{image_id}

Product Modifiers Endpoints

Get Product Modifiers: (GET)

[Base URL]/catalog/products/{product_id}/modifiers/{modifier_id}

Create Product Modifiers: (POST)

[Base URL]/catalog/products/{product_id}/modifiers

Update Product Modifiers: (PUT)

[Base URL]/catalog/products/{product_id}/modifiers/{modifier_id}

Delete Product Modifiers: (DELETE)

[Base URL]/catalog/products/{product_id}/modifiers/{modifier_id}

Product Category Endpoints

Get Product including Categories: (GET)

[Base URL]/catalog/products/{product_id}?include_fields=categories

Create a Product Category: (POST)

[Base URL]/catalog/trees/categories

Update Product Category: (PUT)

[Base URL]/catalog/trees/categories/{{category_id}}

Delete a Category Tree: (DELETE)

[Base URL]/catalog/trees?id:in={id}

Product Options Endpoints

Get Product including Categories: (GET)

[Base URL]/catalog/products/{product_id}?include_fields=categories

Create a Product Option: (POST)

[Base URL]/catalog/products/{product_id}/options

Update Product Option: (PUT)

[Base URL]/catalog/products/{product_id}/options/{option_id}

Create a Product Option Value: (POST)

[Base URL]/catalog/products/{product_id}/options/{option_id}/values

Update a Product Option Value: (PUT)

[Base URL]/ catalog/products/{product_id}/options/{option_id}/values/{value_id}

Product Variant Endpoints

Create a Variant: (POST)

[Base URL]/catalog/products/{product_id}/variants

Update a Variant Including Inventory: (PUT)

[Base URL]/catalog/products/{product_id}/variants/{{variant_id}}

Create a Variant Option: (POST)

[Base URL]/catalog/products/{product_id}/options

Update a Variant Option: (PUT)

[Base URL]/catalog/products/{product_id}/options/{option_id}

Transaction Endpoints

Get a Quote: (GET)

[Base URL]/rfq/{quote_id}

Get an Order: (GET)

[Base URL]/stores/{STORE_HASH}/v2/orders/{order_id}

Get an Order with Refund Details: (GET)

[Base URL]/orders/payment_actions/refunds?id:in={id}

Create a new Transaction: (POST)

[Base URL]/stores/{STORE_HASH}/v2/orders

Update a Transaction: (PUT)

[Base URL]/stores/{STORE_HASH}/v2/orders/{order_id}

Delete a Transaction: (DELETE)

[Base URL]/stores/{STORE_HASH}/v2/orders/{id}

Get a Transaction Address: (GET)

[Base URL]stores/{STORE_HASH}/v2/orders/{order_id}/shipping_addresses/{id}

Get a Transaction Discount: (GET)

[Base URL]/stores/{STORE_HASH}/v2/orders/{order_id}/coupons

Get a Transaction Note: (GET)

[Base URL]/stores/{STORE_HASH}/v2/orders/{order_id}/messages/{{{message_id}}

Get a Transaction Payment: (GET)

[Base URL]/orders/{order_id}/transactions

Get a Transaction Tax: (GET)

[Base URL]/stores/{STORE_HASH}/v2/orders/{order_id}/taxes

Get a Transaction Payment: (GET)

[Base URL]/orders/{order_id}/transactions

Get a Transaction Tracking Number: (GET)

[Base URL]/stores/{STORE_HASH}/v2/orders/{order_id}/shipments/{id}

Create a Shipment: (POST)

[Base URL]/stores/{STORE_HASH}/v2/orders/{order_id}/shipments

Webhook Endpoints

Get a Webhook: (GET)

[Base URL]/stores/{STORE_HASH}/v2/hooks/{id}

Create a Webhook: (POST)

[Base URL]/stores/{STORE_HASH}/v2/hooks

Update a Webhook: (PUT)

[Base URL]/stores/{STORE_HASH}/v2/hooks/{id}
Related Articles
BigCommerce Endpoints
Dotdigital API Endpoints
Zoho CRM API Endpoints
Zoho Commerce API Endpoints
Avalara CertCapture API Endpoints
Did this answer your question?