Yep Platform logo
REST API · Yep Platform Technical documentation for certified integrations

Pricing

Base price, special price with date range and customer group pricing — with index consistency for promotions and countdown.

Base price Special Per group Lookup in 2026

Overview

Pricing flows were hardened for higher consistency on base, special and group prices. Changes to special_price trigger the selective reprocessing needed to keep the Countdown index coherent.

On top of the update endpoints, the /api2/price route now also serves a read-only lookup of a product price, with an explicit store and customer group context.

Product price lookup New

Read-only operation: it does not change prices, does not enqueue anything and does not trigger reindexing.

GET/api2/priceNew

Fetch the price of a product by SKU or ID, in the requested context.

Read-onlyNo queueNo reindex
GET /api2/price?id=3291&type=sku
Authorization: Bearer {access_token}
GET /api2/price?id=2074&type=id
Authorization: Bearer {access_token}
GET /api2/price?id=3291&type=sku&store_id=1&customer_group_id=0
Authorization: Bearer {access_token}

Parameters

id Required
Product ID or SKU, according to type.
type Required
Defines how id is interpreted: id or sku.
store_id Optional
Store used as the read context.
customer_group_id Optional
Customer group used as context. Defaults to 0.

Response example

{
  "success": true,
  "product_id": 2074,
  "sku": "3291",
  "type": "simple",
  "context": {
    "store_id": 1,
    "website_id": 1,
    "customer_group_id": 0,
    "store": {"id": 1, "code": "default", "name": "Português (Brasil)"},
    "website": {"id": 1, "code": "cafe", "name": "Main Website"},
    "customer_group": {"id": 0, "name": "Guest"}
  },
  "pricing": {
    "price": "28.9000",
    "special_price": "25.9000",
    "final_price": "25.9000",
    "currency": "BRL",
    "special_from_date": "2025-12-01",
    "special_to_date": null,
    "group_prices": [],
    "tier_prices": [],
    "tax_class_id": 0,
    "tax_class": {"id": 0, "name": "None"},
    "msrp_enabled": "use_config",
    "msrp_display_actual_price_type": "use_config",
    "msrp": null,
    "desconto_boleto": null
  }
}

Pricing concepts

price
Base price stored on the product.
special_price
Stored special price. It represents the configured value and may exist even when the promotion is not currently active.
final_price
Effective price available in the Yep Platform index for the requested context — considering website, customer group and active price rules, among other applicable data.
currency
Base currency used in the requested context.
special_from_date
special_to_date
Date range configured for the special price, in YYYY-MM-DD format. They return null when no value is set.
tax_class_id
tax_class
Product tax class. With no class assigned, it returns {"id": 0, "name": "None"}.
msrp_enabled
MAP/MSRP rule state. Normalized values: yes, no and use_config.
msrp_display_actual_price_type
How the actual price is displayed, according to the Yep Platform configuration.
desconto_boleto
Commercial value configured for the cash/bank-slip discount. It is provided separately and is not automatically folded into final_price.

Reading without reindexing

The lookup is read-only and does not force reindexing. Therefore final_price reflects the latest valid state of the platform indexes.

Group and tier prices

Entries in group_prices keep the original identifiers and add the readable entities whenever applicable.

{
  "website_id": 1,
  "website": {"id": 1, "code": "cafe", "name": "Main Website"},
  "customer_group_id": 3,
  "customer_group": {"id": 3, "name": "Group name"},
  "all_groups": false,
  "price": "25.0000"
}
When website_id=0 or the price applies to all groups, the matching object may be null, since there is no concrete entity to represent.

tier_prices carries the tiers based on quantity and/or group. Items may contain website_id, website, customer_group_id, customer_group, all_groups, qty and price.

Configurable products

configurable products may include the range available in the price index for the requested context.

{
  "min_final_price": "489.9000",
  "max_final_price": "489.9000"
}
The API neither sums nor infers prices from the associated products to build these values.

HTTP responses

ScenarioStatus
Success200
Invalid parameters400
Missing authentication or invalid token401
Not allowed403
Product not found404
Internal failure500
POST/api2/price/

Update the product base price.

{
  "type": "sku",
  "sku": "novo_produto",
  "price": 250.00
}
POST/api2/price/special

Update special price with date range.

{
  "type": "sku",
  "sku": "novo_produto",
  "special_price": 23233.99,
  "special_from_date": "2025-09-10",
  "special_to_date": "2025-10-01"
}
POST/api2/price/group

Update customer group prices.

{
  "type": "sku",
  "sku": "novo_produto",
  "group_prices": [
    {"cust_group": 2, "price": 533},
    {"cust_group": 1, "price": 350}
  ]
}

Operational note

When the batch involves special_price and related special dates, the pricing routine also performs the selective reprocessing needed to keep the Countdown index consistent.