Get Price Adjustment

1 min

POST

https://api.upstartcommerce.com/v1/promotion/priceadjustments

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

Authorized permissions:

promotion.read

Authorized roles:

customer.default
customer.anonymous

Header Parameters

x-upstart-tenantstringrequired
Description
Tenant identifier associated with the site this call is for.
x-upstart-sitestringrequired
Description
The site identifier.

Body Parameters

bodyCartPromotionRequestrequired
Description
The cart to evaluate promotions against and return price adjustments for.
- couponIdsstring[]
  Description
  Unique identifier for coupon (coupon code).
- currencystringrequired
- idstring<uuid>required
  Format
  uuid
- itemsCartItem[]required
  Description
  A cart line the promotion engine evaluates: its catalog item, SKU, quantity and shipment.
  - catalogItemIdstringrequired
    Description
    Unique identifier for item.
  - idstring<uuid>required
    Format
    uuid
  - quantityinteger<int32>required
    Format
    int32
  - productItemSkuIdstringrequired
  - promotionIdstring
    Description
    Unique identifier for promotion.
  - shipmentIdstring<uuid>
    Example
    A9CA1B7E-7BDE-4285-937E-B81A38DEAEEC
    Description
    Unique identifier for shipment Id.
    Format
    uuid
  - pricingCartItemPricingrequired
    Description
    The price breakdown for a cart item: its base price plus any promotion adjustments.
    - basePriceBasePricerequired
      Description
      The base price for a zone, with its list price, before promotions are applied.
      - listPricenumber
      - pricenumberrequired
      - typestringrequired
      - zonestringrequired
    - promotionPriceAdjustmentsPromotionPriceAdjustment[]required
      Description
      A promotion applied to a price, with the value it adjusts by and its tax code.
      - descriptionstring
      - idstringrequired
      - namestring
      - valuenumberrequired
      - taxCodestring
        Description
        Tax code used in cart tax calculations.
- locationIdstringrequired
  Description
  Unique identifier for location.
- pricenumber
  Example
  73.89
- timezoneIdstring
  Example
  America/Denver
  Description
  Timezone id (tz database). If not specified - tenant's default timezone is used.
- cartShipmentsCartShipment[]
  Description
  This is the structure of a single bucket of cart items bundled into a single shipping method.
  - idstring<uuid>required
    Example
    A9CA1B7E-7BDE-4285-937E-B81A38DEAEEC
    Description
    Unique identifier for the shipment.
    Format
    uuid
  - shippingMethodIdstring<uuid>required
    Example
    537ED6DF-9DE2-47DE-8C0C-A47022B6F940
    Description
    Unique identifier for the shipping method used to generate this rate set.
    Format
    uuid
  - pricingobjectrequired
    Description
    A breakdown of costs associated with the shipping.
    - basePricenumber
      Example
      199.99
      Description
      The cost of this shipment prior to discounts and taxes.
    - promotionPriceAdjustmentsPromotionPriceAdjustment[]
      Description
      This represents any promotional discounts associated with this shipment.
      - descriptionstring
      - idstringrequired
      - namestring
      - valuenumberrequired
      - taxCodestring
        Description
        Tax code used in cart tax calculations.
    - taxPriceAdjustmentTaxPriceAdjustment
      Description
      A tax applied to a price, with the tax code it was calculated under.
      - taxCodestringrequired
      - valuenumber

Responses

200

Success-price adjustment calculated and returned.

CartPromotionResponse
Description
The result of evaluating promotions against a cart, with the adjustments applied to items and shipments.
- couponsCartCoupon[]required
  Description
  A coupon on a cart, recording whether it was applied and the outcome of applying it.
  - appliedbooleanrequired
    Example
    true
  - applyStatusstring
  - idstringrequired
    Description
    Unique identifier for coupon.
  - promotionIdstring
    Description
    Unique identifier for promotion.
- currencystringrequired
- idstring<uuid>required
  Description
  Unique identifier for promotion.
  Format
  uuid
