URL: |
https://www.brownpapertickets.com/api2/cart |
|
Description: |
This portal is used to submit orders for tickets. The submit order process can be broken down into 4 stages:
Stage 1. Create Cart
Stage 2. Add Tickets to Cart - This stage is repeatable.
Stage 3. Submit Shipping Information - This stage is only required if physical tickets have been added to the cart.
Stage 4. Submit Billing Information and Finish Order
|
|
|
All Stages |
|
|
id |
- |
Developer ID - Available from your Developer Status page. |
|
stage |
- |
The current stage in the order submission process. Possible values include "1", "2", "3", or "4". |
|
|
Outputs: |
Returns a REST-Compliant XML feed containing the following variables:
resultcode |
|
|
300001 - Missing stage |
|
|
|
300002 - Unknown Error |
|
|
Stage 1 - Create Cart |
|
|
|
|
Outputs: |
resultcode |
|
|
000000 - Success. |
|
cart_id |
- |
Unique cart_id to be used during the order submission process. |
|
|
Stage 2 - Add Tickets |
|
|
cart_id |
- |
Unique cart_id as returned from Stage 1. |
|
price_id |
- |
Brown Paper Tickets' unique price tracking ID. The price's price_id can be found using the Price List feed. |
|
quantity |
- |
This is the quantity of tickets to be added to the cart at this price level. |
|
shipping |
- |
This is the shipping method to use for these tickets. Must be an integer value between 1 and 5:
- 1 = Physical Tickets
- 2 = Will-Call
- 3 = Print-At-Home
- 4 = Mobile
- 5 = Online Access
|
|
ref |
- |
This variable may contain a valid Affiliate ID. The supplied affiliate account will receive a commission for this order. |
|
|
Outputs: |
resultcode |
|
|
300001 - Missing stage |
|
|
|
300003 - Missing cart_id |
|
|
|
300004 - Unknown error |
|
|
|
300005 - Cart has timed out |
|
|
|
300006 - Missing price_id |
|
|
|
300007 - Cart already closed |
|
|
|
300008 - Invalid price_id |
|
|
|
300009 - Missing quantity |
|
|
|
300010 - Missing shipping |
|
|
|
300011 - No such price |
|
|
|
300012 - Shipping method not available |
|
|
|
300013 - Not enough tickets available |
|
|
|
300014 - Unknown error |
|
|
|
300015 - Not enough tickets available |
|
|
|
000000 - Success |
|
|
Stage 3 - Shipping Information |
|
|
cart_id |
- |
Unique cart_id as returned from Stage 1. |
|
fname |
- |
Shipping first name of the person receiving the tickets. |
|
lname |
- |
Shipping last name of the person receiving the tickets. |
|
address |
- |
Shipping address of the person receiving the tickets. |
|
city |
- |
Shipping city of the person receiving the tickets. |
|
state |
- |
Shipping state of the person receiving the tickets. |
|
zip |
- |
Shipping zip/postal code of the person receiving the tickets. |
|
country |
- |
Shipping country of the person receiving the tickets. Values include "United States" and "Canada". |
|
attendee_lname (Optional) |
- |
This is the attendee last name to use for these tickets. This person will have to present ID at the event for admission. If supplied, both first and last name must be supplied. |
|
attendee_fname (Optional) |
- |
This is the attendee last name to use for these tickets. This person will have to present ID at the event for admission. If supplied, both first and last name must be supplied. |
|
|
Outputs: |
resultcode |
|
|
300001 - Missing stage |
|
|
|
300003 - Missing cart_id |
|
|
|
300005 - Cart has timed out |
|
|
|
300016 - No tickets in cart |
|
|
|
300017 - Required information is missing |
|
|
|
300018 - Invalid country. Country should be capitalized full spelling of country. Example: "United States", "United Kingdom", etc. |
|
|
|
300019 - Unknown error while updating order |
|
|
|
0000 - Success. |
|
|
Stage 4 - Billing Information |
|
|
cart_id |
- |
Unique cart_id as returned from Stage 1. |
|
type |
- |
This is the type of credit card being used for the purchase. Values include "Visa", "Mastercard", "Discover", or "Amex". May be blank when finalizing orders containing only free tickets. |
|
number |
- |
This is the credit card number used for the purchase. May be blank when finalizing orders containing only free tickets. You may use "1234567890000000" to submit a test transaction. Cart will not be recorded, but will return code Success 000001. |
|
exp_month |
- |
This is the 2-digit expiration month on the credit card. May be blank when finalizing orders containing only free tickets. |
|
exp_year |
- |
This is the 4-digit expiration year on the credit card. May be blank when finalizing orders containing only free tickets. |
|
cvv2 |
- |
This is the credit card verification code located on the credit card's signature box. May be blank when finalizing orders containing only free tickets. |
|
billing_fname |
- |
This is the billing first name for the credit card. |
|
billing_lname |
- |
This is the billing last name for the credit card. |
|
billing_address |
- |
This is the billing address for the credit card. May be blank when finalizing orders containing only free tickets. |
|
billing_city |
- |
This is the billing city for the credit card. May be blank when finalizing orders containing only free tickets. |
|
billing_state |
- |
This is the billing state for the credit card. May be blank when finalizing orders containing only free tickets. |
|
billing_zip |
- |
This is the billing zip/postal code for the credit card. May be blank when finalizing orders containing only free tickets. |
|
billing_country |
- |
This is the billing country for the credit card. May be blank when finalizing orders containing only free tickets. |
|
email |
- |
This is the ticket buyer's email address. May be blank when finalizing orders containing only free tickets. |
|
phone |
- |
This is the ticket buyer's phone number. May be blank when finalizing orders containing only free tickets. |
|
|
Outputs: |
resultcode |
|
|
300001 - Missing stage |
|
|
|
300003 - Missing cart_id |
|
|
|
300005 - Cart has timed out |
|
|
|
300016 - No tickets in cart |
|
|
|
300020 - Required information is missing |
|
|
|
300021 - Required information is missing |
|
|
|
300022 - Required information is missing |
|
|
|
300023 - Required information is missing |
|
|
|
300024 - Invalid credit card type |
|
|
|
300025 - Invalid email |
|
|
|
300026 - Credit card rejected |
|
|
|
000000 - Success. |
|
|
|
000001 - Success. Test Mode. |
|
pahurl |
|
URL for print-at-home tickets. Only appears when Print-At-Home delivery is chosen. |
|