Update adjustments by identifier

patch

https://rls.congacloud.com/api/cart/v1/carts/{cartId}/adjustments/{adjustmentId}

Update the adjustment fields for the cart and adjustment IDs given in the parameters.

Required Fields:

cartId (route) - required
adjustmentId (route) - required
adjustmentLineItem (body) - required

Behavior

A null body returns 400 Bad Request.
Updates the single manual adjustment identified by adjustmentId and re-prices asynchronously (202 Accepted while processing).
Access to the product configuration is enforced by the configuration access filter (403 Forbidden when not permitted).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

cartId

string

required

The cart's unique identifier

adjustmentId

string

required

The ID of adjustment

Body Params

The adjustment line item

AdjustmentType

string | null

Adjustment type.

AdjustmentAmount

double | null

Adjustment amount.

AdjustmentAppliesTo

string | null

Adjustment applies to.

LineItem

object

LineNumber

int32

Line number.

LineType

string | null

Line type.

AdjustmentUom

string | null

Adjustment uom.

PerUnitValue

double | null

Per unit value.

GrossValue

double | null

Gross value.

AdjustmentName

string | null

Adjustment name.

Sequence

int32 | null

Sequence.

OverwrittenPerUnitValue

double | null

Overwritten per unit value.

OverwrittenGrossValue

double | null

Overwritten gross value.

IsOverrideByUnitAdjustment

boolean | null

Is override by unit adjustment.

IsOverrideByAdjustment

boolean | null

Is override by adjustment.

PricePoint

string | null

Price point.

Type

string | null

Type.

SubType

string | null

Sub type.

UnitAdjustment

double | null

Unit adjustment.

IncentiveAdjustmentAmount

double | null

Incentive adjustment amount.

AutoApply

boolean | null

Auto apply.

IncentiveName

string | null

Incentive name.

Description

string | null

Description.

ExpirationDate

date-time | null

Expiration date.

Incentive

object

IncentiveRuleEntry

object

IncentiveCode

string | null

Incentive code.

CouponCode

string | null

Coupon code.

BenefitQuantity

double | null

Benefit quantity.

Bucket

string | null

Bucket.

PriceRuleEntry

object

PriceRule

object

PriceRuleSet

object

PriceMatrix

object

PriceMatrixEntry

object

WaterfallRuleEntry

object

WaterfallRule

object

WaterfallRuleset

object

CreatedBy

object

CreatedDate

date-time | null

Created date.

string | null

Id.

ModifiedBy

object

ModifiedDate

date-time | null

Modified date.

Name

string | null

Name.

Currency

string | null

Currency.

Digest

string | null

Digest.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

200

Adjustment updated successfully.

202

Adjustment update accepted and is being processed.

500

An unexpected error occurred while updating the adjustment.

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

400The adjustment body is null.

403Access to the product configuration is not permitted.