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 Price Lists Records API

The Price Lists Records API from BigCommerce — 4 operation(s) for price lists records.

BigCommerce Price Lists Records 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 Price Lists Records. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 8 operations across 4 paths, and defines 9 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.

8 operations 4 paths 9 schemas 2 DELETE3 GET3 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 Price Lists Records 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 8

Across 4 paths, the API surfaces 8 operations — 2 DELETE, 3 GET, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Price Lists Records 8
PUT
/pricelists/records
BigCommerce Create Batch of Price Lists Records
upsertPriceListsRecords 1 param body → 200422
GET
/pricelists/{price_list_id}/records
BigCommerce Get All Price List Records
getPriceListRecords 32 params → 200429
PUT
/pricelists/{price_list_id}/records
BigCommerce Upsert Price List Records
upsertPriceListRecords 3 params body → 200422429
DELETE
/pricelists/{price_list_id}/records
BigCommerce Delete a Price List Record
deletePriceListRecords 3 params → 204
GET
/pricelists/{price_list_id}/records/{variant_id}
BigCommerce Get Price Records by Variant
getPriceListRecordsByVariantId 3 params → 200429
GET
/pricelists/{price_list_id}/records/{variant_id}/{currency_code}
BigCommerce Get a Price Record by Currency Code
getPriceListRecord 5 params → 200429
PUT
/pricelists/{price_list_id}/records/{variant_id}/{currency_code}
BigCommerce Set Price List Record by Currency Code
setPriceListRecord 5 params body → 200404409422429
DELETE
/pricelists/{price_list_id}/records/{variant_id}/{currency_code}
BigCommerce Delete a Price Record by Currency Code
deletePriceListRecord 4 params → 204

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are PriceRecordBase (5 properties), PriceRecordBatchItem (5 properties), BulkPricingTier (4 properties), PriceRecordBatchErrorResponse (2 properties). Each schema is shown below with its type and property counts.

PriceRecordIdentifiers
object
The Price Record object used in batch create or update.
BulkPricingTier
object
4 properties
PriceRecordBatchErrorResponse
object
Error during Price Record batch PUT. Includes data sent in the request and errors.
2 properties
PriceRecordBase
object
Common Price Record properties.
5 properties
SuccessBatchResponse
object
Empty object for Success case for Batch API.
2 properties
Meta
object
Response metadata.
PriceRecordBatchItem
object
5 properties
ErrorResponse
DetailedErrors
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bigcommerce-price-lists-records-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 Price Lists Records 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.