PriceAdjustmentLimits resource (Shop API 20.4)

Summary

Http Method Resource Description
GET /price_adjustment_limits Returns a list of price adjustment limits for the authenticated user and the site defined in the URL.

At least one of the following functional permissions must be assigned to the user to be able to access it: Adjust_Item_Price or Adjust_Shipping_Price or Adjust_Order_Price.

Get price adjustment limits

Returns a list of price adjustment limits for the authenticated user and the site defined in the URL.

At least one of the following functional permissions must be assigned to the user to be able to access it: Adjust_Item_Price or Adjust_Shipping_Price or Adjust_Order_Price.

Url

GET https://hostname:port/dw/shop/v20_4/price_adjustment_limits

Formats

json, xml

Authentication

Name Description
JWT Authentication via Customer JWT. A valid user is required.
OAuth Authentication via OAuth token. A valid user is required.

Response Document

PriceAdjustmentLimits

Customization

This Resource supports server-side customization.

Extension Point Method Detail
dw.ocapi.shop.price_adjustment_limits.beforeGET

beforeGET () : Status

The function is called before the request will be processed.

Returns:
a non-null Status ends the hook execution
dw.ocapi.shop.price_adjustment_limits.modifyGETResponse

modifyGETResponse (priceAdjLimitResponse : PriceAdjustmentLimits ) : Status

Parameters:
priceAdjLimitResponse - the PriceAdjustmentLimit response object
Returns:
a non-null Status ends the hook execution

Sample

REQUEST:
GET /dw/shop/v20_4/price_adjustment_limits
Host: example.com
Accept: application/json

RESPONSE:
HTTP/1.1 200 OK
Content-Length: 749
Content-Type: application/json; charset=UTF-8
{
   "_v" : "20.4",
   "_type" : "price_adjustment_limits",
   "limits" : 
   [
      {
         "_type" : "price_adjustment_limit",
         "percent" : 20,
         "type" : "item"
      },
      {
         "_type" : "price_adjustment_limit",
         "percent" : 25,
         "type" : "order"
      },
      {
         "_type" : "price_adjustment_limit",
         "amount" : 60,
         "currency" : "USD",
         "percent" : 25,
         "type" : "order"
      }
   ]
}
OCAPI obsolete versions 13.x and 14.x will be end of life in 2020 and versions 15.x and 16.x in 2021. For dates and more information, see the OCAPI versioning and deprecation policy and this Knowledge Article.
X Privacy Update: We use cookies to make interactions with our websites and services easy and meaningful, to better understand how they are used. By continuing to use this site you are giving us your consent to do this. Privacy Policy.