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

{
  "sections": [
    "title",
    "description",
    "fields",
    "special_access_rules",
    "associated_objects",
    "field_reference"
  ],
  "title": "CartDeliveryGroup - Data API",
  "description": "Represents shipping information for the delivery of items in an order against a store built with B2B Commerce or D2C Commerce. This object is available in API version 49.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "relationship_name",
    "relationship_type",
    "refers_to"
  ],
  "fields": {
    "CartId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Sort",
      "description": "The ID the WebCart that’s associated with this delivery group."
    },
    "CompanyName": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "Company name associated with a delivery. This field is available in API version 59.0 and later."
    },
    "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: USD—U.S. Dollar"
    },
    "DeliverToAddress": {
      "type": "address",
      "properties": "Filter, Nillable",
      "description": "The address to which a buyer order is delivered."
    },
    "DeliverToCity": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The city to which a buyer order is delivered."
    },
    "DeliverToCountry": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The country to which a buyer order is delivered."
    },
    "DeliverToFirstName": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The first name of the person set to receive an order. This field is available in API version 57.0 and later."
    },
    "DeliverToGeocodeAccuracy": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
      "description": "The geocode location to which a buyer order is delivered. Possible values are: Address Block City County ExtendedZip NearAddress Neighborhood State Street Unknown Zip"
    },
    "DeliverToLastName": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The last name of the person to whom a buyer order is delivered. This field is available in API version 57.0 and later."
    },
    "DeliverToLatitude": {
      "type": "double",
      "properties": "Create, Filter, Nillable, Sort, Update",
      "description": "The latitude of a buyer delivery location."
    },
    "DeliverToLongitude": {
      "type": "double",
      "properties": "Create, Filter, Nillable, Sort, Update",
      "description": "The longitude of a buyer delivery location."
    },
    "DeliverToName": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The name of the person to deliver a buyer order to. This field is set based on the Name field of the ContactPointAddress associated with this delivery group. ContactPointAddress.Name is generated by the system using the first and last names entered by a buyer during checkout."
    },
    "DeliverToPostalCode": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The postal code to which to deliver a buyer order."
    },
    "DeliverToState": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The state to which to deliver a buyer order."
    },
    "DeliverToStreet": {
      "type": "textarea",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The street to which to deliver a buyer order."
    },
    "DeliveryMethodId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The ID for the delivery method to use to deliver a buyer order. Populated if the selected CartDeliveryGroupMethod only has the ShippingFee populated, but it has reference to an existing DeliveryMethodId which contains the fields Carrier, ClassOfService, and ReferenceNumber. If not, the SelectedDeliveryMethod field is used. This field is a relationship field. This field is deprecated in API version 64.0 and will be removed in API version 66.0. Instead, use the DeliveryMethodId field on the CartDeliveryGroupMethod object.",
      "relationship_name": "DeliveryMethod",
      "relationship_type": "Lookup",
      "refers_to": "OrderDeliveryMethod"
    },
    "DesiredDeliveryDate": {
      "type": "dateTime",
      "properties": "Create, Filter, Nillable, Sort, Update",
      "description": "The date that a buyer requests to have an order delivered."
    },
    "GiftMessage": {
      "type": "textarea",
      "properties": "Create, Nillable, Update",
      "description": "Personalized gift message for the order. This field is available in API version 64.0 and later."
    },
    "GiftToName": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The name of the recipient for a gift order. This field is available in API version 64.0 and later."
    },
    "GrandTotalAmount": {
      "type": "currency",
      "properties": "Filter, Nillable, Sort",
      "description": "Sum of all cart items’ TotalAmount, or CartDeliveryGroup TotalAmount plus CartDeliveryGroup TotalTaxAmount."
    },
    "IsDefault": {
      "type": "boolean",
      "properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
      "description": "Indicates if the delivery group is the default. This field is available in API version 59.0 and later. The default value is false. B2B and D2C stores create a default delivery group, along with a WebCart, when a customer adds an item to cart and doesn't have an existing cart. The default cart delivery group is needed to complete the checkout flow, and can't be replaced by a non-default cart delivery group. If you customize the standard checkout flow, make sure that you don't delete the default cart delivery group."
    },
    "IsGift": {
      "type": "boolean",
      "properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
      "description": "Indicates if the delivery group is a gift. This field is available in API version 64.0 and later. The default value is false."
    },
    "Name": {
      "type": "string",
      "properties": "Create, Filter, Group, idLookup, Sort, Update",
      "description": "The name of this CartDeliveryGroup record. Name can be up to 255 characters. In API version 62.0 and later, if IsDefault is true, the Name is Shipment1, a localized string. In prior API versions, the Name for a default delivery group was Cart Delivery Group. Due to this change, any queries intended to identify default delivery groups should use the IsDefault rather than Name field."
    },
    "SelectedDeliveryMethodId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "ID of the selected cart delivery group method. Populated if the selected CartDeliveryGroupMethod has the fields Carrier, ClassOfService, ReferenceNumber, and ShippingFee, but the DeliveryMethodId is null. If not, the DeliveryMethodId field is used. This field is available in API version 59.0 or later. This field is a relationship field.",
      "relationship_name": "SelectedDeliveryMethod",
      "relationship_type": "Lookup",
      "refers_to": "CartDeliveryGroupMethod"
    },
    "ShipToPhoneNumber": {
      "type": "phone",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "Phone number associated with a delivery. This field is available in API version 59.0 and later."
    },
    "ShippingInstructions": {
      "type": "textarea",
      "properties": "Create, Nillable, Update",
      "description": "Instructions for delivering an order."
    },
    "TotalAdjustmentAmount": {
      "type": "currency",
      "properties": "Filter, Nillable, Sort",
      "description": "The total amount of all promotional adjustments on the cart delivery group. This field is available in API version 54.0 and later. For product bundles, this includes the aggregate adjustments of all child components."
    },
    "TotalAdjustmentTaxAmount": {
      "type": "currency",
      "properties": "Filter, Nillable, Sort",
      "description": "The total tax amount for all promotional adjustments on the cart delivery group. This field is available in API version 54.0 and later. For product bundles, this includes the aggregate of the tax amounts for all child components’ adjustments."
    },
    "TotalAmount": {
      "type": "currency",
      "properties": "Filter, Nillable, Sort",
      "description": "The sum of all cart items TotalPrice, or TotalProductAmount plus TotalChargeAmount. For product bundles, this includes the aggregate of all child component prices."
    },
    "TotalCartItemCount": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The number of cart items, including their quantities, of the type PRODUCT in the delivery group. For product bundles, this count includes only the parent component. If the total quantity of cart items of type PRODUCT in the delivery group exceeds the system-defined maximum (INT_MAX), this field is set to INT_MAX."
    },
    "TotalChargeAmount": {
      "type": "currency",
      "properties": "Filter, Nillable, Sort",
      "description": "The sum of all the cart items TotalPrice for all cart items of type CHARGE. Cart items can be of type Product or Charge.For product bundles, if a child component includes a cart item of type CHARGE, its amount is aggregated with the parent’s cart item's total charge amount."
    },
    "TotalChargeTaxAmount": {
      "type": "currency",
      "properties": "Filter, Nillable, Sort",
      "description": "The sum of all the cart items TotalTaxAmount for all cart items of type CHARGE. Cart items can be of type Product or Charge.For product bundles, this includes the aggregate of all tax amounts associated with bundle-level charges, including the taxes of individual child products."
    },
    "TotalProductAmount": {
      "type": "currency",
      "properties": "Filter, Nillable, Sort",
      "description": "The sum of all the cart items TotalPrice for all cart items of type PRODUCT. Cart items can be of type Product or Charge. For product bundles, this includes the aggregate of all child component prices."
    },
    "TotalProductTaxAmount": {
      "type": "currency",
      "properties": "Filter, Nillable, Sort",
      "description": "The sum of all the cart items TotalTaxAmount for all cart items of type PRODUCT. Cart items can be of type Product or Charge. For product bundles, this includes the aggregate of all child component taxes based on their individual prices."
    },
    "TotalTaxAmount": {
      "type": "currency",
      "properties": "Filter, Nillable, Sort",
      "description": "The sum of all cart items TotalTaxAmount, or the combined value of TotalProductTaxAmount plus TotalChargeTaxAmount. For product bundles, this includes the aggregate of all child component taxes based on their individual prices."
    }
  },
  "special_access_rules": "The CartDeliveryGroup object is available only if the B2B Commerce or D2C Commerce license is enabled.",
  "associated_objects": "- **CartDeliveryGroupChangeEvent (API version 58.0)**: Change events are available for the object.",
  "field_reference": {
    "CartId": {
      "field_label": "Cart ID",
      "type": "reference",
      "length": "18"
    },
    "CompanyName": {
      "field_label": "Name of the company",
      "type": "string",
      "length": "255"
    },
    "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"
    },
    "DeliverToAddress": {
      "field_label": "Delivery Address",
      "type": "address"
    },
    "DeliverToCity": {
      "field_label": "City",
      "type": "string",
      "length": "40"
    },
    "DeliverToCountry": {
      "field_label": "Country",
      "type": "string",
      "length": "80"
    },
    "DeliverToFirstName": {
      "field_label": "Deliver To First Name",
      "type": "string",
      "length": "255"
    },
    "DeliverToGeocodeAccuracy": {
      "field_label": "Geocode Accuracy",
      "type": "picklist",
      "length": "40"
    },
    "DeliverToLastName": {
      "field_label": "Deliver To Last Name",
      "type": "string",
      "length": "255"
    },
    "DeliverToLatitude": {
      "field_label": "Latitude",
      "type": "double",
      "precision": "18",
      "scale": "15"
    },
    "DeliverToLongitude": {
      "field_label": "Longitude",
      "type": "double",
      "precision": "18",
      "scale": "15"
    },
    "DeliverToName": {
      "field_label": "Deliver To Name",
      "type": "string",
      "length": "255"
    },
    "DeliverToPostalCode": {
      "field_label": "Zip",
      "type": "string",
      "length": "20"
    },
    "DeliverToState": {
      "field_label": "State/Province",
      "type": "string",
      "length": "80"
    },
    "DeliverToStreet": {
      "field_label": "Street",
      "type": "textarea",
      "length": "255"
    },
    "DeliveryMethodId": {
      "field_label": "Order Delivery Method ID",
      "type": "reference",
      "length": "18"
    },
    "DesiredDeliveryDate": {
      "field_label": "Desired Delivery Date",
      "type": "datetime"
    },
    "GiftMessage": {
      "field_label": "Gift message",
      "type": "textarea",
      "length": "2000"
    },
    "GiftToName": {
      "field_label": "Gift recipient name",
      "type": "string",
      "length": "255"
    },
    "GrandTotalAmount": {
      "field_label": "Grand Total Amount",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "Id": {
      "field_label": "Cart Delivery Group ID",
      "type": "id",
      "length": "18"
    },
    "IsDefault": {
      "field_label": "Is Default",
      "type": "boolean"
    },
    "IsDeleted": {
      "field_label": "Deleted",
      "type": "boolean"
    },
    "IsGift": {
      "field_label": "Is this is a gift?",
      "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 Name",
      "type": "string",
      "length": "255"
    },
    "SelectedDeliveryMethodId": {
      "field_label": "Cart Delivery Group Method ID",
      "type": "reference",
      "length": "18"
    },
    "ShipToPhoneNumber": {
      "field_label": "Phone number given in shipping address",
      "type": "phone",
      "length": "40"
    },
    "ShippingInstructions": {
      "field_label": "Shipping Instructions",
      "type": "textarea",
      "length": "2000"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    },
    "TotalAdjustmentAmount": {
      "field_label": "Total Adjustment Amount",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "TotalAdjustmentTaxAmount": {
      "field_label": "Total Adjustment Tax Amount",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "TotalAmount": {
      "field_label": "Total Amount",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "TotalCartItemCount": {
      "field_label": "Total Cart Items in Delivery Group",
      "type": "int",
      "digits": "9"
    },
    "TotalCartItemQuantity": {
      "field_label": "Total Cart Item Quantity in Delivery Group",
      "type": "double",
      "precision": "18",
      "scale": "0"
    },
    "TotalChargeAmount": {
      "field_label": "Total Charge Amount",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "TotalChargeTaxAmount": {
      "field_label": "Total Charge Tax Amount",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "TotalProductAmount": {
      "field_label": "Total Product Amount",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "TotalProductTaxAmount": {
      "field_label": "Total Product Tax Amount",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "TotalTaxAmount": {
      "field_label": "Total Tax Amount",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length",
    "precision",
    "scale",
    "digits"
  ]
}