SPORTS EVENTS AND EXPERIENTIAL TRAVEL PACKAGES
Menu
中文(简体) Spanish (español) English (UK)
Login Track Order
Choose Currency

API Tools

Get your P-Authorization

Implementation of FTP order system requires some initial settings to be done. These pre required settings done by Pulse Experiential Travel. Below is detail about “what you need to do for using our API”?

  1. Register yourself as FTP reseller with Pulse Experiential Travel.
  2. Provide required details to Pulse Experiential Travel.

To download our FTP documentation click here.

To implement FTP order process functionality, please click here to download the FTP process documentation.

Implementation of API requires some initial settings to be done. These setting are done by Pulse Experiential Travel. Below is detail about “what you need to do for using our API”?

  1. Register yourself as reseller with Pulse Experiential Travel.
  2. Provide required details to Pulse Experiential Travel and for productions don’t forget to whitelist your IP’s.
  3. Every request has either POST or GET verb. POST request must be in JSON format.
  4. To do your first request you need ‘Security Token’ and ‘Reseller id’.
  5. With above details you also need an “encryption key” which will be used to generate EncryptedAuthKey. This EncryptedAuthKey will be sent as value of header parameter ‘P-Authorization’. (Valid for a 24 hours)
  6. To use production API update Pulse Experiential Travel to enable you for this.

For‘P-Authorization’, use our getAuth API

Get Your Key to generate AuthKey. For testing this can be manually generated here:

Link: https://www.pulseexperientialtravel.com/index.php?option=com_virtuemart&view=reseller

Below we have explained both the categories of API’s. Each category has a set of sequence to be followed to get data and make a final purchase notification to Pulse Experiential Travel.

For Travel Packages please go through the below serial order by which API is listed and explained.

To Purchases Tickets there are some basic rules and sequence that is needed to be followed strictly to make a final purchase notification to Pulse Experiential Travel. Below is the sequence:

  1. Select a production from production list using the event or venue.
  2. Then fetch inventories form the selected production.
  3. Allow user to select an inventory. Then get all details of that selected inventory.
  4. Depending on quantity get all ticket price. e.g. (ticket price * quantity selected)
  5. Fetch the shipping method ids for the Ticket id of the selected inventory.
  6. Add the price of shipping method selected to tickets price.
  7. Fetch service charges of selected ticket and add it to the sum of ticket price and shipping price. Finally make purchase request with all the parameter in JSON format.

Common parameters in header

[
     SecurityToken:'XXXXXXXXXXXXXX',
     Content-Type: ‘application/json',
     Accept: 'application/json'
]

Common parameters in Request

[
     resellerid* - Your reseller Id(Required),
     version* - version=2(Required)
]

Common Response Codes:

Value Name Description
34 Restricted Access Access not allowed.
35 Data not available Requested data not available or deleted.
38 Restricted Access Cannot Communicate with this IP.
40 Value Missing Header or parameter is missing.
45 Invalid input Content-Type not valid.
46 Value Missing Security Token is missing.
47 Value Missing Reseller ID is missing.
70 Invalid Method Request Method not valid.

Common Status Response format.

{
    "Status": {
        "Succeeded": false,
        "StatusCode": "47",
        "StatusMessage": "Reseller ID is missing",
        "Code": "47",
        "Message": "Reseller ID is missing"
    }
}
                    

[Deprecated] Code and Message keys will be removed.

1. To get main category for products (Task = vmcategories)

Test URL: https://www.pulseexperientialtravel.com/index.php?option=com_virtuemart&view=testresellerapi&task=vmcategories&version=2&resellerid=YOUR_RESELLER_ID

Live URL: https://www.pulseexperientialtravel.com/index.php?option=com_virtuemart&view=resellerapi&task=vmcategories&version=2&resellerid=YOUR_RESELLER_ID

GET Request with following parameters in header

[
SecurityToken:'XXXXXXXXXXXXXX',
Content-Type: ‘application/json',
Accept: 'application/json'
]

GET Request with following parameters in URL

[
start - (Page starts From),
size - (Page size)
]

Response Codes:

Value Name Description
30 Success Process completed and result received.
31 Failed Process not completed successfully.
34 Restricted Access Data is not Accessible. Either security token or Reseller Id is Incorrect.
35 Data not available Main categories are not available or deleted.
45 Invalid input Content-Type not valid.
46 Value Missing Security Token is missing.
47 Value Missing Reseller ID is missing.
70 Invalid Method Request Method not valid.

Success Response.

{
    "Status": {
        "Succeeded": true,
        "StatusCode": "30",
        "StatusMessage": "The operation completed successfully."
    },
    "TravelCategories": [
        {
            "virtuemart_category_id": "1",
            "category_name": "Category 1",
            "category_description": "",
            "file_url": "[URL]/slide1.jpg"
        },
        {
            "virtuemart_category_id": "2",
            "category_name": "Category 2",
            "category_description": "",
            "file_url": "[URL]/slide2.jpg"
        }
    ]
}
                        
2. To get sub category for main category (Task = vmsubcategories)

Test URL: https://www.pulseexperientialtravel.com/index.php?option=com_virtuemart&view=testresellerapi&task=vmsubcategories&mcatid=MAINCAT_ID&version=2&resellerid=YOUR_RESELLER_ID