- itemsCartItem[]required
  Description
  A cart line the promotion engine evaluates: its catalog item, SKU, quantity and shipment.
  - catalogItemIdstringrequired
    Description
    Unique identifier for item.
  - idstring<uuid>required
    Format
    uuid
  - quantityinteger<int32>required
    Format
    int32
  - productItemSkuIdstringrequired
  - promotionIdstring
    Description
    Unique identifier for promotion.
  - shipmentIdstring<uuid>
    Example
    A9CA1B7E-7BDE-4285-937E-B81A38DEAEEC
    Description
    Unique identifier for shipment Id.
    Format
    uuid
  - pricingCartItemPricingrequired
    Description
    The price breakdown for a cart item: its base price plus any promotion adjustments.
    - basePriceBasePricerequired
      Description
      The base price for a zone, with its list price, before promotions are applied.
      - listPricenumber
      - pricenumberrequired
      - typestringrequired
      - zonestringrequired
    - promotionPriceAdjustmentsPromotionPriceAdjustment[]required
      Description
      A promotion applied to a price, with the value it adjusts by and its tax code.
      - descriptionstring
      - idstringrequired
      - namestring
      - valuenumberrequired
      - taxCodestring
        Description
        Tax code used in cart tax calculations.
- promotionPriceAdjustmentsCartPromotionPriceAdjustment[]required
  Description
  A cart-level promotion adjustment, with the value it applies and the items it covers.
  - descriptionstring
  - idstringrequired
  - namestring
  - valuenumberrequired
  - itemIdsstring[]required
  - taxCodestring
    Description
    Tax code used in cart tax calculations.
- cartShipmentsCartShipment[]
  Description
  This is the structure of a single bucket of cart items bundled into a single shipping method.
  - idstring<uuid>required
    Example
    A9CA1B7E-7BDE-4285-937E-B81A38DEAEEC
    Description
    Unique identifier for the shipment.
    Format
    uuid
  - shippingMethodIdstring<uuid>required
    Example
    537ED6DF-9DE2-47DE-8C0C-A47022B6F940
    Description
    Unique identifier for the shipping method used to generate this rate set.
    Format
    uuid
  - pricingobjectrequired
    Description
    A breakdown of costs associated with the shipping.
    - basePricenumber
      Example
      199.99
      Description
      The cost of this shipment prior to discounts and taxes.
    - promotionPriceAdjustmentsPromotionPriceAdjustment[]
      Description
      This represents any promotional discounts associated with this shipment.
      - descriptionstring
      - idstringrequired
      - namestring
      - valuenumberrequired
      - taxCodestring
        Description
        Tax code used in cart tax calculations.
    - taxPriceAdjustmentTaxPriceAdjustment
      Description
      A tax applied to a price, with the tax code it was calculated under.
      - taxCodestringrequired
      - valuenumber

400The request contained information that the server was unable to process. Appropriate errors are provided in the response body.

ValidationErrorResponse
Description
Error payload returned when a request fails validation, identifying the offending input by name, code and detail.
- namestringrequired
- codestringrequired
- detailstring

401The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.

ErrorResponse
Description
Standard error payload identifying a failure by name, code and detail, with an optional machine-readable reason.
- namestringrequired
- codestringrequired
- detailstringrequired
- reasonstring

curl

curl --request POST \
     --url https://api.upstartcommerce.com/v1/promotion/priceadjustments \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-upstart-tenant: string' \
     --header 'x-upstart-site: string' \
     --data '{
     "currency": "",
     "id": "",
     "items": [
     {
     "catalogItemId": "",
     "id": "",
     "quantity": "",
     "productItemSkuId": "",
     "pricing": {
     "basePrice": {
     "price": "",
     "type": "",
     "zone": ""
     },
     "promotionPriceAdjustments": [
     {
     "id": "",
     "value": ""
     }
     ]
     }
     }
     ],
     "locationId": "",
     "cartShipments": [
     {
     "id": "A9CA1B7E-7BDE-4285-937E-B81A38DEAEEC",
     "shippingMethodId": "537ED6DF-9DE2-47DE-8C0C-A47022B6F940",
     "pricing": {
     "promotionPriceAdjustments": [
     {
     "id": "",
     "value": ""
     }
     ],
     "taxPriceAdjustment": {
     "taxCode": ""
     }
     }
     }
     ]
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
myHeaders.append("x-upstart-tenant", "string");
myHeaders.append("x-upstart-site", "string");

