Adding Items

Items are individual units that are being covered. The items object takes in a list of all item units that are being sold. Each item will have a unique refund policy attached. When filing claims, the customer can file a claim containing one or more refund policies.

Example:

{
  "items": [
    {
      "name": "Item 1",
      "reference_number": "item-1334435",
      "cost": "50",
      "event": {
        "name": "Awesome Event",
        "start_date": "2027-12-24",
        "start_time": "12:00",
        "end_date": "2027-12-25",
        "end_time": "16:30",
        "location": "Test Location"
      }
    },
    {
      "name": "Item 2",
      "reference_number": "item-2765454",
      "cost": "100",
      "event": {
        "name": "Another Awesome Event",
        "start_date": "2027-01-01",
        "start_time": "12:00",
        "end_date": "2027-01-01",
        "end_time": "13:00",
        "location": "Secret Location"
      }
    }
  ]
}

Field	Type	Max Length	Description
`item.name`	string	255	Name or short description of the item.
`item.reference_number`	string	255	Reference number associated with the item. This unique identifier should help link an item from Teak's system to the item in the affiliate partner's system. ie. SKU.
`item.cost`	string	12	The cost of the item, eg. `cost: "50.00"`. For item costs, the decimal separator may be a `.`(period) or a `,`(comma). item costs may contain up to 1 decimal separator. Thousands separators should be omitted from the cost as this may cause the cost to be evaluated incorrectly. Valid costs: `"12"`, `"1234.99"`, `"123,99"`. Invalid costs: `"1,234.99"`, `"1,234"`(This will be evaluated as 1.234 instead of 1234). Also, please see notes on Handling Taxes & Fees
`item.event`	object	-	Although the event object can be set for individual items on the item level, if the event is the same for all items, it can be set on the order level. If an event is set at the order level and a different event is specified on the item level, the item-level event will be associated with the item. Complete and correct event information helps customers during the claims process.
`item.event.name`	string	255	Name or short description of the event.
`item.event.start_date`	date	-	Start date of event in `YYYY-MM-DD` format. Start date or end date is required. (UTC)
`item.event.start_time`	time	-	Start time of event in hh:mm format. (UTC)
`item.event.end_date`	date	-	End date of event in `YYYY-MM-DD` format. Start date or end date is required. (UTC)
`item.event.end_time`	time	-	End time of event in hh:mm format. (UTC)
`item.event.location`	string	255	Name or short description of event location.

📘
Event Dates & Times
All event dates and time should be in UTC.

Todo

Add item objects to order request body