-
Notifications
You must be signed in to change notification settings - Fork 8
Sale_Retrieve
Jacob McConnell edited this page Jun 11, 2014
·
2 revisions
You must specify your API username and password when creating your 2checkout-node object (named ‘tco’ in these examples) before calling this method.
##Method
###retrieve
Use to retrieve a sale object.
####Arguments
- object - Object containing sale parameters. Parameters -> APi Detail Sale
- callback - Function to be called on success/error
####Returns
Sale Object
####Example Usage:
args = {
sale_id: "4647892238"
};
tco.sales.retrieve(args, function (error, data) {
if (error) {
console.log(error);
} else {
console.log(data.response_code);
}
});####Example Response:
{
"response_code" : "OK",
"response_message" : "Sale detail retrieved",
"sale" : {
"comments" : [
{
"changed_by_ip" : "192.168.0.1",
"comment" : "[* Sent: Vendor *] Refund Issued On Sale: test sale",
"timestamp" : "2012-03-31 10:56:31",
"username" : "api_user"
},
{
"changed_by_ip" : "192.168.0.1",
"comment" : "[* Sent: Vendor *] Recurring billing stopped for test",
"timestamp" : "2012-03-31 10:56:30",
"username" : "api_user"
}
],
"customer" : {
"address_1" : "123 test st",
"address_2" : null,
"address_id" : "4647892310",
"cardholder_name" : "Testing Tester",
"city" : "test",
"country_code" : "USA",
"country_name" : "United States",
"customer_id" : "4647892244",
"email_address" : "api_user@fake-company.com",
"first_name" : "Testing",
"lang" : "en",
"last_name" : "Tester",
"middle_initial" : null,
"pay_method" : {
"avs" : null,
"cvv" : null,
"first_six_digits" : null,
"last_two_digits" : null,
"method" : "paypal ec"
},
"phone" : "123465789",
"phone_ext" : "",
"postal_code" : "43123",
"prefix" : null,
"state" : "OH"
},
"date_placed" : "2012-02-29 13:29:28",
"detail_ip" : {
"address" : "66.194.132.135",
"area_code" : 740,
"city" : "Galena",
"country" : "United States",
"country_code" : "US",
"region" : "OH",
"zip" : "43021"
},
"invoices" : [
{
"customer_total" : "1.00",
"date_placed" : "2012-02-29 13:29:28",
"date_shipped" : null,
"date_vendor_paid" : null,
"fees_2co" : "0.54",
"invoice_id" : "4647892247",
"lineitems" : [
{
"affiliate_vendor_id" : null,
"billing" : {
"amount" : "1.53",
"bill_method" : "paypal_int",
"billing_id" : "4647892307",
"customer_amount" : "1.00",
"customer_id" : "4647892244",
"date_deposited" : "2012-02-29",
"date_end" : null,
"date_fail" : "2012-03-07",
"date_next" : "2012-03-29",
"date_pending" : "2012-02-29",
"date_start" : "2012-03-02",
"lineitem_id" : "4647892301",
"recurring_status" : "completed",
"status" : "bill",
"usd_amount" : "1.53",
"vendor_amount" : "1.00"
},
"commission" : null,
"commission_affiliate_vendor_id" : null,
"commission_flat_rate" : null,
"commission_percentage" : null,
"commission_type" : null,
"commission_usd_amount" : null,
"customer_amount" : "1.00",
"flat_rate" : null,
"installment" : "1",
"invoice_id" : "4647892247",
"lc_affiliate_vendor_id" : null,
"lc_usd_amount" : null,
"lineitem_id" : "4647892301",
"linked_id" : null,
"options" : [],
"percentage" : null,
"product_description" : "test",
"product_duration" : "Forever",
"product_handling" : "0.00",
"product_id" : "4647888428",
"product_is_cart" : "0",
"product_name" : "test",
"product_price" : "1.00",
"product_recurrence" : "1 Month",
"product_startup_fee" : null,
"product_tangible" : "0",
"sale_id" : "4647892238",
"status" : "bill",
"type" : null,
"usd_amount" : "1.53",
"usd_commission" : null,
"vendor_amount" : "1.00",
"vendor_product_id" : "1178646973"
},
{
"affiliate_vendor_id" : null,
"billing" : {
"amount" : "1.53",
"bill_method" : "paypal_int",
"billing_id" : "4672854535",
"customer_amount" : "1.00",
"customer_id" : "4647892244",
"date_deposited" : "2012-03-31",
"date_end" : null,
"date_fail" : "2012-04-05",
"date_next" : null,
"date_pending" : "2012-03-31",
"date_start" : "2012-03-31",
"lineitem_id" : "4672854532",
"recurring_status" : null,
"status" : "refund",
"usd_amount" : "1.53",
"vendor_amount" : "1.00"
},
"commission" : null,
"commission_affiliate_vendor_id" : null,
"commission_flat_rate" : null,
"commission_percentage" : null,
"commission_type" : null,
"commission_usd_amount" : null,
"customer_amount" : "1.00",
"flat_rate" : null,
"installment" : "1",
"invoice_id" : "4647892247",
"lc_affiliate_vendor_id" : null,
"lc_usd_amount" : null,
"lineitem_id" : "4672854532",
"linked_id" : "4647892301",
"options" : [],
"percentage" : null,
"product_description" : "test",
"product_duration" : "Forever",
"product_handling" : "0.00",
"product_id" : "4647888428",
"product_is_cart" : "0",
"product_name" : "test",
"product_price" : "1.00",
"product_recurrence" : "1 Month",
"product_startup_fee" : null,
"product_tangible" : "0",
"sale_id" : "4647892238",
"status" : "refund",
"type" : null,
"usd_amount" : "1.53",
"usd_commission" : null,
"vendor_amount" : "1.00",
"vendor_product_id" : "1178646973"
}
],
"recurring" : "1",
"referrer" : "http://fake-company.com/buy.php",
"sale_id" : "4647892238",
"shipping" : null,
"status" : "deposited",
"usd_total" : "1.53",
"vendor_id" : "532001",
"vendor_order_id" : "1",
"vendor_total" : "1.00"
},
{
"customer_total" : "1.00",
"date_placed" : "2012-03-29 02:32:58",
"date_shipped" : null,
"date_vendor_paid" : null,
"fees_2co" : "0.54",
"invoice_id" : "4671118593",
"lineitems" : [
{
"affiliate_vendor_id" : null,
"billing" : {
"amount" : "1.53",
"bill_method" : "paypal_int",
"billing_id" : "4671118602",
"customer_amount" : "1.00",
"customer_id" : "4647892244",
"date_deposited" : "2012-03-28",
"date_end" : "1999-01-01",
"date_fail" : "2012-04-05",
"date_next" : "2012-04-29",
"date_pending" : "2012-03-29",
"date_start" : "2012-03-31",
"lineitem_id" : "4671118599",
"recurring_status" : "stopped",
"status" : "bill",
"usd_amount" : "1.53",
"vendor_amount" : "1.00"
},
"commission" : null,
"commission_affiliate_vendor_id" : null,
"commission_flat_rate" : null,
"commission_percentage" : null,
"commission_type" : null,
"commission_usd_amount" : null,
"customer_amount" : "1.00",
"flat_rate" : null,
"installment" : "2",
"invoice_id" : "4671118593",
"lc_affiliate_vendor_id" : null,
"lc_usd_amount" : null,
"lineitem_id" : "4671118599",
"linked_id" : null,
"options" : [],
"percentage" : null,
"product_description" : "test",
"product_duration" : "Forever",
"product_handling" : "0.00",
"product_id" : "4647888428",
"product_is_cart" : "0",
"product_name" : "test",
"product_price" : "1.00",
"product_recurrence" : "1 Month",
"product_startup_fee" : null,
"product_tangible" : "0",
"sale_id" : "4647892238",
"status" : "bill",
"type" : null,
"usd_amount" : "1.53",
"usd_commission" : null,
"vendor_amount" : "1.00",
"vendor_product_id" : "1178646973"
},
{
"affiliate_vendor_id" : null,
"billing" : {
"amount" : "1.53",
"bill_method" : "paypal_int",
"billing_id" : "4672854541",
"customer_amount" : "1.00",
"customer_id" : "4647892244",
"date_deposited" : "2012-03-31",
"date_end" : null,
"date_fail" : "2012-04-05",
"date_next" : null,
"date_pending" : "2012-03-31",
"date_start" : "2012-03-31",
"lineitem_id" : "4672854538",
"recurring_status" : null,
"status" : "refund",
"usd_amount" : "1.53",
"vendor_amount" : "1.00"
},
"commission" : null,
"commission_affiliate_vendor_id" : null,
"commission_flat_rate" : null,
"commission_percentage" : null,
"commission_type" : null,
"commission_usd_amount" : null,
"customer_amount" : "1.00",
"flat_rate" : null,
"installment" : "2",
"invoice_id" : "4671118593",
"lc_affiliate_vendor_id" : null,
"lc_usd_amount" : null,
"lineitem_id" : "4672854538",
"linked_id" : "4671118599",
"options" : [],
"percentage" : null,
"product_description" : "test",
"product_duration" : "Forever",
"product_handling" : "0.00",
"product_id" : "4647888428",
"product_is_cart" : "0",
"product_name" : "test",
"product_price" : "1.00",
"product_recurrence" : "1 Month",
"product_startup_fee" : null,
"product_tangible" : "0",
"sale_id" : "4647892238",
"status" : "refund",
"type" : null,
"usd_amount" : "1.53",
"usd_commission" : null,
"vendor_amount" : "1.00",
"vendor_product_id" : "1178646973"
}
],
"recurring" : "1",
"referrer" : "http://www.fake-company.com/buy.php",
"sale_id" : "4647892238",
"shipping" : null,
"status" : "deposited",
"usd_total" : "1.53",
"vendor_id" : "532001",
"vendor_order_id" : "1",
"vendor_total" : "1.00"
}
],
"ip_address" : "66.194.132.135",
"ip_country" : "United States",
"recurring_decline" : null,
"sale_id" : "4647892238"
}
}Please feel free to contact 2Checkout directly for assistance with your integration.