HomeGetting StartedSolutionsPlatformsGlobal Integration

The discount object

Attributes

AttributeData typeDescription
discount_code
required		stringThe name of your discount code is the name of the object that describes the amount and display name for that discount. For example, RETURN5 is the name of the discount code, so it is represented here as the name of the first discount in the discount object.
discount_amount
required		integerAmount of the discount being applied in USD or CAD cents. This value is not used to calculate the total.
discount_display_name
required		string Friendly name of the discount being applied.
"discounts":{
      "RETURN5":{
         "discount_amount":500,
         "discount_display_name":"Returning customer 5% discount"
      },
      "PRESDAY10":{
         "discount_amount":1000,
         "discount_display_name":"President's Day 10% off"
      }
   }