| URL: |
https://www.brownpapertickets.com/api/submitorder.html |
| |
| 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 |
| |
|
| l |
- |
Login name for your Brown Paper Tickets account. |
| |
| p |
- |
Password for your Brown Paper Tickets account. |
| |
| stage |
- |
The current stage in the order submission process. Possible values include "1", "2", "3", or "4". |
|
| |
| Outputs: |
Returns a plain text 4-character result code and additional information when available. Follows the format: "Code:xxxx:Additional Information:" where "xxxx" is the result code. The possible 4 character codes are listed below.
| 9999 |
- |
Required variables are missing |
|
|
Stage 1 - Create Cart |
| |
|
|
| |
| Outputs: |
| 1111 |
- |
Unknown error while creating cart |
| |
| 0000:CART_ID |
- |
Success. Includes the 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 Date Details 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. Values may include "1" for physical tickets via USPS 1st Class Mail or "2" for ticketless will-call entry. |
| |
| ref |
- |
This variable may contain a valid Affiliate ID. The supplied affiliate account will receive a commission for this order. |
|
| |
| Outputs: |
| 8888 |
- |
Missing cart_id |
| |
| 7777 |
- |
Cart has timed out |
| |
| 6666 |
- |
Missing price_id |
| |
| 6660 |
- |
Invalid price_id |
| |
| 5555 |
- |
Missing quantity |
| |
| 4444 |
- |
Missing shipping |
| |
| 3333 |
- |
Not enough tickets available |
| |
| 2222 |
- |
Shipping method not available |
| |
| 1111 |
- |
Unknown error while creating order |
| |
| 1110 |
- |
Unknown error while assigning seats |
| |
| 0000:CART VALUE:NEEDS STAGE 3 |
- |
Success. Includes the value of the cart, including service fee but not including possible international shipping fee, as a floating point number. Also includes a "1" if Stage 3 is required before finalizing the order (ie. physical tickets have been entered into the cart, but shipping information has not been collected) and a "0" if Stage 3 is not required. |
|
|
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: |
| 8888 |
- |
Missing cart_id |
| |
| 7777 |
- |
Cart has timed out |
| |
| 3333 |
- |
Required information is missing |
| |
| 6666 |
- |
Invalid country - Must be "United States" or "Canada" |
| |
| 1111 |
- |
Unknown error while updating order |
| |
| 0000:CART VALUE:NEEDS STAGE 3 |
- |
Success. Includes the value of the cart, including service fee and possible international shipping fee, as a floating point number. Also includes a "1" if Stage 3 is required before finalizing the order (ie. physical tickets have been entered into the cart, but shipping information has not been collected) and a "0" if Stage 3 is not required. |
|
|
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. |
| |
| 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: |
| 8888 |
- |
Missing cart_id |
| |
| 7777 |
- |
Cart has timed out |
| |
| 6666 |
- |
Required shipping information has not been submitted |
| |
| 5555 |
- |
Invalid credit card type |
| |
| 4444 |
- |
Invalid email |
| |
| 3333 |
- |
Required information is missing |
| |
| 2222:REASON |
- |
Credit card rejected - Includes the reason for rejection, as provided by the credit card processor |
| |
| 1111 |
- |
Unknown error while updating order |
| |
| 0000 |
- |
Success. |
| |
| 0001 |
- |
Success. Test Mode. |
|
