PUT /pricelists/{price_list_id}/records

Creates or updates Price List Records.

Required Fields

Notes

Servers

Path parameters

Name Type Required Description
price_list_id Integer Yes

The ID of the Price List requested.

Request headers

Name Type Required Description
Accept String Yes

The MIME type of the response body.

Default value: "application/json"

Content-Type String Yes

The MIME type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
[] Array Yes
[].map_price Number No

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.

[].price Number No

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

[].retail_price Number No

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.

[].sku String No

The SKU code associated with this Price Record if requested and it exists.

[].sale_price Number No

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.

[].variant_id Integer No

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

[].currency String No

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

[].bulk_pricing_tiers[] Array No
[].bulk_pricing_tiers[].amount Number No

The price adjustment amount. This value along with the type will decide the price per variant for the pricing tier.

[].bulk_pricing_tiers[].type String No

The type of adjustment that is made. Acceptable values: price – the adjustment amount per product; percent – the adjustment as a percentage of the original price; fixed – the adjusted absolute price of the product.

Possible values:

  • "fixed"
  • "price"
  • "percent"
[].bulk_pricing_tiers[].quantity_min Integer No

The minimum quantity of associated variant in the cart needed to qualify for the pricing of this tier.

[].bulk_pricing_tiers[].quantity_max Integer No

The maximum allowed quantity of associated variant in the cart to qualify for the pricing of this tier.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.