Live URL: https://www.pulseexperientialtravel.com/index.php?option=com_virtuemart&view=resellerapi&task=vmsubcategories&mcatid=MAINCAT_ID&version=2&resellerid=YOUR_RESELLER_ID

GET Request with following parameters in header

[
SecurityToken:'XXXXXXXXXXXXXX',
Content-Type: ‘application/json',
Accept: 'application/json'
]

GET Request with following parameters in URL

[
mcatid - (Main Category Id is passed in this parameter can be retrieved from the "Main category for Products API"),
start - (Page starts From),
size - (Page size)
]

Response Codes:

Value Name Description
30 Success Process completed and result received.
31 Failed Process not completed successfully.
34 Restricted Access Data is not Accessible. Either security token or Reseller Id is Incorrect.
35 Data not available Categories are not available or deleted.
40 Value Missing Header or parameter is missing.
45 Invalid input Content-Type not valid.
46 Value Missing Security Token is missing.
47 Value Missing Reseller ID is missing.
70 Invalid Method Request Method not valid.

Success Response.

{
    "Status": {
        "Succeeded": true,
        "StatusCode": "30",
        "StatusMessage": "The operation completed successfully"
    },
    "TravelSubCategories": [
        {
            "virtuemart_category_id": "1",
            "category_name": "Sub Category 1",
            "category_description": "",
            "file_url": "[URL]/slide1.jpg"
        },
        {
            "virtuemart_category_id": "2",
            "category_name": "Sub Category 2",
            "category_description": "",
            "file_url": "[URL]/slide2.jpg"
        }
    ]
}
                        
3. To get countries for products (Task = vmcountries)

Test URL: https://www.pulseexperientialtravel.com/index.php?option=com_virtuemart&view=testresellerapi&task=vmcountries&version=2&resellerid=YOUR_RESELLER_ID

Live URL: https://www.pulseexperientialtravel.com/index.php?option=com_virtuemart&view=resellerapi&task=vmcountries&version=2&resellerid=YOUR_RESELLER_ID

GET Request with following parameters in header

[
SecurityToken:'XXXXXXXXXXXXXX',
Content-Type: ‘application/json',
Accept: 'application/json'
]

GET Request with following parameters in URL

[
start - (Page starts From),
size - (Page size)
]

Response Codes:

Value Name Description
30 Success Process completed and result received.
31 Failed Process not completed successfully.
34 Restricted Access Data is not Accessible. Either security token or Reseller Id is Incorrect.
35 Data not available Countries are not available or deleted.
45 Invalid input Content-Type not valid.
46 Value Missing Security Token is missing.
47 Value Missing Reseller ID is missing.
70 Invalid Method Request Method not valid.

Success Response.

{
    "Status": {
        "Succeeded": true,
        "StatusCode": "30",
        "StatusMessage": "The operation completed successfully"
    },
    "TravelCountries": [
        {
            "virtuemart_country_id": "1",
            "country_name": "Abu Dhabi"
        },
        {
            "virtuemart_country_id": "2",
            "country_name": "Argentina"
        }
    ]
}
                        
4. To get states for country (Task = vmstates)

Test URL: https://www.pulseexperientialtravel.com/index.php?option=com_virtuemart&view=testresellerapi&task=vmstates&countryId=COUNTRY_ID&version=2&resellerid=YOUR_RESELLER_ID

Live URL: https://www.pulseexperientialtravel.com/index.php?option=com_virtuemart&view=resellerapi&task=vmstates&countryId=COUNTRY_ID&version=2&resellerid=YOUR_RESELLER_ID

GET Request with following parameters in header

[
SecurityToken:'XXXXXXXXXXXXXX',
Content-Type: ‘application/json',
Accept: 'application/json'
]

GET Request with following parameters in URL

[
countryId - (Country Id is passed in this parameter to retrieve list of states for the country),
start - (Page starts From),
size - (Page size)
]

Response Codes:

Value Name Description
30 Success Process completed and result received.
31 Failed Process not completed successfully.
34 Restricted Access Data is not Accessible. Either security token or Reseller Id is Incorrect.
35 Data not available States are not available or deleted.
40 Value Missing Header or parameter is missing.
45 Invalid input Content-Type not valid.
46 Value Missing Security Token is missing.
47 Value Missing Reseller ID is missing.
70 Invalid Method Request Method not valid.

Success Response.

{
    "Status": {
        "Succeeded": true,
        "StatusCode": "30",
        "StatusMessage": "The operation completed successfully"
    },
    "TravelStates": [
        {
            "virtuemart_state_id": "1",
            "state_name": "Alberta"
        },
        {
            "virtuemart_state_id": "2",
            "state_name": "British Columbia"
        }
    ]
}
                        
5. To get cities for state (Task = vmcities)

Test URL: https://www.pulseexperientialtravel.com/index.php?option=com_virtuemart&view=testresellerapi&task=vmcities&countryId=COUNTRY_ID&stateId=STATE_ID&version=2&resellerid=YOUR_RESELLER_ID

Live URL: https://www.pulseexperientialtravel.com/index.php?option=com_virtuemart&view=resellerapi&task=vmcities&countryId=COUNTRY_ID&stateId=STATE_ID&version=2&resellerid=YOUR_RESELLER_ID

GET Request with following parameters in header

[
SecurityToken:'XXXXXXXXXXXXXX',
Content-Type: ‘application/json',
Accept: 'application/json'
]

GET Request with following parameters in URL

