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”?
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”?
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=resellerBelow 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:
Common parameters in header
[Common parameters in Request
[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.
GET Request with following parameters in header
[GET Request with following parameters in URL
[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" } ] }
GET Request with following parameters in header
[GET Request with following parameters in URL
[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" } ] }
GET Request with following parameters in header
[GET Request with following parameters in URL
[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" } ] }
GET Request with following parameters in header
[GET Request with following parameters in URL
[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" } ] }
GET Request with following parameters in header
[GET Request with following parameters in URL
[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" } ] }
GET Request with following parameters in header
[GET Request with following parameters in URL
[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" } } } } } } } } ] }
GET Request with following parameters in header
[GET Request with following parameters in URL
[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" } } } } } } } } ] }
GET Request with following parameters in header
[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" } }
GET Request with following parameters in header
[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 }
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."
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" }
GET Request with following parameters in header
[GET Method with parameter's
[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" } }
GET Request with following parameters in header
[GET Method with parameter's
Parameter | Description |
---|---|
category_id | The ID of the specific Category |
parent_id | The ID of a parent Category. |
*If category_id is provide in request than other parameters will be excluded.
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, "Message": "The operation completed successfully.", "Result": 1 }, "categories": [ { "name": "Musicals", "id": "69", "updated_at": "2014-05-08T16:01:58Z", "parent": { "name": "Theatre", "id": "68", "updated_at": "2014-05-08T16:01:58Z", "parent": null }, "publish": true } ] }
GET Request with following parameters in header
[GET Method with parameter's
Parameter | Description |
---|---|
pageSize | This parameter accepts page size to be displayed - Defaults to 100. |
pageNumber | This parameter accepts Page number to be displayed - Defaults to 1 |
performer_id | The ID of the specific Performer |
venue_id | ID of the Performer’s home venue (most performers do not have one) |
category_id | Show only Performers in this category (does not include sub-categories) |
category_tree | When true and used in conjunction with category_id performers in sub-categories of the category_id will be included |
name | Exact name of the Performer when searching for a Performer by name. |
search | Search term(s) |
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, "Message": "The operation completed successfully.", "Result": 1 }, "performers": [ { "id": 15649, "name": "New York Jets", "keywords": "", "popularity_score": "0.87", "updated_at": "2014-05-08T13:08:35Z", "upcoming_events": { "first": null, "last": null }, "venue": { "id": 7074, "name": "MetLife Stadium", "updated_at": "2014-05-08T13:11:34Z", "address": { "street_address": "102 Route 120", "extended_address": null, "locality": "East Rutherford", "region": "NJ", "postal_code": "07073", "country_code": "US", "created_at": "2012-04-12T03:36:38Z" } }, "category": { "id": "20", "name": "NFL", "parent": { "id": "19", "name": "Football", "parent": { "id": "1", "name": "Sports", "parent": null } }, "publish": true }, "opponents": [], "venues": [] } ] }
GET Request with following parameters in header
[GET Method with parameter's
Parameter | Description |
---|---|
pageSize | This parameter accepts page size to be displayed - Defaults to 100. |
pageNumber | This parameter accepts Page number to be displayed - Defaults to 1 |
search | Search term(s) |
lat | Latitude & longitude for geolocated searches. Control size of geolocation area using within. Must supply both. |
lon | |
within | Radius in miles for geolocated searches (default 15) |
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, "Message": "The operation completed successfully.", "Result": 1 }, "venues": [ { "id": 33428, "name": "Treasure Island - Las Vegas", "keywords": "", "popularity_score": "0.0", "location": null, "country_code": null, "updated_at": "2017-02-01T14:26:59Z", "address": null, "upcoming_events": { "first": null, "last": null } } ] }
GET Request with following parameters in header
[GET Method with parameter's
Parameter | Description |
---|---|
pageSize | This parameter accepts page size to be displayed - Defaults to 100. |
pageNumber | This parameter accepts Page number to be displayed - Defaults to 1 |
venue_id | Venue at which the event occurs. |
name | Exact name of the event when searching for events by name. |
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. |
performer_id | Show only events at which this performer will perform. |
primary_performer | If primary_performer is true only events where performer_id is the Primary performer for the event will be returned. If primary_performer is false only events where performer_id is the NOT the Primary performer for the event will be returned. |
category_id | Show only events in this category (does not include sub-categories) |
category_tree | When true and used in conjunction with category_id events in sub-categories of the category_id will be included. |
within | Radius in miles for geolocated searches (default 15) |
only_with_tickets | [String [all | etickets]] Show only events that have inventory irregardless of whether they are available for sale (All states will be shown). If you want only available tickets, use only_with_available_tickets |
by_time | [String [day | night]] Show only events whose start time is during the day (between 4 AM-4 PM) or night (otherwise). |
only_with_available_tickets | Show only events that have available tickets (tickets for sale). Pass with office_id for inventory belonging only to your office. |
searchType |
0. Search by event name 1. Search by city state 2. Search by latitude longitude 3. Search by performer |
searchKey |
[for searchType 0,1,3] searchType : 0 - event name string searchType : 1 - city state with comma separated [ex. New York, NY] searchType : 3 - Exact name of the Performer |
lat | [only searchType 2] Latitude & longitude for geolocated searches. Control size of geolocation area using within. Must supply both. |
lng |
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" } ] }
GET Request with following parameters in header
[GET Method with parameter's
Parameter | Description |
---|---|
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" } ] }
GET Request with following parameters in header
[GET Method with parameter's
Parameter | Description |
---|---|
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 } ] }
GET Request with following parameters in header
[GET Method with parameter's
Parameter | Description |
---|---|
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 }
GET Request with following parameters in header
[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" } ] }
GET Request with following parameters in header
[GET Method with parameter's
Parameter | Description |
---|---|
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" } ] }
GET Request with following parameters in header
[GET Method with parameter's
Parameter | Description |
---|---|
pageSize | This parameter accepts page size to be displayed - Defaults to 100. |
pageNumber | This parameter accepts Page number to be displayed - Defaults to 1 |
city_id | The ID of the specific City |
search | Search term(s) |
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, "Message": "The operation completed successfully.", "Result": 1 }, "cities": [ { "city_id": "2", "name": "Abbeville", "state_code": "AL" } ] }
GET Request with following parameters in header
[GET Method with parameter's
Parameter | Description |
---|---|
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 Purchased
{ "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":"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" }
GET Request with following parameters in header
[GET Method with parameter's
Parameter | Description |
---|---|
OrderID* | Order Id of ticket which details is required. |
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. |
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 } ] }