Newer Version Available

This content describes an older version of this product. View Latest

CartDeliveryGroupMethodAdj

Represents the shipping promotion discount for a shipping method. This object is available in API version 60.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert()

Special Access Rules

The CartDeliveryGroupMethodAdj object is available only if the B2B Commerce or D2C Commerce license is enabled.

Fields

Field Details
AdjustmentAmount
Type
currency
Properties
Create, Filter, Sort, Update
Description
Amount subtracted from the price by the shipping promotion discount.
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.