Add To Order
Summary
These set of APIs will let you:
1. Add to Order
End Points:
AddToOrder
Response
Field | DataType | Description |
---|---|---|
AuthKey | String | Authentication key provided to access the API endpoint to retrieve data from CDS. |
OrderNumber | Integer | A unique ID provided to an order |
IsPrimary | Boolean | First record in an order |
ThirdPartyKey | String | Used to store third party key. |
FirstName | String | First name (Legal First name) of the attendee |
MiddleInitial | String | Middle initial (Legal first initial of the middle name) of the attendee |
LastName | String | Last name (Legal Last name (Surname)) of the attendee |
NickName | String | A secondary name for the attendee. |
Degree | String | Educational certification provided to the Attendee |
Title | String | Work title provided by a registrants company |
Company | String | Company the registrant represents |
Street | String | House/Building number and street name |
Street2 | String | Additional street address field |
Street3 | String | Additional street address field |
City | String | Registrant residential city |
State | String | Registrant residential state |
ZipCode | String | Registrant residential zipcode |
Country | String | Registrant residential country |
Phone | String | Registrants phone number |
CellPhone | String | Registrants mobile phone number |
Ext | String | Registrants phone extension |
Fax | String | Registrants fax number |
String | Registrants email | |
HandicapBtn | String | Extra data field requested by clients. Used to indicate if service is required. |
LrOption | Integer | Flag to indicate LR opt in/out option |
MethodID | Integer | Method how registration was received. |
RegClass | String | Attendees registration class. (RegClasses are defined by clients) |
Promo1 | String | Promo code to provide discounts to the customer. |
Promo2 | String | Promo code to provide discounts to the customer. |
EB | String | Username for manually entered registrations. |
RegTimeStamp | String | Date and time stamp when the Attendee registered for the event. |
Verified | String | Date and time registrant was verified as attending the event. |
Association | String | Defined by the client and is often the clients member number for the registrant or something similar. |
BatchTag | String | Tag assigned to record based on method. |
RegNotes | String | Registrant notes |
GuestOf | Integer | Guest of which Attendee |
EmailConf | String | Date and time the last email confirmation was sent. |
FaxConf | String | NO LONGER IN USE |
MailConf | String | NO LONGER IN USE |
ConfCount | Integer | Indicates a confirmation was sent. |
MailBadge | Boolean | Mail or hold badge indicator |
BadgePrinted | String | Last Date and Time badge was printed. |
BadgePrintedOrg | String | First Date and Time badge was printed. |
BadgePrintedcnt | String | Count of how many times badge was printed. |
HandicapText | String | Extra data field requested by clients. Used to capture service required. |
VipCode | String | Promo code to provide discounts to the customer. |
Prefix | String | Prefix for the Attendee (Ex. DR, MS, MR) |
ExtraInfo Fields 1- 100 | String | Extra Data fields requested by clients. |
GdprOptIn | Integer | EU General Data Protection Regulation opt in flag |
WebSiteURL | String | Extra data field requested by clients. Primarily used for Attendees company website. |
Demos | Array | Demos tied to the record |
Key | Integer | Demo key |
Badge | Integer | Unique ID given to a Registrant. |
DemoID | Integer | A unique ID for an Event provided to a demographic question (This ID is unique to 1 event and be utilized in another event) |
AnswerID | String | A unique ID for an Event provided to a demographic answer (This ID is unique to 1 event and be utilized in another event) |
OtherText | String | The free form text response of a registrant to the demographic question |
ThirdPartyKey | String | Used to store third party key. |
RecordStatus | Integer | Status flag indicating whether the record is active or not. |
Items | String | Items tied to the record |
OrderNumber | Integer | A unique ID provided to an order |
ItemCode | String | Unique code provided to an Item |
Qty | Integer | Number of Items purchased. |
Badge | Integer | Unique ID given to a Registrant. |
ItemPriceKey | Integer | Item key associated with a specific price point |
ItemDate | String | Date the Item was purchased |
ItemStatus | String | Status flag of item: A(ctive), R(emoved), U(pgrade), W(aitlist) |
ModifiedBy | String | Person the record was changed by. |
ItemNotes | String | Notes created for the item |
PrintTicket | Integer | Flag indicating if the item is printable as ticket |
PackageItemKey | Integer | Key value of primary item of package |
PaymentKey | Integer | Payment key |
ModifiedDate | String | Date the order was modified |
ThirdPartyKey | String | Used to store third party key. |
RecordStatus | Integer | Status flag indicating whether the record is active or not. |
PackageKey | Integer | Key value of packaged items |
TaxTypeID | Integer | Determines the type of item to be taxed. |
ConsumptionID | Integer | Indicates consumption tax applied (Onsite or Offsite) |
TaxCategoryID | Integer | Unique identifier assigned to a particular tax category chosen by the client. The Tax category ID is derived from the provider of the Tax software. |
TaxRate | Number | Amount of tax charged |
TaxAmount | Number | Amount charged for tax purposes |
Price | String | Cost of the item |
ItemPriceTier 1 - 5 | String | Pricing Tiers set by client |
Promocode | String | Promo code to provide discounts to the customer. |
Base URL
The base URL for all API endpoints is:
https://bridge.cdsreg.com/
Add Exhibitor
URL:
https://bridge.cdsreg.com/Registration/AddToOrder
Method: Post
Example Request:
{
"AuthKey": "Omitted",
"OrderNumber": 0,
"IsPrimary": true,
"ThirdPartyKey": "string",
"FirstName": "string",
"MiddleInitial": "string",
"LastName": "string",
"NickName": "string",
"Degree": "string",
"Title": "string",
"Company": "string",
"Street": "string",
"Street2": "string",
"Street3": "string",
"City": "string",
"State": "string",
"Zipcode": "string",
"Country": "string",
"Phone": "string",
"CellPhone": "string",
"Ext": "string",
"Fax": "string",
"Email": "string",
"HandicapBtn": "s",
"LrOption": 0,
"MethodId": 0,
"RegClass": "string",
"Promo1": "string",
"Promo2": "string",
"Eb": "string",
"RegTimeStamp": "2024-03-14T04:01:48.043Z",
"Verified": "2024-03-14T04:01:48.043Z",
"Association": "string",
"BatchTag": "string",
"RegNotes": "string",
"GuestOf": 0,
"EmailConf": "2024-03-14T04:01:48.043Z",
"FaxConf": "2024-03-14T04:01:48.043Z",
"MailConf": "2024-03-14T04:01:48.043Z",
"ConfCount": 0,
"MailBadge": true,
"BadgePrinted": "2024-03-14T04:01:48.043Z",
"BadgePrintedOrg": "2024-03-14T04:01:48.043Z",
"BadgePrintedCnt": 0,
"HandicapText": "string",
"VipCode": "string",
"Prefix": "string",
"ExtraInfo1": "string",
"ExtraInfo2": "string",
"ExtraInfo3": "string",
"ExtraInfo4": "string",
"ExtraInfo5": "string",
"ExtraInfo6": "string",
"ExtraInfo7": "string",
"ExtraInfo8": "string",
"ExtraInfo9": "string",
"ExtraInfo10": "string",
"ExtraInfo11": "string",
"ExtraInfo12": "string",
"ExtraInfo13": "string",
"ExtraInfo14": "string",
"ExtraInfo15": "string",
"ExtraInfo16": "string",
"ExtraInfo17": "string",
"ExtraInfo18": "string",
"ExtraInfo19": "string",
"ExtraInfo20": "string",
"ExtraInfo21": "string",
"ExtraInfo22": "string",
"ExtraInfo23": "string",
"ExtraInfo24": "string",
"ExtraInfo25": "string",
"ExtraInfo26": "string",
"ExtraInfo27": "string",
"ExtraInfo28": "string",
"ExtraInfo29": "string",
"ExtraInfo30": "string",
"ExtraInfo31": "string",
"ExtraInfo32": "string",
"ExtraInfo33": "string",
"ExtraInfo34": "string",
"ExtraInfo35": "string",
"ExtraInfo36": "string",
"ExtraInfo37": "string",
"ExtraInfo38": "string",
"ExtraInfo39": "string",
"ExtraInfo40": "string",
"ExtraInfo41": "string",
"ExtraInfo42": "string",
"ExtraInfo43": "string",
"ExtraInfo44": "string",
"ExtraInfo45": "string",
"ExtraInfo46": "string",
"ExtraInfo47": "string",
"ExtraInfo48": "string",
"ExtraInfo49": "string",
"ExtraInfo50": "string",
"ExtraInfo51": "string",
"ExtraInfo52": "string",
"ExtraInfo53": "string",
"ExtraInfo54": "string",
"ExtraInfo55": "string",
"ExtraInfo56": "string",
"ExtraInfo57": "string",
"ExtraInfo58": "string",
"ExtraInfo59": "string",
"ExtraInfo60": "string",
"ExtraInfo61": "string",
"ExtraInfo62": "string",
"ExtraInfo63": "string",
"ExtraInfo64": "string",
"ExtraInfo65": "string",
"ExtraInfo66": "string",
"ExtraInfo67": "string",
"ExtraInfo68": "string",
"ExtraInfo69": "string",
"ExtraInfo70": "string",
"ExtraInfo71": "string",
"ExtraInfo72": "string",
"ExtraInfo73": "string",
"ExtraInfo74": "string",
"ExtraInfo75": "string",
"ExtraInfo76": "string",
"ExtraInfo77": "string",
"ExtraInfo78": "string",
"ExtraInfo79": "string",
"ExtraInfo80": "string",
"ExtraInfo81": "string",
"ExtraInfo82": "string",
"ExtraInfo83": "string",
"ExtraInfo84": "string",
"ExtraInfo85": "string",
"ExtraInfo86": "string",
"ExtraInfo87": "string",
"ExtraInfo88": "string",
"ExtraInfo89": "string",
"ExtraInfo90": "string",
"ExtraInfo91": "string",
"ExtraInfo92": "string",
"ExtraInfo93": "string",
"ExtraInfo94": "string",
"ExtraInfo95": "string",
"ExtraInfo96": "string",
"ExtraInfo97": "string",
"ExtraInfo98": "string",
"ExtraInfo99": "string",
"ExtraInfo100": "string",
"GdprOptIn": 0,
"WebsiteUrl": "string",
"Demos": [
{
"Key": 0,
"Badge": 0,
"DemoId": 0,
"AnswerId": "string",
"OtherText": "string",
"ThirdPartyKey": "string",
"RecordStatus": 0
}
],
"Items": [
{
"OrderNumber": 0,
"ItemCode": "string",
"Qty": 0,
"Badge": 0,
"ItemPriceKey": 0,
"ItemDate": "2024-03-14T04:01:48.043Z",
"ItemStatus": "strin",
"ModifiedBy": "string",
"ItemNotes": "string",
"PrintTicket": 0,
"PackageItemKey": 0,
"PaymentKey": 0,
"ModifiedDate": "2024-03-14T04:01:48.043Z",
"ThirdPartyKey": "string",
"RecordStatus": 0,
"PackageKey": 0,
"TaxTypeId": 0,
"ConsumptionId": 0,
"TaxCategoryId": 0,
"TaxRate": 0,
"TaxAmount": 0,
"Price": 0,
"ItemPriceTier": "string",
"ItemPriceTier2": "string",
"ItemPriceTier3": "string",
"ItemPriceTier4": "string",
"ItemPriceTier5": "string",
"PromoCode": "string"
}
]
}
Example Response:
"AuthKey": "Omitted",
"OrderNumber": 0,
"IsPrimary": true,
"ThirdPartyKey": "string",
"FirstName": "string",
"MiddleInitial": "string",
"LastName": "string",
"NickName": "string",
"Degree": "string",
"Title": "string",
"Company": "string",
"Street": "string",
"Street2": "string",
"Street3": "string",
"City": "string",
"State": "string",
"Zipcode": "string",
"Country": "string",
"Phone": "string",
"CellPhone": "string",
"Ext": "string",
"Fax": "string",
"Email": "string",
"HandicapBtn": "s",
"LrOption": 0,
"MethodId": 0,
"RegClass": "string",
"Promo1": "string",
"Promo2": "string",
"Eb": "string",
"RegTimeStamp": "2024-03-14T04:01:48.043Z",
"Verified": "2024-03-14T04:01:48.043Z",
"Association": "string",
"BatchTag": "string",
"RegNotes": "string",
"GuestOf": 0,
"EmailConf": "2024-03-14T04:01:48.043Z",
"FaxConf": "2024-03-14T04:01:48.043Z",
"MailConf": "2024-03-14T04:01:48.043Z",
"ConfCount": 0,
"MailBadge": true,
"BadgePrinted": "2024-03-14T04:01:48.043Z",
"BadgePrintedOrg": "2024-03-14T04:01:48.043Z",
"BadgePrintedCnt": 0,
"HandicapText": "string",
"VipCode": "string",
"Prefix": "string",
"ExtraInfo1": "string",
"ExtraInfo2": "string",
"ExtraInfo3": "string",
"ExtraInfo4": "string",
"ExtraInfo5": "string",
"ExtraInfo6": "string",
"ExtraInfo7": "string",
"ExtraInfo8": "string",
"ExtraInfo9": "string",
"ExtraInfo10": "string",
"ExtraInfo11": "string",
"ExtraInfo12": "string",
"ExtraInfo13": "string",
"ExtraInfo14": "string",
"ExtraInfo15": "string",
"ExtraInfo16": "string",
"ExtraInfo17": "string",
"ExtraInfo18": "string",
"ExtraInfo19": "string",
"ExtraInfo20": "string",
"ExtraInfo21": "string",
"ExtraInfo22": "string",
"ExtraInfo23": "string",
"ExtraInfo24": "string",
"ExtraInfo25": "string",
"ExtraInfo26": "string",
"ExtraInfo27": "string",
"ExtraInfo28": "string",
"ExtraInfo29": "string",
"ExtraInfo30": "string",
"ExtraInfo31": "string",
"ExtraInfo32": "string",
"ExtraInfo33": "string",
"ExtraInfo34": "string",
"ExtraInfo35": "string",
"ExtraInfo36": "string",
"ExtraInfo37": "string",
"ExtraInfo38": "string",
"ExtraInfo39": "string",
"ExtraInfo40": "string",
"ExtraInfo41": "string",
"ExtraInfo42": "string",
"ExtraInfo43": "string",
"ExtraInfo44": "string",
"ExtraInfo45": "string",
"ExtraInfo46": "string",
"ExtraInfo47": "string",
"ExtraInfo48": "string",
"ExtraInfo49": "string",
"ExtraInfo50": "string",
"ExtraInfo51": "string",
"ExtraInfo52": "string",
"ExtraInfo53": "string",
"ExtraInfo54": "string",
"ExtraInfo55": "string",
"ExtraInfo56": "string",
"ExtraInfo57": "string",
"ExtraInfo58": "string",
"ExtraInfo59": "string",
"ExtraInfo60": "string",
"ExtraInfo61": "string",
"ExtraInfo62": "string",
"ExtraInfo63": "string",
"ExtraInfo64": "string",
"ExtraInfo65": "string",
"ExtraInfo66": "string",
"ExtraInfo67": "string",
"ExtraInfo68": "string",
"ExtraInfo69": "string",
"ExtraInfo70": "string",
"ExtraInfo71": "string",
"ExtraInfo72": "string",
"ExtraInfo73": "string",
"ExtraInfo74": "string",
"ExtraInfo75": "string",
"ExtraInfo76": "string",
"ExtraInfo77": "string",
"ExtraInfo78": "string",
"ExtraInfo79": "string",
"ExtraInfo80": "string",
"ExtraInfo81": "string",
"ExtraInfo82": "string",
"ExtraInfo83": "string",
"ExtraInfo84": "string",
"ExtraInfo85": "string",
"ExtraInfo86": "string",
"ExtraInfo87": "string",
"ExtraInfo88": "string",
"ExtraInfo89": "string",
"ExtraInfo90": "string",
"ExtraInfo91": "string",
"ExtraInfo92": "string",
"ExtraInfo93": "string",
"ExtraInfo94": "string",
"ExtraInfo95": "string",
"ExtraInfo96": "string",
"ExtraInfo97": "string",
"ExtraInfo98": "string",
"ExtraInfo99": "string",
"ExtraInfo100": "string",
"GdprOptIn": 0,
"WebsiteUrl": "string",
"Demos": [
{
"Key": 0,
"Badge": 0,
"DemoId": 0,
"AnswerId": "string",
"OtherText": "string",
"ThirdPartyKey": "string",
"RecordStatus": 0
}
],
"Items": [
{
"OrderNumber": 0,
"ItemCode": "string",
"Qty": 0,
"Badge": 0,
"ItemPriceKey": 0,
"ItemDate": "2024-03-14T04:01:48.043Z",
"ItemStatus": "strin",
"ModifiedBy": "string",
"ItemNotes": "string",
"PrintTicket": 0,
"PackageItemKey": 0,
"PaymentKey": 0,
"ModifiedDate": "2024-03-14T04:01:48.043Z",
"ThirdPartyKey": "string",
"RecordStatus": 0,
"PackageKey": 0,
"TaxTypeId": 0,
"ConsumptionId": 0,
"TaxCategoryId": 0,
"TaxRate": 0,
"TaxAmount": 0,
"Price": 0,
"ItemPriceTier": "string",
"ItemPriceTier2": "string",
"ItemPriceTier3": "string",
"ItemPriceTier4": "string",
"ItemPriceTier5": "string",
"PromoCode": "string"
}
]
}'
Error Responses
404 Bad Request:
If [describe the error condition].
Example Error Response:
{
"RecordCount": 0,
"StatusCode": 404,
"ReturnMessages": [
"Order 0 not found"
],
"Success": false,
"BadgeNumber": 0
}