[
countryId - (Country Id is passed in this parameter to retrieve list of cities for the country),
stateId - (State Id is passed in this parameter to retrieve list of cities for the state if states are available for country),
start - (Page starts From),
size - (Page size)
]

Response Codes:

Value Name Description
30 Success Process completed and result received.
31 Failed Process not completed successfully.
34 Restricted Access Data is not Accessible. Either security token or Reseller Id is Incorrect.
35 Data not available Cities are not available or deleted.
40 Value Missing Header or parameter is missing.
45 Invalid input Content-Type not valid.
46 Value Missing Security Token is missing.
47 Value Missing Reseller ID is missing.
70 Invalid Method Request Method not valid.

Success Response.

{
    "Status": {
        "Succeeded": true,
        "StatusCode": "30",
        "StatusMessage": "The operation completed successfully"
    },
    "TravelCities": [
        {
            "virtuemart_city_id": "1",
            "city_name": "Banff"
        },
        {
            "virtuemart_city_id": "2",
            "city_name": "Calgary"
        }
    ]
}
                        
6. To get products of a particular sub category (Task = vmproducts)

Test URL: https://www.pulseexperientialtravel.com/index.php?option=com_virtuemart&view=testresellerapi&task=vmproducts&catid=CATEGORY_ID&version=2&resellerid=YOUR_RESELLER_ID

Live URL: https://www.pulseexperientialtravel.com/index.php?option=com_virtuemart&view=resellerapi&task=vmproducts&catid=CATEGORY_ID&version=2&resellerid=YOUR_RESELLER_ID

GET Request with following parameters in header

[
SecurityToken:'XXXXXXXXXXXXXX',
Content-Type: ‘application/json',
Accept: 'application/json'
]

GET Request with following parameters in URL

[
catid - (Sub Category Id is passed as parameter),
countryId - (Country Id is passed as parameter),
stateId - (State Id is passed as parameter),
cityId - (City Id is passed as parameter),
start - (Page starts From),
size - (Page size)
]

Response Codes:

Value Name Description
30 Success Process completed and result received.
31 Failed Process not completed successfully.
34 Restricted Access Data is not Accessible. Either security token or Reseller Id is Incorrect.
35 Data not available Products are not available or deleted.
40 Value Missing Header or parameter is missing.
45 Invalid input Content-Type not valid.
46 Value Missing Security Token is missing.
47 Value Missing Reseller ID is missing.
70 Invalid Method Request Method not valid.

Success Response.

