Overview
GovX offers several automated options for reporting transactions and commissions on ticket purchases and travel reservations. You must implement one of the approved tracking methods in order to list your offer on the Govx.com site.
The two preferred integration methods are via a tracking pixel or an HTTP post. The pixel is implemented in the HTML of your application and is used for content management systems where server code is unavailable. The HTTP post method is used in scenarios where it is easier to call from backend services. For implementation guides, please refer to the following:
If you are not able to integrate via either the tracking pixel or the HTTP post methods, we also offer a simple CSV integration, which is covered in this document.
Identifiers in Query-string
As part of the implementation, we will place protected links on GovX.com to allow our members to access your offering. When one of these links is clicked, we will append two unique identifiers as query-string name/value pairs.
- Customer Identifier: The default query-string name is "_xcid". The parameter value identifies the customer in our system.
- Ticket Identifier: The default query-string name is "GXTicketId". The parameter value identifies the ticket in our system.
You will need to parse the query-string to capture these values and transmit them back to GovX when reporting commission.
An example link could look as follows:
https://affiliatepartner.co/e/7810?discount=ABC&_xcid=a2b64d58-3309-49f1-a871-f2da94596788&GXTicketId=764837
Reporting Commission
Commission reports should be sent to GovX once-per-day at a consistent time using a CSV flat-file format. You have two options for transmitting the files.
- SFTP: We will give you access to a secure FTP server location where you can deposit the files. This is the preferred method for transmitting CSV files.
- Email: We can set up an individual inbox for your account (ex: commission-partnerxyz@govx.com)
The files should contain the transaction details, including the customer and ticket identifiers. Orders should be itemized in the file. As such, a single customer order could be represented by multiple rows in the file. For example, if I purchase 2 tickets to the San Diego Padres game on 4/16 and one ticket to the Padres game on 4/17, this order would be represented by 2 rows in the transaction file; one for each game.
Ticket Transactions
| Column name | Required? | Description | Sample value |
|---|---|---|---|
| SourceOrderId | YES | Identifier of the order in your system of record. If an order has multiple items, this SourceOrderId will help us group the rows together into one order. | |
| SourceProductId | YES | The unqiue ID of the product in your system of record. | |
| SourceProductName | YES | The name of the product in your system of record. | "Washington Wizards vs. Atlanta Hawks" |
| TicketType | NO | The type of ticket that was sold. | "Resale", "Primary", "Pre-Sale", etc |
| EventStartDt | YES | The start date of the event for which the ticket was purchased. | "04/06/2018" |
| EventEndDt | NO | The end date of the event for which the ticket was purchased. If the event was a single day event, this column should be 'null'. | "null" |
| _xcid | YES | Identifies the customer in the GovX system. Supplied by GovX in query-string | "85721f42-842c-e811-80e5-14187735fc96-3" |
| GXTicketID | YES | Identifies the ticket in the GovX system. Supplied by GovX in query-string | "488998" |
| SaleDate | YES | The date of the transaction. | "2018-04-04" |
| SaleTime | YES | The time of the transaction. | "9:19:00 PM PST" |
| TotalPrice | YES | The total sale. | "151.98" |
| TotalCommission | YES | The commission amount due GovX. | "12.34" |
| UnitPrice | YES | The unit prices of each ticket in the line-item. | "75.99" |
| Quantity | YES | The number of tickets in the line-item. | "2" |
Travel Transactions
| Column name | Required? | Description | Sample value |
|---|---|---|---|
| SourceOrderId | YES | Identifier of the order in your system of record. If an order has multiple items, this SourceOrderId will help us group the rows together into one order. | |
| SourceProductId | YES | The unqiue ID of the product in your system of record. | |
| SourceProductName | YES | The name of the product in your system of record. | "Holiday Inn" |
| StartDt | NO | The start date of the purchase | "2018-08-09T05:00:00.000" |
| StartLoc | NO | The starting destination city/state. | "San Diego, CA" |
| StartPostCd | NO | The starting destination postal code. | "92121" |
| EndDt | NO | The end date of the purchase | "2018-08-03T08:00:00.000" |
| EndLoc | NO | The end destination city/state. | "Las Vegas, NV" |
| EndPostCd | NO | The end destination postal code. | "88901" |
| _xcid | YES | Identifies the customer in the GovX system. Supplied by GovX in query-string | "85721f42-842c-e811-80e5-14187735fc96-3" |
| GXTicketID | YES | Identifies the ticket in the GovX system. Supplied by GovX in query-string | "488998" |
| SaleDate | YES | The date of the transaction. | "2018-04-04" |
| SaleTime | YES | The time of the transaction. | "9:19:00 PM PST" |
| TotalPrice | YES | The total sale. | "151.98" |
| TotalCommission | YES | The commission amount due GovX. | "12.34" |
| UnitPrice | YES | The unit prices of each item purchased. | "75.99" |
| Quantity | YES | The number of items purchased. | "2" |
Comments
0 comments
Please sign in to leave a comment.