afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/CartItemPriceAdjustment.json

{
  "sections": [
    "title",
    "description",
    "fields",
    "special_access_rules",
    "associated_objects",
    "field_reference"
  ],
  "title": "CartItemPriceAdjustment - Data API",
  "description": "Price adjustment for a cart item. This object is available in API version 52.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "relationship_name",
    "relationship_type",
    "refers_to"
  ],
  "fields": {
    "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: Cart Item"
    },
    "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: EUR—Euro USD—U.S. Dollar"
    },
    "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"
    }
  },
  "special_access_rules": "The CartItemPriceAdjustment object is available only if the B2B Commerce or D2C Commerce license is enabled.",
  "associated_objects": "This object has the following associated objects. Unless it’s noted, associated objects are available in the same API version as this object.\n\n- **CartItemPriceAdjustmentChangeEvent (API version 58.0)**: Change events are available for the object.",
  "field_reference": {
    "AdjustmentAmountScope": {
      "field_label": "Adjustment Amount Scope",
      "type": "picklist",
      "length": "255"
    },
    "AdjustmentBasisReferenceId": {
      "field_label": "Coupon ID",
      "type": "reference",
      "length": "18"
    },
    "AdjustmentSource": {
      "field_label": "Adjustment Source",
      "type": "picklist",
      "length": "255"
    },
    "AdjustmentTargetType": {
      "field_label": "Target Type for the Adjustment",
      "type": "picklist",
      "length": "255"
    },
    "AdjustmentType": {
      "field_label": "Adjustment Type",
      "type": "picklist",
      "length": "255"
    },
    "AdjustmentValue": {
      "field_label": "Adjustment Value",
      "type": "double",
      "precision": "18",
      "scale": "2"
    },
    "CartId": {
      "field_label": "Cart ID",
      "type": "reference",
      "length": "18"
    },
    "CartItemId": {
      "field_label": "Cart Item ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedById": {
      "field_label": "Created By ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedDate": {
      "field_label": "Created Date",
      "type": "datetime"
    },
    "CurrencyIsoCode": {
      "field_label": "Currency ISO Code",
      "type": "picklist",
      "length": "3"
    },
    "Description": {
      "field_label": "Description",
      "type": "textarea",
      "length": "32000"
    },
    "Id": {
      "field_label": "Cart Item Price Adjustment ID",
      "type": "id",
      "length": "18"
    },
    "IsDeleted": {
      "field_label": "Deleted",
      "type": "boolean"
    },
    "LastModifiedById": {
      "field_label": "Last Modified By ID",
      "type": "reference",
      "length": "18"
    },
    "LastModifiedDate": {
      "field_label": "Last Modified Date",
      "type": "datetime"
    },
    "Name": {
      "field_label": "Cart Item Price Adjustment Name",
      "type": "string",
      "length": "255"
    },
    "PriceAdjustmentCauseId": {
      "field_label": "Promotion ID",
      "type": "reference",
      "length": "18"
    },
    "Priority": {
      "field_label": "Priority Order for Adjustments",
      "type": "int",
      "digits": "9"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    },
    "TotalAmount": {
      "field_label": "Total Amount",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "TotalGrossAmount": {
      "field_label": "Total Gross Amount",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "TotalNetAmount": {
      "field_label": "Total Net Amount",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "TotalTax": {
      "field_label": "Total Tax",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "WebCartAdjustmentGroupId": {
      "field_label": "Cart Adjustment Group ID",
      "type": "reference",
      "length": "18"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length",
    "precision",
    "scale",
    "digits"
  ]
}