var raw = JSON.stringify({
   "currency": "",
   "id": "",
   "items": [
      {
         "catalogItemId": "",
         "id": "",
         "quantity": "",
         "productItemSkuId": "",
         "pricing": {
            "basePrice": {
               "price": "",
               "type": "",
               "zone": ""
            },
            "promotionPriceAdjustments": [
               {
                  "id": "",
                  "value": ""
               }
            ]
         }
      }
   ],
   "locationId": "",
   "cartShipments": [
      {
         "id": "A9CA1B7E-7BDE-4285-937E-B81A38DEAEEC",
         "shippingMethodId": "537ED6DF-9DE2-47DE-8C0C-A47022B6F940",
         "pricing": {
            "promotionPriceAdjustments": [
               {
                  "id": "",
                  "value": ""
               }
            ],
            "taxPriceAdjustment": {
               "taxCode": ""
            }
         }
      }
   ]
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.upstartcommerce.com/v1/promotion/priceadjustments", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.upstartcommerce.com/v1/promotion/priceadjustments")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request["x-upstart-tenant"] = "string"
request["x-upstart-site"] = "string"
request.body = JSON.dump({
   "currency": "",
   "id": "",
   "items": [
      {
         "catalogItemId": "",
         "id": "",
         "quantity": "",
         "productItemSkuId": "",
         "pricing": {
            "basePrice": {
               "price": "",
               "type": "",
               "zone": ""
            },
            "promotionPriceAdjustments": [
               {
                  "id": "",
                  "value": ""
               }
            ]
         }
      }
   ],
   "locationId": "",
   "cartShipments": [
      {
         "id": "A9CA1B7E-7BDE-4285-937E-B81A38DEAEEC",
         "shippingMethodId": "537ED6DF-9DE2-47DE-8C0C-A47022B6F940",
         "pricing": {
            "promotionPriceAdjustments": [
               {
                  "id": "",
                  "value": ""
               }
            ],
            "taxPriceAdjustment": {
               "taxCode": ""
            }
         }
      }
   ]
})

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.upstartcommerce.com/v1/promotion/priceadjustments"

payload = json.dumps({
   "currency": "",
   "id": "",
   "items": [
      {
         "catalogItemId": "",
         "id": "",
         "quantity": "",
         "productItemSkuId": "",
         "pricing": {
            "basePrice": {
               "price": "",
               "type": "",
               "zone": ""
            },
            "promotionPriceAdjustments": [
               {
                  "id": "",
                  "value": ""
               }
            ]
         }
      }
   ],
   "locationId": "",
   "cartShipments": [
      {
         "id": "A9CA1B7E-7BDE-4285-937E-B81A38DEAEEC",
         "shippingMethodId": "537ED6DF-9DE2-47DE-8C0C-A47022B6F940",
         "pricing": {
            "promotionPriceAdjustments": [
               {
                  "id": "",
                  "value": ""
               }
            ],
            "taxPriceAdjustment": {
               "taxCode": ""
            }
         }
      }
   ]
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json',
   'x-upstart-tenant': 'string',
   'x-upstart-site': 'string'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

200

// Success-price adjustment calculated and returned.
{
  "coupons": [
    {
      "applied": true,
      "applyStatus": "",
      "id": "",
      "promotionId": ""
    }
  ],
  "currency": "",
  "id": "",
  "items": [
    {
      "catalogItemId": "",
      "id": "",
      "quantity": "",
      "productItemSkuId": "",
      "promotionId": "",
      "shipmentId": "A9CA1B7E-7BDE-4285-937E-B81A38DEAEEC",
      "pricing": {
        "basePrice": {
          "listPrice": 0,
          "price": 0,
          "type": "",
          "zone": ""
        },
        "promotionPriceAdjustments": [
          {
            "description": "",
            "id": "",
            "name": "",
            "value": 0,
            "taxCode": ""
          }
        ]
      }
    }
  ],
  "promotionPriceAdjustments": [
    {
      "description": "",
      "id": "",
      "name": "",
      "value": 0,
      "itemIds": [
        ""
      ],
      "taxCode": ""
    }
  ],
  "cartShipments": [
    {
      "id": "A9CA1B7E-7BDE-4285-937E-B81A38DEAEEC",
      "shippingMethodId": "537ED6DF-9DE2-47DE-8C0C-A47022B6F940",
      "pricing": {
        "basePrice": 199.99,
        "promotionPriceAdjustments": [
          {
            "description": "",
            "id": "",
            "name": "",
            "value": 0,
            "taxCode": ""
          }
        ],
        "taxPriceAdjustment": {
          "taxCode": "",
          "value": 0
        }
      }
    }
  ]
}

400

// The request contained information that the server was unable to process. Appropriate errors are provided in the response body.
{
  "name": "",
  "code": "",
  "detail": ""
}

401

// The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.
{
  "name": "",
  "code": "",
  "detail": "",
  "reason": ""
}