Order created
Overview
Order creation is a new order placed online by a buyer. 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 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.
Message Parameters
| Parameter | Type | Description |
|---|---|---|
| message_type | Upper Case Text | Indicates type of message (ORDER_CREATED, FRAUD_STATUS_CHANGED, SHIP_STATUS_CHANGED, INVOICE_STATUS_CHANGED, REFUND_ISSUED, RECURRING_INSTALLMENT_SUCCESS, RECURRING_INSTALLMENT_FAILED, RECURRING_STOPPED, RECURRING_COMPLETE, or RECURRING_RESTARTED ) |
| message_description | Text | Human readable description of message_type |
| timestamp | Timestamp | Timestamp of event; format YYYY-MM-DD HH:MM:SS ZZZ |
| md5_hash | Upper Case Text | UPPERCASE(MD5_ENCRYPTED(sale_id + vendor_id + invoice_id + Secret Word)); Can be used to validate authenticity of message |
| message_id | Numeric | This number is incremented for each message sent to a given seller. |
| key_count | Numeric | Indicates the number of parameters sent in message |
| vendor_id | Numeric | Seller account number |
| sale_id | Numeric | 2Checkout sale number |
| sale_date_placed | Date | Date of sale; format YYYY-MM-DD |
| vendor_order_id | Text | Custom order id provided by seller, if available. (“merchant_order_id” can be passed into the checkout with the sale parameters) |
| invoice_id | Numeric | 2Checkout invoice number; Each sale can have several invoices, most commonly one per installment billed on a recurring order. |
| recurring | Numeric | recurring=1 if any item on the invoice is a recurring item, 0 otherwise |
| payment_type | Lower Case Text | Buyer’s payment method (credit card, online check, paypal ec, OR paypal pay later) |
| list_currency | Upper Case Text | 3-Letter ISO code for seller currency |
| cust_currency | Upper Case Text | 3-Letter ISO code for buyer currency |
| auth_exp | Date | The date credit authorization will expire; format YYYY-MM-DD |
| invoice_status | Lower Case Text | Status of a transaction (approved, pending, deposited, or declined) |
| fraud_status | Lower Case Text | Status of 2Checkout fraud review (pass, fail, or wait); This parameter could be empty on some sales. |
| invoice_list_amount | Numeric | Total in seller pricing currency; format as appropriate to currency (2 decimal places for most, integer for JPY) |
| invoice_usd_amount | Numeric | Total in US Dollars; format with 2 decimal places |
| invoice_cust_amount | Numeric | Total in buyer currency; format as appropriate to currency (2 decimal places for most, integer for JPY) |
| customer_first_name | Text | Buyer’s first name (may not be available on older sales) |
| customer_last_name | Text | Buyer’s last name (may not be available on older sales) |
| customer_name | Text | Buyer’s full name (name as it appears on credit card) |
| customer_email | Text | Buyer’s email address |
| customer_phone | Numeric | Buyer’s phone number; all but digits stripped out |
| customer_ip | Text | Buyer’s IP address at time of sale |
| customer_ip_country | Text | Country of record for buyer’s IP address at time of sale; Please note in some cases what is returned is not a country, Ex. Satellite Provider |
| bill_street_address | Text | Billing street address |
| bill_street_address2 | Text | Billing street address line 2 |
| bill_city | Text | Billing address city |
| bill_state | Text | Billing address state or province |
| bill_postal_code | Text | Billing address postal code |
| bill_country | Text | 3-Letter ISO country code of billing address |
| ship_status | Lower Case Text | Value will be not_shipped, shipped, or empty (if intangible / does not need shipped) |
| ship_tracking_number | Text | Tracking Number as entered in Seller Admin |
| ship_name | Text | Shipping Recipient’s name (as it should appears on shipping label) |
| ship_street_address | Text | Shipping street address |
| ship_street_address2 | Text | Shipping street address line 2 |
| ship_city | Text | Shipping address city |
| ship_state | Text | Shipping address state or province |
| ship_postal_code | Text | Shipping address postal code |
| ship_country | Upper Case Text | 3-Letter ISO country code of shipping address |
| item_count | Numeric | Indicates how many numbered sets of item parameters to expect |
| item_name_# | Text | Product name |
| item_id_# | Text | Seller product id |
| item_list_amount_# | Numeric | Total in seller pricing currency; format as appropriate to currency (2 decimal places for most, integer for JPY) |
| item_usd_amount_# | Numeric | Total in US Dollars; format with 2 decimal places |
| item_cust_amount_# | Numeric | Total in buyer currency; format as appropriate to currency (2 decimal places for most, integer for JPY) |
| item_type_# | Lower Case Text | Indicates if item is a bill or refund; Value will be bill or refund |
| item_duration_# | Text | Product duration, how long it re-bills for Ex. 1 Year |
| item_recurrence_# | Text | Product recurrence, how often it re-bills Ex. 1 Month |
| item_rec_list_amount_# | Numeric | Product price; format as appropriate to currency (2 decimal places for most, integer for JPY) |
| item_rec_status_# | Lower Case Text | Indicates status of recurring subscription: live, canceled, or completed |
| item_rec_date_next_# | Date | Date of next recurring installment; format YYYY-MM-DD |
| item_rec_install_billed_# | Numeric | The number of successful recurring installments successfully billed |
Example message
{
auth_exp =>
bill_city => Columbus
bill_country => USA
bill_postal_code => 43215
bill_state => OH
bill_street_address => 855 Grandview Avenue
bill_street_address2 => Suite 11
cust_currency => GBP
customer_email => no-reply@2co.com
customer_first_name => Testing
customer_ip => 192.168.2.250
customer_ip_country => Unknown
customer_last_name => Tester
customer_name => Testing Tester
customer_phone => 6149212450
fraud_status => pass
invoice_cust_amount => 2.00
invoice_id => 4632527490
invoice_list_amount => 2.00
invoice_status => approved
invoice_usd_amount => 3.04
item_count => 2
item_cust_amount_1 => 2.00
item_cust_amount_2 => 2.00
item_duration_1 => Forever
item_duration_2 => Forever
item_id_1 => test recurring product
item_id_2 => test recurring product
item_list_amount_1 => 2.00
item_list_amount_2 => 2.00
item_name_1 => test recurring product
item_name_2 => test recurring product
item_rec_date_next_1 => 2012-02-18
item_rec_date_next_2 =>
item_rec_install_billed_1 => 1
item_rec_install_billed_2 => 1
item_rec_list_amount_1 => 1.00
item_rec_list_amount_2 => 1.00
item_rec_status_1 => cancelled
item_rec_status_2 =>
item_recurrence_1 => 1 Week
item_recurrence_2 => 1 Week
item_type_1 => bill
item_type_2 => refund
item_usd_amount_1 => 3.04
item_usd_amount_2 => 3.04
key_count => 68
list_currency => GBP
md5_hash => 42C25A6BBA17D226C725B92A4A40C34A
message_description => Order fraud status changed
message_id => 2636
message_type => FRAUD_STATUS_CHANGED
payment_type => credit card
recurring => 1
sale_date_placed => 2012-02-11 09:11:18
sale_id => 4632527448
ship_city => Columbus
ship_country => USA
ship_name => Testing Tester
ship_postal_code => 43215
ship_state => OH
ship_status => shipped
ship_street_address => 855 Grandview Avenue
ship_street_address2 => Suite 11
ship_tracking_number =>
timestamp => 2012-02-11 18:47:02
vendor_id => 532001
vendor_order_id => test123
}
