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

{
  "sections": [
    "title",
    "description",
    "fields",
    "special_access_rules",
    "associated_objects",
    "field_reference"
  ],
  "title": "Coupon - Data API",
  "description": "A coupon associated with a promotion. This object is available in API version 54.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "relationship_name",
    "relationship_type",
    "refers_to"
  ],
  "fields": {
    "CouponCode": {
      "type": "string",
      "properties": "Create, Filter, Group, idLookup, Sort, Update",
      "description": "Coupon code for the coupon. A buyer can use the coupon code to qualify for a promotion."
    },
    "CurrencyIsoCode": {
      "type": "picklist",
      "properties": "Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
      "description": "Available only for orgs with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization."
    },
    "Description": {
      "type": "textarea",
      "properties": "Create, Filter, Nillable, Sort, Update",
      "description": "Description of the coupon."
    },
    "EndDateTime": {
      "type": "dateTime",
      "properties": "Create, Filter, Nillable, Sort, Update",
      "description": "The end date and time when the coupon is no longer active."
    },
    "LastReferencedDate": {
      "type": "datetime",
      "properties": "Filter, Nillable, Sort",
      "description": "The timestamp when the current user last accessed this record, a record related to this record, or a list view."
    },
    "LastViewedDate": {
      "type": "datetime",
      "properties": "Filter, Nillable, Sort",
      "description": "The timestamp when the current user last viewed this record or list view. If this value is null, the user might have only accessed this record or list view (LastReferencedDate) but not viewed it."
    },
    "Name": {
      "type": "string",
      "properties": "Autonumber, Defaulted on create, Filter, idLookup, Sort",
      "description": "Name of the coupon."
    },
    "OwnerId": {
      "type": "reference",
      "properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
      "description": "The ID of the owner of this coupon. This is a polymorphic relationship field.",
      "relationship_name": "Owner",
      "relationship_type": "Lookup",
      "refers_to": "Group, User"
    },
    "PromotionId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Sort",
      "description": "ID of the promotion associated with the coupon. This is a relationship field.",
      "relationship_name": "Promotion",
      "relationship_type": "Lookup",
      "refers_to": "Promotion"
    },
    "RedemptionLimitAllBuyers": {
      "type": "int",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "Number of times this coupon can be used in total. This field is available in API version 61.0 and later."
    },
    "RedemptionLimitPerBuyer": {
      "type": "int",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "Number of times this coupon can be used per customer. This field is available in API version 61.0 and later."
    },
    "StartDateTime": {
      "type": "dateTime",
      "properties": "Create, Filter, Nillable, Sort, Update",
      "description": "The start date and time when the coupon is active."
    },
    "Status": {
      "type": "picklist",
      "properties": "Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update",
      "description": "Status of the coupon. Possible values are: Active Inactive The default value is Inactive"
    }
  },
  "special_access_rules": "The Coupon object is available only if the B2B Commerce license is enabled.",
  "associated_objects": "This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.\n\n- **CouponChangeEvent (API version 62.0)**: Change events are available for the object.",
  "field_reference": {
    "CouponCode": {
      "field_label": "Coupon Code",
      "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"
    },
    "Description": {
      "field_label": "Description",
      "type": "textarea",
      "length": "1000"
    },
    "EndDateTime": {
      "field_label": "End Date Time",
      "type": "datetime"
    },
    "Id": {
      "field_label": "Coupon 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"
    },
    "LastReferencedDate": {
      "field_label": "Last Referenced Date",
      "type": "datetime"
    },
    "LastViewedDate": {
      "field_label": "Last Viewed Date",
      "type": "datetime"
    },
    "Name": {
      "field_label": "Coupon Number",
      "type": "string",
      "length": "255"
    },
    "OwnerId": {
      "field_label": "Owner ID",
      "type": "reference",
      "length": "18"
    },
    "PromotionId": {
      "field_label": "Promotion ID",
      "type": "reference",
      "length": "18"
    },
    "RedemptionLimitAllBuyers": {
      "field_label": "Redemption Limit All Buyers",
      "type": "int",
      "digits": "9"
    },
    "RedemptionLimitPerBuyer": {
      "field_label": "Redemption Limit Per Buyer",
      "type": "int",
      "digits": "9"
    },
    "StartDateTime": {
      "field_label": "Start Date Time",
      "type": "datetime"
    },
    "Status": {
      "field_label": "Status",
      "type": "picklist",
      "length": "255"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length",
    "digits"
  ]
}