On this page
  1. Calculated-price routes
  2. Record APIs
  3. Order item extension attributes
  4. After a write

REST and SOAP APIs

Price System Core provides calculated-price endpoints. Optional API packages add CRUD routes for the stored records owned by Customer Price, Price Lists, Category Price and Product-Customer Matrix.

Magento exposes the same service contracts through its normal REST and SOAP layers.

Calculated-price routes

Context One SKU Several SKUs
Integration or authorized admin POST /V1/pricesystem/get-final-price POST /V1/pricesystem/get-multi-price
Signed-in customer POST /V1/pricesystem/me/get-final-price POST /V1/pricesystem/me/get-multi-price
Current storefront context POST /V1/pricesystem/context/get-final-price POST /V1/pricesystem/context/get-multi-price

REST requests normally use /rest/V1/... or /rest/{storeCode}/V1/....

The me routes require a customer token and derive the customer from that token. The context routes use the current signed-in customer or the NOT LOGGED IN group. Do not send an arbitrary customer ID to either of those contexts.

Record APIs

Install only the package for the product an integration must manage:

  • mageb2b/pricesystem-customerprice-api
  • mageb2b/pricesystem-pricelist-api
  • mageb2b/pricesystem-categoryprice-api
  • mageb2b/pricesystem-productcustomermatrix-api

Each product guide lists its exact resources and routes. Use a Magento integration with only the ACL resources it needs rather than an administrator token embedded in application code.

Order item extension attributes

Order reads such as GET /V1/orders/:id expose two Price System extension attributes on each item:

Attribute Type Content
ps_discount_amount float Discount amount Price System recorded on the item
ps_applied_pricetype string Code of the price type that supplied the final price

The values are stored on the quote item during totals collection, copied to the order item and returned inside extension_attributes. They are read-only snapshots of the applied pricing, useful for order exports and ERP integrations.

The related customer attributes pricesystem_price and pricesystem_price_type are protected: writing them through custom_attributes is accepted only from admin and integration tokens, while customer and guest tokens are rejected. See Protected customer attributes for the shared mechanism.

After a write

Successful repository writes invalidate relevant Price System calculations. For a bulk integration, still verify one affected customer and SKU after the batch and monitor failed API responses before treating the synchronization as complete.

Display preferences

Adjust how this website is displayed. Changes apply immediately.

Text size
Text spacing
Reading aids

Follows the pointer. Move it with Alt + Up/Down outside input fields. Hidden while a dialog is open.

Uses the voices provided by your browser, which may use an online service. Reading starts only when you press Read aloud.

Your choices are saved in this browser for this website.