Skip to main content

Price Scope

When we start the Product registration process (POST/Products), it is necessary to define which will be the Price Scope to be used on ANYMARKET and, respectively, on the Marketplaces. On setting up Price and the update of it in our API, we will look at the following fields so that the Price Scope is defined:

  • priceFactor (number): Product price factor. It is used as a multiplier for the cost price of the product. Corresponds to the Markup field on the ANYMARKET screen.
  • calculatedPrice (boolean): Identifies whether the product will be priced automatically, based on Markup (Price Factor).
  • definitionPriceScope (string): Pricing scope definition. Defines the type of price chosen for the integration, being: SKU (Manual, I control the price by the SKU), SKU_MARKETPLACE (Manual, I control the price by the offer) or COST (Automatic, by the cost change)
  • price (number): Sell Price.
  • sellPrice (number): Price Per SKU (used when the price scope is "Manual, I control the price by the SKU")
  • discountPrice (number): Offer Price with a discount.

When the Categories are created, it is necessary to inform the price definitions in your registration. The priceFactor, calculatedPrice and definitionPriceScope fields will be present, which must be filled in the same way as their corresponding products.

warning

Warning!​

The price scope method set in the products will define how the product price updates for Marketplaces will be done. Check what kind of registration that best suits your business model.

Automatic - By COST​

In this price scope the price is defined through the cost price of the product multiplied by the base Markup (Price Factor), this calculation will result in its SELL price. The Product Sell Price can still be multiplied by the additional Markup (price factor) available in the Marketplace tab.

  • Example 1 Cost = R$: 50,00 | Markup = 1,0 | Product Sell Price = R$: 50,00

  • Example 2 Cost = R$: 50,00 | Markup = 2,0 | Product Sell Price = R$: 100,00

When registering a product with Automatic Price Scope, the price of the product must be controlled through the cost price and the markup (price factor) on the product. When the cost price or markup is updated, the base price as well as the "Price" and "Sell Price" of all product listings will be changed and automatically resubmitted to Marketplaces.

In the product's POST JSON, the calculatedPrice" field must be filled with the value true and the definitionPriceScope" field with the COST value. Within the SKU object, must be filled the field "price" that will receive the value of "Base Price".

“priceFactor”: 1.5 “calculatedPrice”: true “definitionPriceScope”: COST “price”: 1.00

Para o exemplo abaixo ficaria assim:

{
...
  "priceFactor": 1.5,
  "calculatedPrice": true,
  "definitionPriceScope": "COST",
  "price": 1.00,
...
}

Base Price Update​

The base price update can be done by changing the cost in the PUT request of stock in the "cost" field and then (if necessary) by changing the markup in the PUT request of the product in the "priceFactor" field, recalculating the base price from the cost multiplied by the markup.

To update the price in Automatic Price Scope, by changing the cost:

  1. Update the Product Cost (cost) through the endpoint PUT/stocks
  2. Perform Markup (Price Factor) Update (priceFactor) through the endpoint PUT/products/{id}
  3. Check the Base Price update.
warning

Warning!​

Any price changes in the SKU or PRODUCT endpoint will not reflect the value of the product and offer

Manual - I control the price by the Offer​

In this type of price scope calculation, the price is generated through each Marketplace, and there may be price differentiation (FROM - TO) and also different prices for each Marketplace, to accompany marketplace commission or even set a different price if you wish.

  • Example 1 Amazon: Price From R$: 50,00 | For R$: 30,00

  • Example 2 Shopee: Price From R$: 55,00 | For R$: 35,00

When registering a product with Manual Pricing by Offer, the price of the product must be controlled through the product's offers. When the cost price or markup (price factor) is updated, the base price of the product will change, but the value will not be sent to publications you have for Marketplaces.

In the product's POST JSON, the field "calculatedPrice" must be sent with the value false and the field "definitionPriceScope" with the value "SKU_MARKETPLACE" and, inside the SKU object, the "price" field must be sent, which will receive the value of "Base Price".

{
...
  "calculatedPrice": true,
  "definitionPriceScope": "SKU_MARKETPLACE",
  "price": 1.00,
...
}

Base Price Update​

  1. Update the Product Cost (cost) through the endpoint PUT/stocks
  2. Perform Markup (Price Factor) Update (priceFactor) through the endpoint PUT/products/{id}
  3. Check the Base Price update.

Offer Price Update​

To udpate a new price value for the offers, use the SKU MARKETPLACE API or the Marketplaces page within the products page, changing the values of the "Price From" (price) fields and "Price To" (sell price).

Offers Price Update via SKU MARKETPLACE API​

To submit a new price value for the offers, use the SKU MARKETPLACE API endpoint or the Marketplaces page within the products page, changing the values of the "Price From" and "Price To".

Perform a GET request on the /skus/marketplaces API endpoint

  1. Use PartnerId as parameter.
  2. Check all the offers of that SKU.
  3. Keep/Save the offers IDs of that SKU.

Perform a PUT request on the /skus/marketplaces/prices API endpoint

  1. Updating Price From (price) and Price To (discountPrice) information for an offer list.
  2. You will need to inform:

  • id (integer): ANYMARKET offer ID;

  • price (number): Offer Price;

  • discountPrice (number): Offer sell price;

When updating the price of an offer list, the discount amount and additional markup (price factor) for each offer are automatically calculated.

warning

Warning!​

If a Pricing API is implemented, the Pricing will be consulted in the Integration when creating the offer.

Manual - I control the price by SKU​

In this type of Price Scope calculation, the price of offers is set in the SKU, that is, all publications/offers of the same product will have the same value.

With this pricing setup, the fields "Price From" and "Price To" are the only fields that define the price of offers and the same price will be applied across all Marketplaces. That is, any change in the Cost value via the API or the Stock and Markup (price Factor) page via the API or the Product page will NOT change the price of offers on Marketplaces.

Using the Product API, in the POST or PUT JSON, the field "calculatedPrice" must be sent with the value false and the field "definitionPriceScope" with the value "SKU", and within the SKU object, the field "price" must be sent, which will receive the value of "Price From" and the field "sellPrice" that will receive the value for the "Price To".

{
...
  "calculatedPrice": true,
  "definitionPriceScope": "SKU",
...
"skus": [
    {
      ...
      "price": 1.50,
      "sellPrice": 1.00,
      ...
}

Any changes to the "Price From" and "Price To" on the product will be automatically sent to Marketplaces that have active offers.

Offers Price Update via SKU API endpoint​

Using the SKU API endpoint (/products/{productId}/skus/{skuId}) submit a new Price, or 'Price From' (price) and 'Price To' (sell price) value for the SKU.

warning

Warning!​

After choosing your Price Scope Calculation, remember that each Price type must be updated by its specific API.

  • Automatic by Cost – Put/Stocks = Cost update;
  • Manual by Offer – Put/SkuMarketplaces/Prices = update a list of Offers;
  • Manual by SKU - Put/Products/Skus = SKU price update;