PriceAdjustmentLimits resource (Shop API 23.2)

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/v23_2/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

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/v23_2/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" : "23.2",
   "_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"
      }
   ]
}