{
    "Status": {
        "Succeeded": true,
        "StatusCode": "30",
        "StatusMessage": "The operation completed successfully"
    },
    "Products": [
        {
            "virtuemart_product_id": "1111",
            "product_name": "Product Name",
            "product_desc": "product description",
            "product_s_desc": "product short description",
            "retail_price": "2500.00",
            "wholesale_price": "2250.00",
            "file_url": "[URL]/img2.jpg",
            "product_sku": "NFLPROB3N28",
            "file_thumb_url": "[URL]/img2.jpg",
            "location": {
                "country": {
                    "1": {
                        "id": "1",
                        "name": "United States",
                        "state": {
                            "8": {
                                "id": "8",
                                "name": "Florida",
                                "city": {
                                    "32": {
                                        "id": "32",
                                        "name": "Orlando"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    ]
}
                        
7. To get detail of a single product (Task = vmsingle_product)

Test URL: https://www.pulseexperientialtravel.com/index.php?option=com_virtuemart&view=testresellerapi&task=vmsingle_product&id=PRODUCT_ID&version=2&resellerid=YOUR_RESELLER_ID

Live URL: https://www.pulseexperientialtravel.com/index.php?option=com_virtuemart&view=resellerapi&task=vmsingle_product&id=PRODUCT_ID&version=2&resellerid=YOUR_RESELLER_ID

GET Request with following parameters in header

[
SecurityToken:'XXXXXXXXXXXXXX',
Content-Type: ‘application/json',
Accept: 'application/json',
]

GET Request with following parameters in URL

[
id - (This parameter accepts Product Id of the product for which details is needed),
]

Response Codes:

Value Name Description
30 Success Process completed and result received.
31 Failed Process not completed successfully.
34 Restricted Access Data is not Accessible. Either security token or Reseller Id is Incorrect.
35 Data not available Product are not available or deleted.
40 Value Missing Header or parameter is missing.
45 Invalid input Content-Type not valid.
46 Value Missing Security Token is missing.
47 Value Missing Reseller ID is missing.
70 Invalid Method Request Method not valid.

Success Response.

{
    "Status": {
        "Succeeded": true,
        "StatusCode": "30",
        "StatusMessage": "The operation completed successfully"
    },
    "ProductDetail": [
        {
            "product_id": "5479",
            "product_sku": "NFLPROB3N28",
            "product_name": "NFL Pro Bowl Experience for Two",
            "product_s_desc": "Product short Description",
            "product_desc": "Product Description",
            "retail_price": "2500.00",
            "wholesale_price": "2250.00",
            "file_url": "[URL]/img2.jpg",
            "file_thumb_url": "[URL]/img2.jpg",
            "location": {
                "country": {
                    "1": {
                        "id": "1",
                        "name": "United States",
                        "state": {
                            "8": {
                                "id": "8",
                                "name": "Florida",
                                "city": {
                                    "32": {
                                        "id": "32",
                                        "name": "Orlando"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    ]
}
                        
8. To get P-Authorization (Task = getAuth)

Test URL: https://www.pulseexperientialtravel.com/index.php?option=com_virtuemart&view=testresellerapi&task=getAuth&version=2&resellerid=YOUR_RESELLER_ID

Live URL: https://www.pulseexperientialtravel.com/index.php?option=com_virtuemart&view=resellerapi&task=getAuth&version=2&resellerid=YOUR_RESELLER_ID

GET Request with following parameters in header

[
SecurityToken:'XXXXXXXXXXXXXX',
Content-Type: ‘application/json',
Accept: 'application/json'
]

Response Codes:

Value Name Description
30 Success Process completed and result received
31 Failed Process not completed successfully.

Success Response.

{
    "Status": {
        "Succeeded": true,
        "StatusCode": "30",
        "StatusMessage": "The operation completed successfully"
    },
    "auth": {
        "P_Authorization": "HYS5MmI3YjI1NjkwODY3NjNmYTczY2IyZDRiNmIwNzQ0YTdkMGY1NTE3YzYwYTExMWYyZjYyMDJhNDg2MWZmOQ==",
        "P_TimeStamp": "2018-12-26 02:43:45"
    }
}
                        
9. Send buy notification of product (Task = purchase_done)

Test URL: https://www.pulseexperientialtravel.com/index.php?option=com_virtuemart&view=testresellerapi&task=purchase_done&version=2&resellerid=YOUR_RESELLER_ID

Live URL: https://www.pulseexperientialtravel.com/index.php?option=com_virtuemart&view=resellerapi&task=purchase_done&version=2&resellerid=YOUR_RESELLER_ID

GET Request with following parameters in header

[
SecurityToken:'XXXXXXXXXXXXXX',
Content-Type: ‘application/json',
Accept: 'application/json',
P-Authorization: 'EncryptedAuthKey',
P-TimeStamp: 'CurrentTimeStamp'
]

Response Codes:

Value Name Description
30 Success Process completed and result received.
31 Failed Process not completed successfully.
34 Restricted Access Data is not Accessible. Either security token or Reseller Id is Incorrect.
35 Data not available Package(s) are not available or deleted.
40 Value Missing Header or parameter is missing.
45 Invalid input Content-Type not valid.
46 Value Missing Security Token is missing.
47 Value Missing Reseller ID is missing.
70 Invalid Method Request Method not valid.

POST Request for the Orders Purchased

{
    "orderId":"432e32",
    "productDetail":[  
        {  
            "productSku":"SAMER27",
            "productQty":"1",
            "productPrice":"55",
            "orderRewardId" : "kllklk"
        },
        {  
            "productSku":"SAMER27",
            "productQty":"1",
            "productPrice":"45",
            "orderRewardId" : "56hr6"
        } 
    ],
    "userEmail":"john@email.com",
    "userFirstName":"John",
    "userLastName":"Doe",
    "userAddressOne":"Address1",
    "userAddressTwo":"Address2",
    "userCity":"City",
    "userRegion":"State/Region",
    "userCountry":"Country",
    "userZip":"Zip",
    "userPhone":"Phone",
    "type":"Travel Packages",
    #Other modules parameters comes here
}
                        

Response for the Orders Purchased

{
    "Status": {
        "Succeeded": true,
        "StatusCode": "30",
        "StatusMessage": "The operation completed successfully"
    },
    "OrderDetail": {
        "error": 0,
        "msg": "Orders Sent Successfully",
        "orderId": "PULSE930481",
        "partnerCode": "XXXXXX",
        "purchaseData": [
            {
                "productSku": "SAMER27CART",
                "productQty": "1",
                "productPrice": "55",
                "orderRewardId": "kllklk",
                "CertificateNumber": "SAMER27-0NXX-122818-15L",
                "CertificateRedemptionForm": "[URL]/SAMER27CART-060217-V44.pdf",
                "CertificateDescriptionForm": "[URL]/SAMER27CART-060217-V44.pdf"
            },
            {
                "productSku": "SAMER27",
                "productQty": "1",
                "productPrice": "45",
                "orderRewardId": "56hr6",
                "CertificateNumber": "SAMER27-0NXX-122818-8U4",
                "CertificateRedemptionForm": "[URL]/3026939LKC4FMBEND5W_RedemptionForm.pdf",
                "CertificateDescriptionForm": "[URL]/3026939LKC4FMBEND5W_DescriptionForm.pdf"
            }
        ]
    },
    #Other modules response comes here
}
                        
If you want to gift then add this module with basic order request.

Gifting module parameters with POST Request

    "isGift": true,
    "senderName": "Sender full Name",
    "recieverName": "Reciever Full Name",
    "recieverEmail": "reciever@email.com",
    "receiverPhoneNumber": "Recv. Phone",
    "receiverAddressOne": "Recv. Address1",
    "receiverAddressTwo": "Recv. Address2",
    "receiverCity": "Recv. City",
    "receiverRegion": "Recv. State/Region",
    "receiverCountry": "Recv. Country",
    "receiverZip": "Recv. Zip",
    "giftNote": "Hi, its a gift for you."
                        
If you want to process payment with us then add this module with basic order request.

Partial Payment module parameters with POST Request

    "isPartialpayment":true,	
    "totalAmount":"100",
    "partialAmount":"60",
    "cardType":"MasterCard",
    "cardNumber":"XXXXXXXXXXXXXXXX",
    "cvv":"XXX",
    "expMonth":"MM",
    "expYear":"YYYY",
    "nameOnCard":"John Doe",
    "billingInfo":{  
        "firstname":"John",
        "lastname":"Doe",
        "street":"Street",
        "city":"City",
        "state":"State/Region",
        "zip":"Zip code",
        "country":"Country"
    }
                        

Partial payment module Response

    "paymentDetail": {
        "Succeeded": true,
        "StatusCode": 0,
        "StatusMessage": "Approved"
    }
                        
10. To GET track certificate status (Task = vmCertInfo)

Test URL: https://www.pulseexperientialtravel.com/index.php?option=com_virtuemart&view=testresellerapi&task=vmCertInfo&version=2&resellerid=YOUR_RESELLER_ID

Live URL: https://www.pulseexperientialtravel.com/index.php?option=com_virtuemart&view=resellerapi&task=vmCertInfo&version=2&resellerid=YOUR_RESELLER_ID

GET Request with following parameters in header

[
SecurityToken:'XXXXXXXXXXXXXX',
Content-Type: ‘application/json',
Accept: 'application/json',
]

GET Method with parameter's

[
cert: Certificate number which details is required ,
]

Response Codes:

Value Name Description
30 Success Process completed and result received.
31 Failed Process not completed successfully.
34 Restricted Access Data is not Accessible. Either security token or Reseller Id is Incorrect.
35 Data not available Order Id not found.
40 Value Missing Header or parameter is missing.
45 Invalid input Content-Type not valid.
46 Value Missing Security Token is missing.
47 Value Missing Reseller ID is missing.
70 Invalid Method Request Method not valid.

Success Response.

{
    "Status": {
        "Succeeded": true,
        "StatusCode": "30",
        "StatusMessage": "The operation completed successfully"
    },
    "shipInfo": {
        "cert": "ROMGETA1N28-111111-XXX",
        "status": "valid",
        "dateShipped": "11/18/18",
        "shippedBy": "USPS Priority Mail",
        "shippingTrackingNumber": "XXXXXXXXXXXXXXXXXXXXXX"
    }
}
                        
1. To GET Productions List (Task = productions)

Test URL: https://www.pulseexperientialtravel.com/index.php?option=com_virtuemart&view=testresellerapi&task=productions&version=2&resellerid=YOUR_RESELLER_ID

Live URL: https://www.pulseexperientialtravel.com/index.php?option=com_virtuemart&view=resellerapi&task=productions&version=2&resellerid=YOUR_RESELLER_ID

GET Request with following parameters in header

[
SecurityToken:'XXXXXXXXXXXXXX',
Content-Type: ‘application/json',
Accept: 'application/json',
]

GET Method with parameter's

[
startDate: [DateTime] This parameter is used to filter response by Event's start date. Example: 3/26/2017, 12:00:00,
endDate: [DateTime] This parameter is used to filter response by Event's end date. Example: 3/31/2017, 11:59:59,
searchType: [int] This parameter is used to filter the type of search(0:By event/performer, 1:By City, 2:By location),
searchKey: [string] This parameter is used to filter response by event/performer and city.
If searchType is 0, than will be event/performer name as "Shrek"
If searchType is 1, than will be city name as "New York, NY"(* Provide city name with state code with comma seprated) .

lng: [string] This parameter conatin the longitude (*required if searchType is 2),
lat: [string] This parameter conatin the latitude (*required if searchType is 2),
productionId: [int] This parameter accepts production id and return all details related to that,
pageNumber: This parameter accepts Page number to be displayed - Defaults to 0,
pageSize: This parameter accepts page size to be displayed - Defaults to 100,
]

Response Codes:

Value Name Description
0 Success Process completed and result received.
1 Failed Process not completed or not get desired response.
34 Restricted Access Data is not Accessible. Either security token or Reseller Id is Incorrect.
45 Invalid input Content-Type not valid.
46 Value Missing Security Token is missing.
47 Value Missing Reseller ID is missing.
70 Invalid Method Request Method not valid.

Get Request response

        {
        "Status": {
            "Succeeded": true,
            "StatusCode": 0,
            "StatusMessage": "The operation completed successfully.",
            "Result": 1
        },
        "Productions": [
            {
                "CT_EventDate": "2018-12-28T12:30:00-06:00",
                "City": "Lincolnshire",
                "EventDate": "2018-12-28T12:30:00Z",
                "EventID": 1411484,
                "EventName": "Shrek",
                "EventTypeID": "69",
                "IsBarcodeRequired": null,
                "IsDigitalDelivery": null,
                "IsLiveOnTMPlus": null,
                "IsManifestAvailable": null,
                "IsMobileDeliveryOnly": null,
                "IsTBADate": null,
                "IsTBATime": null,
                "IsTicketFastProduction": null,
                "MyBarcodedSeatCount": null,
                "MyListingsCount": null,
                "MySeatCount": null,
                "OpponentEventID": null,
                "OpponentEventName": null,
                "ProductionID": 1411484,
                "ProductionName": "Shrek",
                "ProductionStatus": null,
                "SeatingChartUrl": "https://www.example.com/configurations/static_maps/13151/medium.jpg?1430517770",
                "ShortNote": "",
                "State": "IL",
                "TM_Event_ID": null,
                "VenueID": 6303,
                "VenueName": "Marriott Theatre (Lincolnshire)",
                "occurs_at_local": "2018-12-28T12:30:00-06:00",
                "occurs_at": "2018-12-28T12:30:00Z"
            }
        ]
    }
                        
2. To GET ticket details (Task = ticket)

Test URL: https://www.pulseexperientialtravel.com/index.php?option=com_virtuemart&view=testresellerapi&task=ticket&version=2&resellerid=YOUR_RESELLER_ID

Live URL: https://www.pulseexperientialtravel.com/index.php?option=com_virtuemart&view=resellerapi&task=ticket&version=2&resellerid=YOUR_RESELLER_ID

GET Request with following parameters in header

[
SecurityToken:'XXXXXXXXXXXXXX',
Content-Type: ‘application/json',
Accept: 'application/json',
]

GET Method with parameter's

[
productionID: This parameter accepts the Product Id for which inventories are needed,
ticketIDs: This parameter accepts the Ticket IDs for which details are needed. [Single ticket id must be passed to get the Quantity array of that ticket],
]

Response Codes:

Value Name Description
0 Success Process completed and result received.
1 Failed Process not completed or not get desired response.
34 Restricted Access Data is not Accessible. Either security token or Reseller Id is Incorrect.
40 Invalid Method Header or parameter is missing.
45 Invalid input Content-Type not valid.
46 Value Missing Security Token is missing.
47 Value Missing Reseller ID is missing.
70 Invalid Method Request Method not valid.

Get Request response

{
    "Status": {
        "Succeeded": true,
        "StatusCode": 0,
        "StatusMessage": "The operation completed successfully.",
        "Result": 1
    },
    "Inventories": [
        {
            "Barcodes": null,
            "BrokerID": null,
            "BrokerName": "Private",
            "Cost": "12.36",
            "CurrencyCode": null,
            "DateAdd": "2018-11-01T16:47:55Z",
            "Description": "parking pass only   - Ships by 12/02/2018.",
            "DigitalDelayOffsetMinutes": null,
            "DigitalDeliveryDate": null,
            "EndSeat": false,
            "EventDate": "2018-12-04T19:30:00Z",
            "EventName": "Arizona Coyotes at Los Angeles Kings",
            "EventTime": "2018-12-04T19:30:00Z",
            "ExchangeRate": null,
            "Face": null,
            "InHandDate": null,
            "InventoryStatus": null,
            "InventoryTypeId": null,
            "IsAllowSplit": true,
            "IsB2BDisplayProtectionEnabled": null,
            "IsBarcodesLocked": null,
            "IsConsignment": null,
            "IsCurrencyConversionApplied": null,
            "IsEligibleForB2B": null,
            "IsInstantDelivery": false,
            "IsOutOnConsignment": null,
            "IsPDFAvailable": null,
            "IsSpeculation": null,
            "IsTMPlusDisplayProtectionEnabled": null,
            "IsTMRDisplayProtectionEnabled": null,
            "List": null,
            "ManifestFailureCondition": null,
            "ManifestFailureConditionTypeID": null,
            "POSInventoryStatus": null,
            "TicketProductionID": 1487449,
            "Quantity": 1,
            "QuantitySold": 0,
            "QuantitySplitOptions": [
                1
            ],
            "Row": "GA",
            "Section": "Lot C",
            "ShareTypeId": null,
            "StartSeat": null,
            "Status": {
                "Code": 0,
                "Message": "",
                "Succeeded": true
            },
            "SupplierTicketID": null,
            "TicketID": 525537899,
            "TicketSourceID": null,
            "VenueName": null,
            "dataType": "TE"
        }
    ]
}
                        
3. To GET shipping method (Task = shipping)

Test URL: https://www.pulseexperientialtravel.com/index.php?option=com_virtuemart&view=testresellerapi&task=shipping&version=2&resellerid=YOUR_RESELLER_ID

Live URL: https://www.pulseexperientialtravel.com/index.php?option=com_virtuemart&view=resellerapi&task=shipping&version=2&resellerid=YOUR_RESELLER_ID

GET Request with following parameters in header

[
SecurityToken:'XXXXXXXXXXXXXX',
Content-Type: ‘application/json',
Accept: 'application/json',
]

GET Method with parameter's

[
ticketId*: Ticket Id for which shipping details is required ,
dataType*: [string] This parameter is define the type of ticket ,
userAddressOne: This parameter accepts Address of end user of reseller(required for TE dataType ticket) [varchar(500)] ,
userAddressTwo: This parameter accepts Address of end user of reseller(required for TE dataType ticket) [varchar(500)],
userCity: This parameter accepts City of end user of reseller(required for TE dataType ticket) [varchar(100)] ,
userRegion: This parameter accepts Region of end user of reseller(required for TE dataType ticket) [varchar(100)] ,
userCountry: This parameter accepts Country of end user of reseller(required for TE dataType ticket) [varchar(100)] ,
userZip: This parameter accepts Zipcode of end user of reseller(required for TE dataType ticket) [varchar(50)] ,
]

Response Codes:

Value Name Description
0 Success Process completed and result received.
1 Failed Process not completed or not get desired response.
34 Restricted Access Data is not Accessible. Either security token or Reseller Id is Incorrect.
40 Invalid Method Header or parameter is missing.
45 Invalid input Content-Type not valid.
46 Value Missing Security Token is missing.
47 Value Missing Reseller ID is missing.
70 Invalid Method Request Method not valid.

Get Request response

{
    "Status": {
        "Succeeded": true,
        "StatusCode": 0,
        "StatusMessage": "The operation completed successfully."
    },
    "ShippingMethods": [
        {
            "B2BCost": 0,
            "IsElectronic": true,
            "Name": "Ticketmaster® Verified - Electronic Delivery",
            "ShippingMethodId": 14
        }
    ]
}
                        
4. To GET service charge details (Task = servicecharge)

Test URL: https://www.pulseexperientialtravel.com/index.php?option=com_virtuemart&view=testresellerapi&task=servicecharge&version=2&resellerid=YOUR_RESELLER_ID

Live URL: https://www.pulseexperientialtravel.com/index.php?option=com_virtuemart&view=resellerapi&task=servicecharge&version=2&resellerid=YOUR_RESELLER_ID

GET Request with following parameters in header

[
SecurityToken:'XXXXXXXXXXXXXX',
Content-Type: ‘application/json',
Accept: 'application/json',
]

GET Method with parameter's

[
ticketId*: Ticket Id for which shipping details is required ,
dataType*: [string] This parameter is define the type of ticket. ,
quantity*: This parameter accepts quantity of tickets to be purchased.
]

Response Codes:

Value Name Description
0 Success Process completed and result received.
1 Failed Process not completed or not get desired response.
34 Restricted Access Data is not Accessible. Either security token or Reseller Id is Incorrect.
40 Invalid Method Header or parameter is missing.
45 Invalid input Content-Type not valid.
46 Value Missing Security Token is missing.
47 Value Missing Reseller ID is missing.
70 Invalid Method Request Method not valid.

Get Request response

{
    "Status": {
        "Succeeded": true,
        "StatusCode": 0,
        "StatusMessage": "The operation completed successfully."
    },
    "ServiceChargeAmount": 0
}
                        
5. To get countries details (Task = countries)

Test URL: https://www.pulseexperientialtravel.com/index.php?option=com_virtuemart&view=testresellerapi&task=countries&version=2&resellerid=YOUR_RESELLER_ID

Live URL: https://www.pulseexperientialtravel.com/index.php?option=com_virtuemart&view=resellerapi&task=countries&version=2&resellerid=YOUR_RESELLER_ID

GET Request with following parameters in header

[
SecurityToken:'XXXXXXXXXXXXXX',
Content-Type: ‘application/json',
Accept: 'application/json',
]

Response Codes:

Value Name Description
0 Success Process completed and result received.
1 Failed Process not completed or not get desired response.
34 Restricted Access Data is not Accessible. Either security token or Reseller Id is Incorrect.
45 Invalid input Content-Type not valid.
46 Value Missing Security Token is missing.
47 Value Missing Reseller ID is missing.
70 Invalid Method Request Method not valid.

Get Request response

{
    "Status": {
        "Succeeded": true,
        "StatusCode": 0,
        "StatusMessage": "The operation completed successfully.",
        "Result": 1
    },
    "Countries": [
        {
            "CountryCode": "US",
            "CountryID": 1,
            "CountryName": "United States"
        }
    ]
}
                        
6. To GET regions details (Task = regions)

Test URL: https://www.pulseexperientialtravel.com/index.php?option=com_virtuemart&view=testresellerapi&task=regions&version=2&resellerid=YOUR_RESELLER_ID

Live URL: https://www.pulseexperientialtravel.com/index.php?option=com_virtuemart&view=resellerapi&task=regions&version=2&resellerid=YOUR_RESELLER_ID

GET Request with following parameters in header

[
SecurityToken:'XXXXXXXXXXXXXX',
Content-Type: ‘application/json',
Accept: 'application/json',
]

GET Method with parameter's

[
countryID*: country Id for which details is required ,
]

Response Codes:

Value Name Description
0 Success Process completed and result received.
1 Failed Process not completed or not get desired response.
34 Restricted Access Data is not Accessible. Either security token or Reseller Id is Incorrect.
40 Invalid Method Header or parameter is missing.
45 Invalid input Content-Type not valid.
46 Value Missing Security Token is missing.
47 Value Missing Reseller ID is missing.
70 Invalid Method Request Method not valid.

Get Request response

{
    "Status": {
        "Succeeded": true,
        "StatusCode": 0,
        "StatusMessage": "The operation completed successfully.",
        "Result": 2
    },
    "Regions": [
        {
            "CountryCode": "US",
            "RegionCode": "AL",
            "RegionID": 308,
            "RegionName": "Alabama"
        },
        {
            "CountryCode": "US",
            "RegionCode": "AK",
            "RegionID": 343,
            "RegionName": "Alaska"
        }
    ]
}
                        
7. Buy a ticket (Task = purchaserequest)

Test URL: https://www.pulseexperientialtravel.com/index.php?option=com_virtuemart&view=testresellerapi&task=purchaserequest&version=2&resellerid=YOUR_RESELLER_ID

Live URL: https://www.pulseexperientialtravel.com/index.php?option=com_virtuemart&view=resellerapi&task=purchaserequest&version=2&resellerid=YOUR_RESELLER_ID

GET Request with following parameters in header

[
SecurityToken:'XXXXXXXXXXXXXX',
Content-Type: ‘application/json',
Accept: 'application/json',
P-Authorization: 'EncryptedAuthKey',
P-TimeStamp: 'CurrentTimeStamp'
]

GET Method with parameter's

[
ticketId*: Ticket Id for which shipping details is required ,
dataType*: [string] This parameter is define the type of ticket(required for each ticket) ,
quantity*: This parameter takes the value of the quantity of tickets to be purchased (Quantity array for split tickets can retrieved from the Ticket Details API by passing single TicketID) [int(11)].
ShippingMethodID*: This will contains the ShippingMethodID that will be retrieved via the Shipping Method API,[ Pass 1 as shippingMethodID if Shipping method is not specified] [int(11)].
orderId*: In this parameter, the order id generated on the resellers website will be passed here. [varchar (200)].
userEmail*: This parameter accepts email ID of end user of reseller [varchar(200)].
userFirstName*: This parameter accepts First Name of end user of reseller [varchar(200)].
userLastName*: This parameter accepts Last Name of end user of reseller [varchar(200)].
userAddressOne*: This parameter accepts Address of end user of reseller [varchar(500)].
userAddressTwo: This parameter accepts Address of end user of reseller [varchar(500)].
userCity*: This parameter accepts City of end user of reseller [varchar(100)].
userRegion*: This parameter accepts Region of end user of reseller [varchar(100)].
userCountry*: This parameter accepts Country of end user of reseller [varchar(100)].
userZip*: This parameter accepts Zipcode of end user of reseller [varchar(50)].
userPhone*: This parameter accepts Phone of end user of reseller [varchar(20)].
]

Response Codes:

Value Name Description
0 Success Process completed and result received.
1 Failed Process not completed or not get desired response.
34 Restricted Access Data is not Accessible. Either security token or Reseller Id is Incorrect.
45 Invalid input Content-Type not valid.
46 Value Missing Security Token is missing.
47 Value Missing Reseller ID is missing.
70 Invalid Method Request Method not valid.

POST Request for the Orders

{
    "orderId":24002500,
    "orderData":[
        {
            "quantity":1,
            "ticketId":508267934,
            "ShippingMethodID":14,
            "ticketPrice":"175",
            "dataType":"TM"
       }
    ],
    "userEmail":"john@email.com",
    "userFirstName":"John",
    "userLastName ":"Doe",
    "userAddressOne":"Address1",
    "userAddressTwo":"Address2",
    "userCity":"City",
    "userRegion":"Region",
    "userCountry":"Country",
    "userZip":"Zip",
    "userPhone":"Phone",
    #Other modules parameters comes here
}
                        

Response for the Orders Purchased

{
    "Status": {
        "Succeeded": true,
        "StatusCode": "0",
        "StatusMessage": "The operation completed successfully.",
        "Code": "0",
        "Message": "The operation completed successfully."
    },
    "PulseOrderID": "PULSE966001",
    "OrderDetail": [
        {
            "purchaseStatus": true,
            "message": "pending",
            "ticketId": 508267934,
            "OrderID": 24002500,
            "dataType": "TM",
            "ticketPrice": 175,
            "quantity": 1
        }
    ],
    #Other modules response comes here
}
                        

Partial Payment module parameters with POST Request

    "isPartialpayment":true,	
    "totalAmount":"175",
    "partialAmount":"75",
    "cardType":"MasterCard",
    "cardNumber":"XXXXXXXXXXXXXXXX",
    "cvv":"XXX",
    "expMonth":"MM",
    "expYear":"YYYY",
    "nameOnCard":"John Doe",
    "billingInfo":{  
        "firstname":"John",
        "lastname":"Doe",
        "street":"Street",
        "city":"City",
        "state":"State/Region",
        "zip":"Zip code",
        "country":"Country"
    }
                        

Partial payment module Response

    "paymentDetail": {
        "Succeeded": true,
        "StatusCode": 0,
        "StatusMessage": "Approved"
    }
                        
8. To GET track ticket status (Task = ticketStatus)

Test URL: https://www.pulseexperientialtravel.com/index.php?option=com_virtuemart&view=testresellerapi&task=ticketStatus&version=2&resellerid=YOUR_RESELLER_ID

Live URL: https://www.pulseexperientialtravel.com/index.php?option=com_virtuemart&view=resellerapi&task=ticketStatus&version=2&resellerid=YOUR_RESELLER_ID

GET Request with following parameters in header

[
SecurityToken:'XXXXXXXXXXXXXX',
Content-Type: ‘application/json',
Accept: 'application/json',
]

GET Method with parameter's

[
OrderID*: order Id of ticket which details is required ,
]

Response Codes:

Value Name Description
0 Success Process completed and result received.
1 Failed Process not completed or not get desired response.
34 Restricted Access Data is not Accessible. Either security token or Reseller Id is Incorrect.
35 Data not available Order Id not found.
40 Value Missing Header or parameter is missing.
45 Invalid input Content-Type not valid.
46 Value Missing Security Token is missing.
47 Value Missing Reseller ID is missing.
70 Invalid Method Request Method not valid.

Response for the Orders Purchased

{
    "Status": {
        "Succeeded": true,
        "StatusCode": "0",
        "StatusMessage": "The operation completed successfully."
    },
    "shipments": [
        {
            "status": "pending",
            "type": "Eticket",
            "tracking_number": null,
            "tracking_url": null
        }
    ]
}
                        
Documentation Version : 2.7.1
Last Updated : 11-02-2019