--- title: Get Price Adjustment slug: api-documentation/get-price-adjustment docTags: createdAt: 2026-08-27T17:06:56.421Z --- { "id": "dIulre6-3yzwdNWc02zZU", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://api.upstartcommerce.com/v1/promotion/priceadjustments", "servers": [ { "url": "https://api.upstartcommerce.com/v1/promotion/priceadjustments" } ], "name": "Get Price Adjustment", "description": "

This endpoint returns the price adjustment required once a promotion has been applied.

\n

Authorized permissions:

\n\n

Authorized roles:

\n", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" }, { "kind": "required", "name": "x-upstart-tenant", "type": "string", "description": "Tenant identifier associated with the site this call is for." }, { "kind": "required", "name": "x-upstart-site", "type": "string", "description": "The site identifier." } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "", "customType": "CartPromotionRequest", "schema": [ { "name": "couponIds", "kind": "optional", "type": "array", "description": "

Unique identifier for coupon (coupon code).

", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "currency", "kind": "required", "type": "string", "description": "" }, { "name": "id", "kind": "required", "type": "string", "description": "", "format": "uuid" }, { "name": "items", "kind": "required", "type": "array", "description": "", "modelRef": "#/components/schemas/CartItem", "customType": "CartItem[]", "schema": [ { "name": "catalogItemId", "kind": "required", "type": "string", "description": "Unique identifier for item." }, { "name": "id", "kind": "required", "type": "string", "description": "", "format": "uuid" }, { "name": "quantity", "kind": "required", "type": "integer", "description": "", "format": "int32" }, { "name": "productItemSkuId", "kind": "required", "type": "string", "description": "" }, { "name": "promotionId", "kind": "optional", "type": "string", "description": "Unique identifier for promotion." }, { "name": "shipmentId", "kind": "optional", "type": "string", "description": "Unique identifier for shipment Id.", "example": "A9CA1B7E-7BDE-4285-937E-B81A38DEAEEC", "format": "uuid" }, { "name": "pricing", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/CartItemPricing", "customType": "CartItemPricing", "schema": [ { "name": "basePrice", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/BasePrice", "customType": "BasePrice", "schema": [ { "name": "listPrice", "kind": "optional", "type": "number", "description": "" }, { "name": "price", "kind": "required", "type": "number", "description": "" }, { "name": "type", "kind": "required", "type": "string", "description": "" }, { "name": "zone", "kind": "required", "type": "string", "description": "" } ] }, { "name": "promotionPriceAdjustments", "kind": "required", "type": "array", "description": "", "modelRef": "#/components/schemas/PromotionPriceAdjustment", "customType": "PromotionPriceAdjustment[]", "schema": [ { "name": "description", "kind": "optional", "type": "string", "description": "" }, { "name": "id", "kind": "required", "type": "string", "description": "" }, { "name": "name", "kind": "optional", "type": "string", "description": "" }, { "name": "value", "kind": "required", "type": "number", "description": "" }, { "name": "taxCode", "kind": "optional", "type": "string", "description": "Tax code used in cart tax calculations." } ] } ] } ] }, { "name": "locationId", "kind": "required", "type": "string", "description": "Unique identifier for location." }, { "name": "price", "kind": "optional", "type": "number", "description": "", "example": 73.89 }, { "name": "timezoneId", "kind": "optional", "type": "string", "description": "

Timezone id (tz database). If not specified - tenant's default timezone is used.

", "example": "America/Denver" }, { "name": "cartShipments", "kind": "optional", "type": "array", "description": "This is the structure of a single bucket of cart items bundled into a single shipping method.", "modelRef": "#/components/schemas/CartShipment", "customType": "CartShipment[]", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique identifier for the shipment.", "example": "A9CA1B7E-7BDE-4285-937E-B81A38DEAEEC", "format": "uuid" }, { "name": "shippingMethodId", "kind": "required", "type": "string", "description": "Unique identifier for the shipping method used to generate this rate set.", "example": "537ED6DF-9DE2-47DE-8C0C-A47022B6F940", "format": "uuid" }, { "name": "pricing", "kind": "required", "type": "object", "description": "A breakdown of costs associated with the shipping.", "example": "", "schema": [ { "name": "basePrice", "kind": "optional", "type": "number", "description": "The cost of this shipment prior to discounts and taxes.", "example": 199.99 }, { "name": "promotionPriceAdjustments", "kind": "optional", "type": "array", "description": "This represents any promotional discounts associated with this shipment.", "modelRef": "#/components/schemas/PromotionPriceAdjustment", "customType": "PromotionPriceAdjustment[]", "schema": [ { "name": "description", "kind": "optional", "type": "string", "description": "" }, { "name": "id", "kind": "required", "type": "string", "description": "" }, { "name": "name", "kind": "optional", "type": "string", "description": "" }, { "name": "value", "kind": "required", "type": "number", "description": "" }, { "name": "taxCode", "kind": "optional", "type": "string", "description": "Tax code used in cart tax calculations." } ] }, { "name": "taxPriceAdjustment", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/TaxPriceAdjustment", "customType": "TaxPriceAdjustment", "schema": [ { "name": "taxCode", "kind": "required", "type": "string", "description": "" }, { "name": "value", "kind": "optional", "type": "number", "description": "" } ] } ] } ] } ], "modelRef": "#/components/schemas/CartPromotionRequest", "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "NoChannelPortalAccess", "name": "NoChannelPortalAccess", "kind": "optional", "type": "http", "description": "

This authentication is required for clients to interact with any of the management APIs. Similar to 'LoggedIn', it indicates that the user has actually logged into the system, but in this case with a management role.

", "scheme": "bearer" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "

Success-price adjustment calculated and returned.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "CartPromotionResponse", "schema": [ { "name": "coupons", "kind": "required", "type": "array", "description": "", "modelRef": "#/components/schemas/CartCoupon", "customType": "CartCoupon[]", "schema": [ { "name": "applied", "kind": "required", "type": "boolean", "description": "", "example": true }, { "name": "applyStatus", "kind": "optional", "type": "string", "description": "" }, { "name": "id", "kind": "required", "type": "string", "description": "Unique identifier for coupon." }, { "name": "promotionId", "kind": "optional", "type": "string", "description": "Unique identifier for promotion." } ] }, { "name": "currency", "kind": "required", "type": "string", "description": "" }, { "name": "id", "kind": "required", "type": "string", "description": "Unique identifier for promotion.", "format": "uuid" }, { "name": "items", "kind": "required", "type": "array", "description": "", "modelRef": "#/components/schemas/CartItem", "customType": "CartItem[]", "schema": [ { "name": "catalogItemId", "kind": "required", "type": "string", "description": "Unique identifier for item." }, { "name": "id", "kind": "required", "type": "string", "description": "", "format": "uuid" }, { "name": "quantity", "kind": "required", "type": "integer", "description": "", "format": "int32" }, { "name": "productItemSkuId", "kind": "required", "type": "string", "description": "" }, { "name": "promotionId", "kind": "optional", "type": "string", "description": "Unique identifier for promotion." }, { "name": "shipmentId", "kind": "optional", "type": "string", "description": "Unique identifier for shipment Id.", "example": "A9CA1B7E-7BDE-4285-937E-B81A38DEAEEC", "format": "uuid" }, { "name": "pricing", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/CartItemPricing", "customType": "CartItemPricing", "schema": [ { "name": "basePrice", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/BasePrice", "customType": "BasePrice", "schema": [ { "name": "listPrice", "kind": "optional", "type": "number", "description": "" }, { "name": "price", "kind": "required", "type": "number", "description": "" }, { "name": "type", "kind": "required", "type": "string", "description": "" }, { "name": "zone", "kind": "required", "type": "string", "description": "" } ] }, { "name": "promotionPriceAdjustments", "kind": "required", "type": "array", "description": "", "modelRef": "#/components/schemas/PromotionPriceAdjustment", "customType": "PromotionPriceAdjustment[]", "schema": [ { "name": "description", "kind": "optional", "type": "string", "description": "" }, { "name": "id", "kind": "required", "type": "string", "description": "" }, { "name": "name", "kind": "optional", "type": "string", "description": "" }, { "name": "value", "kind": "required", "type": "number", "description": "" }, { "name": "taxCode", "kind": "optional", "type": "string", "description": "Tax code used in cart tax calculations." } ] } ] } ] }, { "name": "promotionPriceAdjustments", "kind": "required", "type": "array", "description": "", "modelRef": "#/components/schemas/CartPromotionPriceAdjustment", "customType": "CartPromotionPriceAdjustment[]", "schema": [ { "name": "description", "kind": "optional", "type": "string", "description": "" }, { "name": "id", "kind": "required", "type": "string", "description": "" }, { "name": "name", "kind": "optional", "type": "string", "description": "" }, { "name": "value", "kind": "required", "type": "number", "description": "" }, { "name": "itemIds", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "taxCode", "kind": "optional", "type": "string", "description": "Tax code used in cart tax calculations." } ] }, { "name": "cartShipments", "kind": "optional", "type": "array", "description": "This is the structure of a single bucket of cart items bundled into a single shipping method.", "modelRef": "#/components/schemas/CartShipment", "customType": "CartShipment[]", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique identifier for the shipment.", "example": "A9CA1B7E-7BDE-4285-937E-B81A38DEAEEC", "format": "uuid" }, { "name": "shippingMethodId", "kind": "required", "type": "string", "description": "Unique identifier for the shipping method used to generate this rate set.", "example": "537ED6DF-9DE2-47DE-8C0C-A47022B6F940", "format": "uuid" }, { "name": "pricing", "kind": "required", "type": "object", "description": "A breakdown of costs associated with the shipping.", "example": "", "schema": [ { "name": "basePrice", "kind": "optional", "type": "number", "description": "The cost of this shipment prior to discounts and taxes.", "example": 199.99 }, { "name": "promotionPriceAdjustments", "kind": "optional", "type": "array", "description": "This represents any promotional discounts associated with this shipment.", "modelRef": "#/components/schemas/PromotionPriceAdjustment", "customType": "PromotionPriceAdjustment[]", "schema": [ { "name": "description", "kind": "optional", "type": "string", "description": "" }, { "name": "id", "kind": "required", "type": "string", "description": "" }, { "name": "name", "kind": "optional", "type": "string", "description": "" }, { "name": "value", "kind": "required", "type": "number", "description": "" }, { "name": "taxCode", "kind": "optional", "type": "string", "description": "Tax code used in cart tax calculations." } ] }, { "name": "taxPriceAdjustment", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/TaxPriceAdjustment", "customType": "TaxPriceAdjustment", "schema": [ { "name": "taxCode", "kind": "required", "type": "string", "description": "" }, { "name": "value", "kind": "optional", "type": "number", "description": "" } ] } ] } ] } ], "modelRef": "#/components/schemas/CartPromotionResponse", "isExpanded": true } ] }, { "statusCode": "400", "description": "The request contained information that the server was unable to process. Appropriate errors are provided in the response body.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ValidationErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/ValidationErrorResponse", "isExpanded": true } ] }, { "statusCode": "401", "description": "The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "required", "type": "string", "description": "" }, { "name": "reason", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "nj77kaRHzsP5Rpm-Sd_J1", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://api.upstartcommerce.com/v1/promotion/priceadjustments \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --header 'x-upstart-tenant: string' \\\n --header 'x-upstart-site: string' \\\n --data '{\n \"currency\": \"\",\n \"id\": \"\",\n \"items\": [\n {\n \"catalogItemId\": \"\",\n \"id\": \"\",\n \"quantity\": \"\",\n \"productItemSkuId\": \"\",\n \"pricing\": {\n \"basePrice\": {\n \"price\": \"\",\n \"type\": \"\",\n \"zone\": \"\"\n },\n \"promotionPriceAdjustments\": [\n {\n \"id\": \"\",\n \"value\": \"\"\n }\n ]\n }\n }\n ],\n \"locationId\": \"\",\n \"cartShipments\": [\n {\n \"id\": \"A9CA1B7E-7BDE-4285-937E-B81A38DEAEEC\",\n \"shippingMethodId\": \"537ED6DF-9DE2-47DE-8C0C-A47022B6F940\",\n \"pricing\": {\n \"promotionPriceAdjustments\": [\n {\n \"id\": \"\",\n \"value\": \"\"\n }\n ],\n \"taxPriceAdjustment\": {\n \"taxCode\": \"\"\n }\n }\n }\n ]\n }'" }, { "id": "9Nii7WPqZGuWqQ8SzHyf0", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\nmyHeaders.append(\"x-upstart-tenant\", \"string\");\nmyHeaders.append(\"x-upstart-site\", \"string\");\n\nvar raw = JSON.stringify({\n \"currency\": \"\",\n \"id\": \"\",\n \"items\": [\n {\n \"catalogItemId\": \"\",\n \"id\": \"\",\n \"quantity\": \"\",\n \"productItemSkuId\": \"\",\n \"pricing\": {\n \"basePrice\": {\n \"price\": \"\",\n \"type\": \"\",\n \"zone\": \"\"\n },\n \"promotionPriceAdjustments\": [\n {\n \"id\": \"\",\n \"value\": \"\"\n }\n ]\n }\n }\n ],\n \"locationId\": \"\",\n \"cartShipments\": [\n {\n \"id\": \"A9CA1B7E-7BDE-4285-937E-B81A38DEAEEC\",\n \"shippingMethodId\": \"537ED6DF-9DE2-47DE-8C0C-A47022B6F940\",\n \"pricing\": {\n \"promotionPriceAdjustments\": [\n {\n \"id\": \"\",\n \"value\": \"\"\n }\n ],\n \"taxPriceAdjustment\": {\n \"taxCode\": \"\"\n }\n }\n }\n ]\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.upstartcommerce.com/v1/promotion/priceadjustments\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "sH-KIop0lRTXt4FZtwhG_", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.upstartcommerce.com/v1/promotion/priceadjustments\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest[\"x-upstart-tenant\"] = \"string\"\nrequest[\"x-upstart-site\"] = \"string\"\nrequest.body = JSON.dump({\n \"currency\": \"\",\n \"id\": \"\",\n \"items\": [\n {\n \"catalogItemId\": \"\",\n \"id\": \"\",\n \"quantity\": \"\",\n \"productItemSkuId\": \"\",\n \"pricing\": {\n \"basePrice\": {\n \"price\": \"\",\n \"type\": \"\",\n \"zone\": \"\"\n },\n \"promotionPriceAdjustments\": [\n {\n \"id\": \"\",\n \"value\": \"\"\n }\n ]\n }\n }\n ],\n \"locationId\": \"\",\n \"cartShipments\": [\n {\n \"id\": \"A9CA1B7E-7BDE-4285-937E-B81A38DEAEEC\",\n \"shippingMethodId\": \"537ED6DF-9DE2-47DE-8C0C-A47022B6F940\",\n \"pricing\": {\n \"promotionPriceAdjustments\": [\n {\n \"id\": \"\",\n \"value\": \"\"\n }\n ],\n \"taxPriceAdjustment\": {\n \"taxCode\": \"\"\n }\n }\n }\n ]\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "x3VDe9Ot2HJBj1XTBQ5RS", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.upstartcommerce.com/v1/promotion/priceadjustments\"\n\npayload = json.dumps({\n \"currency\": \"\",\n \"id\": \"\",\n \"items\": [\n {\n \"catalogItemId\": \"\",\n \"id\": \"\",\n \"quantity\": \"\",\n \"productItemSkuId\": \"\",\n \"pricing\": {\n \"basePrice\": {\n \"price\": \"\",\n \"type\": \"\",\n \"zone\": \"\"\n },\n \"promotionPriceAdjustments\": [\n {\n \"id\": \"\",\n \"value\": \"\"\n }\n ]\n }\n }\n ],\n \"locationId\": \"\",\n \"cartShipments\": [\n {\n \"id\": \"A9CA1B7E-7BDE-4285-937E-B81A38DEAEEC\",\n \"shippingMethodId\": \"537ED6DF-9DE2-47DE-8C0C-A47022B6F940\",\n \"pricing\": {\n \"promotionPriceAdjustments\": [\n {\n \"id\": \"\",\n \"value\": \"\"\n }\n ],\n \"taxPriceAdjustment\": {\n \"taxCode\": \"\"\n }\n }\n }\n ]\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json',\n 'x-upstart-tenant': 'string',\n 'x-upstart-site': 'string'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "nj77kaRHzsP5Rpm-Sd_J1" }, "results": { "languages": [ { "id": "IF8-RLgV9Jkrw5ttAs8d9", "language": "200", "code": "// Success-price adjustment calculated and returned.\n{\n \"coupons\": [\n {\n \"applied\": true,\n \"applyStatus\": \"\",\n \"id\": \"\",\n \"promotionId\": \"\"\n }\n ],\n \"currency\": \"\",\n \"id\": \"\",\n \"items\": [\n {\n \"catalogItemId\": \"\",\n \"id\": \"\",\n \"quantity\": \"\",\n \"productItemSkuId\": \"\",\n \"promotionId\": \"\",\n \"shipmentId\": \"A9CA1B7E-7BDE-4285-937E-B81A38DEAEEC\",\n \"pricing\": {\n \"basePrice\": {\n \"listPrice\": 0,\n \"price\": 0,\n \"type\": \"\",\n \"zone\": \"\"\n },\n \"promotionPriceAdjustments\": [\n {\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"value\": 0,\n \"taxCode\": \"\"\n }\n ]\n }\n }\n ],\n \"promotionPriceAdjustments\": [\n {\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"value\": 0,\n \"itemIds\": [\n \"\"\n ],\n \"taxCode\": \"\"\n }\n ],\n \"cartShipments\": [\n {\n \"id\": \"A9CA1B7E-7BDE-4285-937E-B81A38DEAEEC\",\n \"shippingMethodId\": \"537ED6DF-9DE2-47DE-8C0C-A47022B6F940\",\n \"pricing\": {\n \"basePrice\": 199.99,\n \"promotionPriceAdjustments\": [\n {\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"value\": 0,\n \"taxCode\": \"\"\n }\n ],\n \"taxPriceAdjustment\": {\n \"taxCode\": \"\",\n \"value\": 0\n }\n }\n }\n ]\n}" }, { "id": "Zropd_D-pxADFqjRUsr2Z", "language": "400", "code": "// The request contained information that the server was unable to process. Appropriate errors are provided in the response body.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\"\n}" }, { "id": "y9av8r7qJ9gHca5EgZTO8", "language": "401", "code": "// The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" } ], "selectedLanguageId": "IF8-RLgV9Jkrw5ttAs8d9" } }, "children": [ { "text": "" } ] }