In This Article:

    Activity Form Summary - Purchases

    In This Article:

      This API call returns the list of event purchases. 

      Request

      • Method: GET
      • URL: https://dev-api.salsalabs.org/api/developer/ext/v1/activities/UUID/summary/purchases
      • Applicable to: P2P

      Parameters

      Name
      Type
      Mandatory/Optional
      Description
      UUID UUID mandatory Path param. UUID of the activity form
      count Integer optional Number of purchases records to be returned. Max = 25. Default = 10
      offset Integer optional Purchases records list offset for pagination

       

      Example: https://dev-api.salsalabs.org/api/developer/ext/v1/activities/ce5025ce-e519-4c6d-a604-54804c4dce23/summary/purchases?count=15&offset=30

       

      Response

      General Fields

      Name
      Type
      Description
      total
      Integer total number of records available
      offset
      Integer starting offset for records
      count
      Integer count of records returned
      results
      Array Array of Purchase objects
       

      Purchase Fields

      Name
      Type
      Description
      id
      UUID purchase id
      purchaserFirstName
      String first name
      purchaserLastName
      String last name
      purchaserId
      UUID supporter id
      purchaserExternalId
      String supporter external id
      registrantName
      String registrant name
      registrantEmail
      String registrant email
      registrantTicket
      String registrant ticket
      quantity
      Integer quantity
      product
      String product name
      cost
      Double product cost
      status
      String

      Purchase status of the product, will be one of:

      • VALID
      • REFUNDED
      purchased
      Date purchase date. ISO_8601 formatted String with a GMT timezone

       

      Ticketed Event Response

      {
        "id""3fb4626e-dd26-4496-9ecc-0980b9a60494",
        "timestamp""2018-02-08T10:21:04.943Z",
        "header": {
          "processingTime"98,
          "serverId""local"
        },
        "payload": {
            "total"2,
            "offset"0,
            "count"2,
            "results": [
              {
                "id""2b068887-bde7-40dc-aa2e-ee69a088ccdd",
                "purchaserFirstName""FirstName0",
                "purchaserLastName""LastName0",
                "purchaserId""c43623ca-c2e7-4cb0-ac39-72a996b61f35",
                "purchaserExternalId""extId110"
                ],
                "registrantName""Attendee Name0",
                "registrantEmail""attendee0@mail.com",
                "registrantTicket""attendee ticket name0",
                "quantity"4,
                "product""Product Name0",
                "cost"45.5,
                "status""VALID",
                "purchased""2018-02-08T10:21:04.944Z"
              },
              {
                "id""840cb401-e191-416b-ae05-e42db92cf325",
                "purchaserFirstName""FirstName1",
                "purchaserLastName""LastName1",
                "purchaserId""9cf2c64c-3146-4bfc-81a3-3ec9216e6faa",
                "supporterExternalId""extId111"
                ],
                "registrantName""Attendee Name1",
                "registrantEmail""attendee1@mail.com",
                "registrantTicket""attendee ticket name1",
                "quantity"4,
                "product""Product Name1",
                "cost"45.5,
                "status""REFUNDED",
                "purchased""2018-02-08T10:21:04.944Z"
              }
            ]
          }
      }

       

      Was this article helpful?
      0 out of 0 found this helpful
      Have more questions? Submit a request

      Comments

      0 comments

      Please sign in to leave a comment.