put

/pricelists/{price_list_id}/records

Creates or updates Price List Records.

Required Fields

  • currency

Notes

  • Bulk Updates is supported by this endpoint.
  • Bulk requests are limited to 100 items per request.
  • Only one bulk upsert can done at a time. Running more than one in parallel on the same store will cause a 429 error and the request will fail.

Authorization

apiKey - X-Auth-Client
apiKey - X-Auth-Token

Request Parameters

1 Path Parameter
3 Headers

Request Body

1 Example
Schema
array[object]
variant_id
integer

The variant with which this price set is associated. Either variant_id or sku is required.

1 validation
sku
string

The sku for the variant with which this price set is associated. Either sku or variant_id is required.

1 validation
currency
string

The 3-letter currency code with which this price set is associated.

2 validations
price
number

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

3 validations
sale_price
number

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.

1 validation
retail_price
number

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.

1 validation
map_price
number

The MAP (Manufacturer’s 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.

1 validation
bulk_pricing_tiers
array[object]

Responses

Success response for batch PUT of Price Records.

Schema
object

Empty object for Success case for Batch API.

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
2 path params not set
store_hash
price_list_id
$$.env
2 variables not set
X-Auth-Client
X-Auth-Token