| AdjustmentAmountScope |
- Type
- picklist
- Properties
- Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
- Description
- Scope of the adjustment amount for a promotion.
- Possible values are:
-
Total—The amount off the total
price.
- This field is available in API version 54.0 and later.
|
| AdjustmentBasisReferenceId |
- Type
- picklist
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- Coupon code of the coupon associated with a promotion. This field is available in API
version 54.0 and later.
- This is a relationship field.
- Relationship Name
- AdjustmentBasisReference
- Relationship Type
- Lookup
- Refers To
- Coupon
|
| AdjustmentSource |
- Type
- picklist
- Properties
- Create, Filter, Group, Restricted picklist, Sort, Update
- Description
- Price adjustment type.
- Possible values are:
- Discretionary
- Promotion
- System
|
| AdjustmentTargetType |
- Type
- picklist
- Properties
- Create, Filter, Group, Restricted picklist, Sort, Update
- Description
- Target for the price adjustment (the cart itself or individual items).
- Possible values are:
|
| AdjustmentType |
- Type
- picklist
- Properties
- Create, Filter, Group, Restricted picklist, Sort, Update
- Description
- Indicates if the price adjustment is applied as percentage or an absolute amount.
- Possible values are:
- AdjustmentAmount
- AdjustmentPercentage
|
| AdjustmentValue |
- Type
- double
- Properties
- Create, Filter, Sort, Update
- Description
- Numeric value of the adjustment (for example, 10 if the price adjustment is either 10%
off or $10 off).
|
| CartId |
- Type
- reference
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- The ID of the WebCart that’s associated with a cart item. This field is available in
API version 55.0 and later.
- This is a relationship field.
- Relationship Name
- Cart
- Relationship Type
- Lookup
- Refers To
- WebCart
|
| CartItemId |
- Type
- reference
- Properties
- Create, Filter, Group, Sort
- Description
- ID of the parent cart item to which this adjustment belongs.
- This is a relationship field.
- Relationship Name
- CartItem
- Relationship Type
- Lookup
- Refers To
- CartItem
|
| CurrencyIsoCode |
- Type
- picklist
- Properties
- Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort,
Update
- Description
- The ISO code for the currency that’s specified on the buyer’s account. Default value
is USD.
- Possible values are:
|
| Description |
- Type
- textarea
- Properties
- Create, Nillable, Update
- Description
- Description of the price adjustment.
|
| Name |
- Type
- string
- Properties
- Create, Filter, Group, idLookup, Sort, Update
- Description
- Name of the price adjustment.
|
| PriceAdjustmentCauseId |
- Type
- reference
- Properties
- Create, Filter, Group, Sort, Nillable, Update
- Description
- ID of entity that caused this adjustment (for example, a promotion ID). If
unspecified, then Description populates the display name.
- This is a relationship field.
- Relationship Name
- PriceAdjustmentCause
- Relationship Type
- Lookup
- Refers To
- Promotion
|
| Priority |
- Type
- int
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- If there are multiple price adjustments, sequence in which the price adjustments are
applied.
|
| TotalAmount |
- Type
- currency
- Properties
- Create, Filter, Nillable, Sort, Update
- Description
- Total price after applying price adjustments.
|
| TotalGrossAmount |
- Type
- currency
- Properties
- Filter, Nillable, Sort
- Description
- The total gross amount (tax inclusive) after applying price adjustments. This field is
available in API version 55.0 and later.
|
| TotalNetAmount |
- Type
- currency
- Properties
- Filter, Nillable, Sort
- Description
- The total net amount (tax exclusive) after applying price adjustments. This field is
available in API version 55.0 and later.
|
| TotalTax |
- Type
- currency
- Properties
- Filter, Nillable, Sort
- Description
- Tax on the total adjusted price.
|
| WebCartAdjustmentGroupId |
- Type
- reference
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- ID of the cart’s adjustment group.
- This is a relationship field.
- Relationship Name
- WebCartAdjustmentGroup
- Relationship Type
- Lookup
- Refers To
- WebCartAdjustmentGroup
|
j