How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

BigCommerce Images API

The Images API from BigCommerce — 6 operation(s) for images.

BigCommerce Images API is one of 161 APIs that BigCommerce publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Image. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 11 operations across 6 paths, and defines 6 schemas. It is described by OpenAPI 3.0.0, at version 3.0.0.

Requests are made against a single base URL, https://api.bigcommerce.com/stores/{store_hash}/v3.

11 operations 6 paths 6 schemas 3 DELETE2 GET5 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
3.0.0
Base URL
https://api.example.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

BigCommerce Images API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Auth-Token (X-Auth-Token). By default, every request must be authenticated.

  • X-Auth-Token — OAuth scopes | UI Name | Permission | Parameter | |:--|:--|:-| | Information & Settings | read-only | storev2informationreadonly| | Information & Settings | mo…

Paths & Operations 11

Across 6 paths, the API surfaces 11 operations — 3 DELETE, 2 GET, 5 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Images 11
POST
/catalog/brands/{brand_id}/image
BigCommerce Create a Brand Image
createBrandImage 3 params body → 200400404422
DELETE
/catalog/brands/{brand_id}/image
BigCommerce Delete a Brand Image
deleteBrandImage 2 params → 204
POST
/catalog/categories/{category_id}/image
BigCommerce Create a Category Image
createCategoryImage 3 params body → 200400404422
DELETE
/catalog/categories/{category_id}/image
BigCommerce Delete a Category Image
deleteCategoryImage 2 params → 204
POST
/catalog/products/{product_id}/modifiers/{modifier_id}/values/{value_id}/image
BigCommerce Create Product Modifier Image
createProductModifierImage 7 params body → 200400404422
POST
/catalog/products/{product_id}/variants/{variant_id}/image
BigCommerce Create a Product Variant Image
createProductVariantImage 5 params body → 200400404422500
GET
/catalog/products/{product_id}/images
BigCommerce Get All Product Images
getProductImages 6 params → 200204404
POST
/catalog/products/{product_id}/images
BigCommerce Create a Product Image
createProductImage 3 params body → 200400404422
GET
/catalog/products/{product_id}/images/{image_id}
BigCommerce Get a Product Image
getProductImage 5 params → 200404
PUT
/catalog/products/{product_id}/images/{image_id}
BigCommerce Update a Product Image
updateProductImage 4 params body → 200201400404
DELETE
/catalog/products/{product_id}/images/{image_id}
BigCommerce Delete a Product Image
deleteProductImage 3 params → 204

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are pagination_Full (6 properties), productImage_Base (5 properties), metaCollection_Full (1 property). Each schema is shown below with its type and property counts.

productImage_Full
Common ProductImage properties.
metaEmpty_Full
object
Response metadata.
metaCollection_Full
object
Data about the response, including pagination and collection totals.
1 property
productImage_Put
The model for a PUT to update applicable Product Image fields.
productImage_Base
object
Common ProductImage properties.
5 properties
pagination_Full
object
Data about the response, including pagination and collection totals.
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bigcommerce-images-api-openapi.yml Raw ↑

Other APIs BigCommerce publishes across the network.

Big Commerce Inventory
Big Commerce Locations
Big Commerce Customer Segmentation
Big Commerce Promotions
Big Commerce Promotion Settings
Big Commerce Pickup Methods
Big Commerce Storefront Pickup Options
Big Commerce Transactions
BigCommerce Abandoned Cart Emails API
BigCommerce Abandoned Cart Settings API
BigCommerce Abandoned Carts API
BigCommerce Abandoned Carts Settings API
Where this information came from

This is an independent, third-party profile of BigCommerce Images API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.