Set Price List Record by Currency Code

PUT

https://api.bigcommerce.com/stores/:store_hash/v3/pricelists/:price_list_id/records/:variant_id/:currency_code

PUT

/stores/:store_hash/v3/pricelists/:price_list_id/records/:variant_id/:currency_code

curl -X PUT https://api.bigcommerce.com/stores/store_hash/v3/pricelists/1/records/1/currency_code \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "data": {
    "calculated_price": 10.99,
    "date_created": "2022-09-18T13:18:15Z",
    "date_modified": "2022-09-18T13:30:48Z",
    "product_id": 185,
    "price_list_id": 4,
    "variant_id": 356,
    "currency": "eur",
    "price": 12.99,
    "sale_price": 10.99,
    "retail_price": 15.99,
    "map_price": 17.99,
    "bulk_pricing_tiers": [
      {
        "quantity_min": 5,
        "quantity_max": 10,
        "type": "percent",
        "amount": 1
      },
      {
        "quantity_min": 11,
        "quantity_max": 20,
        "type": "percent",
        "amount": 2
      }
    ]
  },
  "meta": {}
}

Creates or updates a Price List Record using the currency code. Notes

Supports up to 40 simultaneous PUT requests. Running more than the allowed number of requests concurrently on the same store will result in a 429 status error, and your additional requests will fail.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Products	modify	`store_v2_products`
Products	read-only	`store_v2_products_read_only`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

Path parameters

price_list_idintegerRequired

The ID of the Price List requested.

variant_idintegerRequired

ID of the variant on a product, or on an associated Price List Record.

currency_codestringRequiredformat: "ISO-4217"

The currency code associated with the price record being acted upon.

store_hashstringRequired

Permanent ID of the BigCommerce store.

Request

Common Price Record properties.

pricedoubleOptional

The list price for the variant mapped in a Price List. Overrides any existing or Catalog list price for the variant/product.

sale_pricedoubleOptional

The sale price for the variant mapped in a Price List. Overrides any existing or Catalog sale price for the variant/product. If empty, the sale price will be treated as not being set on this variant.

retail_pricedoubleOptional

The retail price for the variant mapped in a Price List. Overrides any existing or Catalog retail price for the variant/product. If empty, the retail price will be treated as not being set on this variant.

map_pricedoubleOptional

The MAP (Minimum Advertised Price) for the variant mapped in a Price List. Overrides any existing or Catalog MAP price for the variant/product. If empty, the MAP price will be treated as not being set on this variant.

bulk_pricing_tierslist of objectsOptional

Response

dataobjectOptional

The Price Record object.

metaobjectOptional

Response metadata.

Errors

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error

429

Too Many Requests Error