Message: Order Created
Description: Order creation is a new order placed online by a customer. You may want to automate inventory management, fulfillment or setup of login credentials based on this message.
Recurring order creation is a special case of order creation; if any item ordered is recurring, the recurring parameter will be set to 1, otherwise, it will be set to 0. Please Note: Recurring order examples follow the below table.
Please note the initial installment billed often differs in price from the installments due to startup fees. Order Created is an invoice level message; it will be sent once for each new sale and will contain information about all items ordered.
Within each message section page, the parameters highlighted (like this *) are the parameters we believe will be most useful in updating your systems, or which are most relevant to that specific message.
NOTE: md5_hash values used in the following examples are NOT necessarily valid. MD5 is a data encryption algorithm which will help you validate that INS POSTs came from 2Checkout. >>More about MD5
| Ex. Order created | Ex. Order created with 3 products |
|---|---|
| message_type=ORDER_CREATED * | message_type=ORDER_CREATED * |
| message_description=New order created | message_description=New order created |
| timestamp=2007-12-01 15:30:44 | timestamp=2007-12-01 15:30:44 |
| md5_hash=99229B8BD0828FBC41CD0FE5DD80A7C0 | md5_hash=99229B8BD0828FBC41CD0FE5DD80A7C0 |
| message_id=1 | message_id=1 |
| key_count=56 | key_count=82 |
| vendor_id=12345 | vendor_id=12345 |
| sale_id=2223334445 * | sale_id=2223334445 * |
| sale_date_placed=2007-01-01 15:30:44 | sale_date_placed=2007-01-01 15:30:44 |
| vendor_order_id=promo12345 * | vendor_order_id=promo12345 * |
| invoice_id=234567890 * | invoice_id=234567890 * |
| recurring=0 | recurring=0 |
| payment_type=credit card | payment_type=credit card |
| list_currency=GBP | list_currency=GBP |
| cust_currency=JPY | cust_currency=JPY |
| auth_exp=2007-01-08 | auth_exp=2007-01-08 |
| invoice_status=approved | invoice_status=approved |
| fraud_status=wait | fraud_status=wait |
| invoice_list_amount=5.00 | invoice_list_amount=15.00 |
| invoice_usd_amount=2.50 * | invoice_usd_amount=7.50 * |
| invoice_cust_amount=250 | invoice_cust_amount=750 |
| customer_first_name=John | customer_first_name=John |
| customer_last_name=Smith | customer_last_name=Smith |
| customer_name=John Smith | customer_name=John Smith |
| customer_email=jsmith@yahoo.com | customer_email=jsmith@yahoo.com |
| customer_phone=6149212450 | customer_phone=6149212450 |
| customer_ip=1.1.1.1 | customer_ip=1.1.1.1 |
| customer_ip_country=United States | customer_ip_country=Satellite Provider |
| bill_street_address=55 Lane Ave. | bill_street_address=55 Lane Ave. |
| bill_street_address2= | bill_street_address2= |
| bill_city=Mytown | bill_city=Mytown |
| bill_state=NV | bill_state=NV |
| bill_postal_code=55555 | bill_postal_code=55555 |
| bill_country=USA | bill_country=USA |
| ship_status=not_shipped | ship_status=not_shipped |
| ship_tracking_number= | ship_tracking_number= |
| ship_name=June Cleaver | ship_name=June Cleaver |
| ship_street_address=123 Main St. | ship_street_address=123 Main St. |
| ship_street_address2=Apt. B | ship_street_address2=Apt. B |
| ship_city=Anytown | ship_city=Anytown |
| ship_state=OH | ship_state=OH |
| ship_postal_code=12345 | ship_postal_code=12345 |
| ship_country=USA | ship_country=USA |
| item_count=1 | item_count=3 |
| item_name_1=t-shirt | item_name_1=t-shirt |
| item_id_1=12 * | item_id_1=12 * |
| item_list_amount_1=5.00 | item_list_amount_1=5.00 |
| item_usd_amount_1=2.50 | item_usd_amount_1=2.50 |
| item_cust_amount_1=250 | item_cust_amount_1=250 |
| item_type_1=bill | item_type_1=bill |
| item_duration_1= | item_duration_1= |
| item_recurrence_1= | item_recurrence_1= |
| item_rec_list_amount_1= | item_rec_list_amount_1= |
| item_rec_status_1= | item_rec_status_1= |
| item_rec_date_next_1= | item_rec_date_next_1= |
| item_rec_install_billed_1= | item_rec_install_billed_1= |
| item_name_2=pencil | |
| item_id_2=22 * | |
| item_quantity_2=1 | |
| item_list_amount_2=3.00 | |
| item_usd_amount_2=1.50 | |
| item_cust_amount_2=150 | |
| item_type_2=bill | |
| item_duration_2= | |
| item_recurrence_2= | |
| item_rec_list_amount_2= | |
| item_rec_status_2= | |
| item_rec_date_next_2= | |
| item_rec_install_billed_2= | |
| item_name_3=hat | |
| item_id_3=5 * | |
| item_quantity_3=1 | |
| item_list_amount_3=7.00 | |
| item_usd_amount_3=3.50 | |
| item_cust_amount_3=350 | |
| item_type_3=bill | |
| item_duration_3= | |
| item_recurrence_3= | |
| item_rec_list_amount_3= | |
| item_rec_status_3= | |
| item_rec_date_next_3= | |
| item_rec_install_billed_3= | |
| item_recurrence_3= | |
| item_rec_list_amount_3= | |
| item_rec_status_3= | |
| item_rec_date_next_3= | |
| item_rec_install_billed_3= |
Ex. Order created with recurring product |
|---|
| message_type=ORDER_CREATED |
| message_description=New order created |
| timestamp=2007-12-01 15:30:44 |
| md5_hash=99229B8BD0828FBC41CD0FE5DD80A7C0 |
| message_id=1 |
| key_count=56 |
| vendor_id=12345 |
| sale_id=2223334445 |
| sale_date_placed=2007-01-01 15:30:44 |
| vendor_order_id= |
| invoice_id=234567890 |
| recurring=1 |
| payment_type=credit card |
| list_currency=GBP |
| cust_currency=JPY |
| auth_exp=2007-01-08 |
| invoice_status=approved |
| fraud_status=wait |
| invoice_list_amount=5.00 |
| invoice_usd_amount=2.50 |
| invoice_cust_amount=250 |
| customer_first_name=John |
| customer_last_name=Smith |
| customer_name=John Smith |
| customer_email=jsmith@yahoo.com |
| customer_phone=6149212450 |
| customer_ip=1.1.1.1 |
| customer_ip_country=Malaysia |
| bill_street_address=55 Lane Ave. |
| bill_street_address2=Apt 5 |
| bill_city=Mytown |
| bill_state=NV |
| bill_postal_code=55555 |
| bill_country=USA |
| ship_status=not_shipped |
| ship_tracking_number= |
| ship_name=June Cleaver |
| ship_street_address=123 Main St. |
| ship_street_address2=Apt. B |
| ship_city=Anytown |
| ship_state=OH |
| ship_postal_code=12345 |
| ship_country=USA |
| item_count=1 |
| item_name_1=t-shirt |
| item_id_1=12 |
| item_list_amount_1=5.00 |
| item_usd_amount_1=2.50 |
| item_cust_amount_1=250 |
| item_type_1=bill |
| item_duration_1=1 Year |
| item_recurrence_1=1 Month |
| item_rec_list_amount_1=5.00 |
| item_rec_status_1=live |
| item_rec_date_next_1=2008-01-01 |
| item_rec_install_billed_1=1 |