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

{
  "sections": [
    "title",
    "description",
    "fields",
    "special_access_rules",
    "field_reference"
  ],
  "title": "CartDeliveryGroupMethodAdj - Data API",
  "description": "Represents the shipping promotion discount for a shipping method. This object is available in API version 60.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "relationship_name",
    "refers_to",
    "relationship_type"
  ],
  "fields": {
    "AdjustmentAmount": {
      "type": "currency",
      "properties": "Create, Filter, Sort, Update",
      "description": "Amount subtracted from the price by the shipping promotion discount."
    },
    "AdjustmentBasisReferenceId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "ID of the adjustment basis reference. This is the coupon that causes the adjustment. This field is a relationship field. This field is available in API version 62.0 and later.",
      "relationship_name": "AdjustmentBasisReference",
      "refers_to": "Coupon"
    },
    "AdjustmentType": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
      "description": "Type of shipping promotion discount. Possible values are: AdjustmentAmount AdjustmentPercentage OverrideAmount"
    },
    "AdjustmentValue": {
      "type": "double",
      "properties": "Create, Filter, Sort, Update",
      "description": "Number representing the value of the price adjustment. For example, if the AdjustmentType is AdjustmentPercentage, a -10 AdjustmentValue means 10 percent off. If the AdjustmentType is AdjustmentAmount, a -10 AdjustmentValue means 10 dollars off."
    },
    "CartDeliveryGroupMethodId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Sort",
      "description": "ID of the cart delivery group method. This field is a relationship field.",
      "relationship_name": "CartDeliveryGroupMethod",
      "relationship_type": "Lookup",
      "refers_to": "CartDeliveryGroupMethod"
    },
    "CurrencyIsoCode": {
      "type": "picklist",
      "properties": "Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
      "description": "Currency ISO code of the cart. Possible values are: USD—U.S. Dollar The default value is USD."
    },
    "Name": {
      "type": "string",
      "properties": "Create, Filter, Group, idLookup, Sort, Update",
      "description": "Name of the cart delivery group method adjustment."
    },
    "PriceAdjustmentCauseId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Sort, Update",
      "description": "ID of the price adjustment cause. This field 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 promotional adjustments, the order in which the shipping promotion is applied."
    }
  },
  "special_access_rules": "The CartDeliveryGroupMethodAdj object is available only if the B2B Commerce or D2C Commerce license is enabled.",
  "field_reference": {
    "AdjustmentAmount": {
      "field_label": "Adjustment Amount",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "AdjustmentBasisReferenceId": {
      "field_label": "Coupon ID",
      "type": "reference",
      "length": "18"
    },
    "AdjustmentType": {
      "field_label": "Adjustment Type",
      "type": "picklist",
      "length": "255"
    },
    "AdjustmentValue": {
      "field_label": "Adjustment Value",
      "type": "double",
      "precision": "18",
      "scale": "0"
    },
    "CartDeliveryGroupMethodId": {
      "field_label": "Cart Delivery Group Method 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"
    },
    "Id": {
      "field_label": "Cart Delivery Group Method 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 Delivery Group Method Adjustment Name",
      "type": "string",
      "length": "255"
    },
    "PriceAdjustmentCauseId": {
      "field_label": "Promotion ID",
      "type": "reference",
      "length": "18"
    },
    "Priority": {
      "field_label": "Priority",
      "type": "int",
      "digits": "9"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "precision",
    "scale",
    "length",
    "digits"
  ]
}