7. API Integration

The API (Application Programming Interface) of the Dropship Beast servers allow 3rd party software developers to dynamically import and export listings, orders, tracking numbers, as well as their status, in real-time.

For example, if you want to offer your customers auto-ordering, you can connect to Dropship Beast to execute your customers’ orders automatically.

First, you need to have a Partner Account with us. The partner account gives you access to the API service, as well as allowing us to track the purchases your leads and customers make through Dropship Beast, so you participate in the profit-sharing of our network.

Partner accounts are made manually. Contact us, or our representatives. We haven’t turned anyone down, yet 🙂

Let's begin

Endpoint for API requests : https://app.dropshipbeast.com/app/api
Endpoint for Listings : https://app.dropshipbeast.com/app/api/listings
Endpoint for Orders (& Tracking Numbers) : https://app.dropshipbeast.com/app/api/orders

To insert data, you make a POST request.
To retrieve data, you make a GET request.

In the POST body, you include a valid JSON.

Authorization is done using Basic Authorization HTTP Headers with your Partner Account credentials.
You need to include the target user’s email address, so the server knows whos listings you want to update.
You only have permission to modify the listings of your clients, not anybody else’s.

 

Listings

All possible input properties are shown in the examples below. This object will be referred to as the LISTING_OBJECT

							
							
					{
    "item_name": string (optional), - TO BE UPDATED BY DROPSHIP BEAST
    "store_item_name": string (optional) - TO BE UPDATE BY DBEAST APP,
    "image": string (optional),
    "has_variations": "0" | "1" - string (optional) defaults to "0",
    "is_variant": "0" | "1" - string (optional) defaults to "0",
    "parent_listing_id": string (optional),
    "availability": string (optional), - TO BE UPDATED BY DROPSHIP BEAST
    "price": string (optional), - TO BE UPDATED BY DROPSHIP BEAST
    "postage_policy_id": string (optional), - TO BE UPDATED BY DROPSHIP BEAST
    "supplier": string (optional),
    "supplier_id": string (optional),
    "supplier_url": string (optional),
    "supplier_price": string (optional),
    "supplier_availability": string (optional),
    "store": "ebay" | "amazon" - string (optional)
    "store_id": string (required),
    "store_url": string (optional),
    "store_price": string (optional),
    "store_availability": string (optional),
    "store_watches": string (optional) defaults to '0',
    "store_page_visits": string (optional) defaults to '0',
    "store_duration": string (optional),
    "store_items_sold": string (optional) defaults to '0',
    "store_category_id": string (optional),
    "store_shipping_price": string (optional),
    "store_sku": string (optional),
    "store_postage_policy_id": string (optional),
    "store_return_policy_id": string (optional),
    "store_payment_policy_id": string (optional),
    "pause_listing": "0" | "1" string (optional),
    "force_oos": "0" | "1" string (optional), - CAN BE UPDATED BY DROPSHIP BEAST
    "is_deleted": "0" | "1" string (optional), - TO BE UPDATED BY DROPSHIP BEAST
    "logs": string (optional),
    "last_repriced": timestamp (optional),
    "time_created": timestamp (optional),
    "time_updated": timestamp (optional)
}

Retrieve user's listings (PHP)

							
							
					<?php

$endpoint = 'https://app.dropshipbeast.com/app/api/listings?user_email=[CLIENT_EMAIL]';

// Set up the HTTP headers
$headers = [
    'Content-Type: application/x-www-form-urlencoded',
    'Authorization: Basic ' . base64_encode("[PARTNER_EMAIL]" . ":" . "[PARTNER_PASS]")
];

$session = curl_init($endpoint); // create a curl session
//curl_setopt($session, CURLOPT_POST, false); // POST request type
curl_setopt($session, CURLOPT_HTTPHEADER, $headers); // set headers using $headers array
//curl_setopt($session, CURLOPT_POSTFIELDS, $request); // set the body of the POST
curl_setopt($session, CURLOPT_RETURNTRANSFER, true); // return values as a string, not to std out

$response = curl_exec($session); // send the request
curl_close($session); // close the session

$resp = json_decode($response);

echo $response;

?>

Update user's listings (PHP)

							
							
					<?php

$endpoint = 'https://app.dropshipbeast.com/app/api/listings';

// Create the request to be POSTed
$listings_json = '{
	"user_email": "[CLIENT_EMAIL]",
	"listings": {
		"update": [{ LISTING_OBJECT }, { LISTING_OBJECT }],
	    "delete": [{ LISTING_OBJECT }, { LISTING_OBJECT }]
	}
}';

// Set up the HTTP headers
$headers = [
    'Content-Type: application/json',
    'Authorization: Basic ' . base64_encode("vitrontrading@gmail.com" . ":" . "dsbeast123")
];

$session = curl_init($endpoint); // create a curl session
curl_setopt($session, CURLOPT_POST, true); // POST request type
curl_setopt($session, CURLOPT_HTTPHEADER, $headers); // set headers using $headers array
curl_setopt($session, CURLOPT_POSTFIELDS, $listings_json); // set the body of the POST
curl_setopt($session, CURLOPT_RETURNTRANSFER, true); // return values as a string, not to std out

$response = curl_exec($session); // send the request
curl_close($session); // close the session

$resp_obj = json_decode($response);

echo $response;

?>

The server’s response:

updated – how many listings were successfully updated

deleted – how many listings were successfully deleted

							
							
					{"status":2,"code":200,"updated":0,"deleted":1}

Retrieve user's listings (Python)

							
							
					import requests
import json

endpoint = 'https://app.dropshipbeast.com/app/api/listings?user_email="[CLIENT_EMAIL]"'

response_json = requests.get(endpoint,auth=('[PARTNER_EMAIL]', '[PARTNER_PASS]'))

response_obj = json.loads(response_json.content)

print(response_obj)

Update user's listings (Python)

							
							
					import requests
import json

endpoint = "https://app.dropshipbeast.com/app/api/listings"

listings = {
    "user_email":"[CLIENT_EMAIL]",
    "listings":{
        "update":[ LISTING_OBJECT, LISTING_OBJECT],
        "delete":[ LISTING_OBJECT, LISTING_OBJECT]
    }
}

response_json = requests.get(endpoint,auth=('vitrontrading@gmail.com', 'dsb123'))

response_obj = json.loads(response_json.content)

print(response_obj)

The server’s response:

updated – how many listings were successfully updated

deleted – how many listings were successfully deleted

							
							
					{"status":2,"code":200,"updated":0,"deleted":1}

Orders

All possible input properties are shown in the examples bellow.

 

							
							
					{
    "item_name": string, // Order`s item name on eBay,
    "image": string, // Order`s product image on eBay,
    "status_code": '0' | '1' | '2' | '3', // 0 - not ordered from Amazon, 1 - ordered from Amazon, 2 - Ordered from Amazon and marked as dispatched in eBay, 3 - Ordered, marked as dispatched and delivered,
    "order_number": "14-05720-84708", // eBay`s order numbe
    "long_ebay_order_number": "2064795098005", // there is a longer eBay order number used for selectors
    "supplier": "amazon", // The source the product should be ordered from
    "supplier_id": "B000UUN8B8", // Source id of product (ASIN in case of Amazon)
    "supplier_url": "https://www.amazon.co.uk/Tommee-Tippee-Closer-Nature-Medium/dp/B000UUN8B8", // The url of the product that must be ordered
    "source_order_number": "203-2472807-1449938", // order number in the respective source account ( example - Amazon order number )
    "source_order_url": "https://www.amazon.co.uk/progress-tracker/package/ref=ppx_yo_dt_b_track_package?_encoding=UTF8&itemId=jlojksiqkoqtso&orderId=203-2472807-1449938&vt=YOUR_ORDERS", // Orders source URL
    "source_order_carrier": "amazon" | "royal mail" etc // The shipping carrier on Amazon (source)
    "source_order_html": "<html>...</html>" // The whole html of the Amazon tracker page (used for BCE) 
    "store_order_url": "https://www.ebay.co.uk/sh/ord/details?srn=165&orderid=14-05720-84708&source=Orders&ru=https%3A%2F%2Fwww.ebay.co.uk%2Fsh%2Ford%2F%3Ffilter%3Dtimerange%253ALAST90D%252Cstatus%253AALL_ORDERS%26limit%3D200", // the order url of the eBay order
    "source_order_status": "Delivered 11 September", // The status on Amazon
    "store": "ebay" string, 
    "store_marketplace": "US" | "UK" | "DE" | "CA" etc // The store`s marketplace (can be inferred from store_order_url)
    "store_id": string, // seller store's corresponding product id
    "store_feedback": "1" | "0", // Feedback left for order - yes, no
    "tracking_number": string, // Tracking number on Amazon (source)
    "proxy_tracking_number": string, // The BCE converted tracking number
    "tracking_uploaded": "1" | "0", // If the tracking had been uploaded to eBay for the order
    "date_sold": "13 Sep 2020 at 10.03am BST", // when the item was sold from the seller's account
    "parsed_date_sold": "2020-09-13 10:03:00", // when the item was sold from the seller's account
    "quantity": "2", // how much of a product was purchased
    "sold_for": "22.52", // how much the original buyer paid
    "buyer_email": "leon@amazon.com", // original buyer email
    "post_to_name": "Leon Dekteriov", // buyer shipping address name field
    "post_to_address_field": "80 camborne road horfield", // buyer shipping address 1 field
    "post_to_address_field_2": string,  // buyer shipping address 2 field,
    "post_to_city": "bristol", // buyer shipping address city
    "post_to_state_province": "Bristol", // buyer shipping address state / province
    "post_to_country": "United Kingdom", // buyer shipping address country
    "post_to_postcode": "bs70dw" // buyer shipping address postcode
}

Retrieve user's orders (Python)

							
							
					import requests
import json

endpoint = "https://app.dropshipbeast.com/app/api/orders?user_email=[CLIENT_EMAIL]"

response_json = requests.get(endpoint,auth=('[PARTNER_EMAIL]', '[PARTNER_PASS]'))

response_obj = json.loads(response_json.content)

print(response_obj)

Update user's orders (Python)

							
							
					<?php

$endpoint = 'https://app.dropshipbeast.com/app/api/orders';

// Create the request to be POSTed
$orders_json='{
	"user_email": "[CLIENT_EMAIL]",
	"orders": {
		"update": [ ORDER1, ORDER2]
	,
	"delete": [ ORDER3, ORDER4]
	}
}';

// Create the request to be POSTed
//$request = array("user_email"=>"martin.kondov@gmail.com","orders"=>$json_orders);

// Set up the HTTP headers
$headers = [
    'Content-Type: application/json',
    'Authorization: Basic ' . base64_encode("vitrontrading@gmail.com" . ":" . "dsbeast123")
];

$session = curl_init($endpoint); // create a curl session
curl_setopt($session, CURLOPT_POST, true); // POST request type
curl_setopt($session, CURLOPT_HTTPHEADER, $headers); // set headers using $headers array
curl_setopt($session, CURLOPT_POSTFIELDS, $orders_json); // set the body of the POST
curl_setopt($session, CURLOPT_RETURNTRANSFER, true); // return values as a string, not to std out

$response = curl_exec($session); // send the request
curl_close($session); // close the session

$resp_obj = json_decode($response);

echo $response;

?>

The server’s response:

updated – how many orders were successfully updated

deleted – how many orders were successfully deleted

							
							
					{"status":2,"code":200,"updated":0,"deleted":1}

Retrieve user's orders (PHP)

							
							
					<?php

$endpoint = 'https://app.dropshipbeast.com/app/api/orders?user_email=[CLIENT_EMAIL]';

// Set up the HTTP headers
$headers = [
    'Content-Type: application/x-www-form-urlencoded',
    'Authorization: Basic ' . base64_encode("[PARTNER_EMAIL]" . ":" . "[PARTNER_PASS]")
];

$session = curl_init($endpoint); // create a curl session
//curl_setopt($session, CURLOPT_POST, false); // POST request type
curl_setopt($session, CURLOPT_HTTPHEADER, $headers); // set headers using $headers array
//curl_setopt($session, CURLOPT_POSTFIELDS, $request); // set the body of the POST
curl_setopt($session, CURLOPT_RETURNTRANSFER, true); // return values as a string, not to std out

$response = curl_exec($session); // send the request
curl_close($session); // close the session

$resp = json_decode($response);

echo $response;

?>

Update user's orders (PHP)

							
							
					$endpoint = 'https://app.dropshipbeast.com/app/api/listings';

// Create the request to be POSTed
$request = array("user_email"=>$_POST['user_email'],"listings"=>array("updated"=>array($_POST ['listings'])));

// Set up the HTTP headers
$headers = [
'Content-Type: application/x-www-form-urlencoded',
'Authorization: Basic ' . base64_encode("[PARTNER_EMAIL]" . ":" . "[PARTNER_PASS]")
];

$session = curl_init($endpoint); // create a curl session
curl_setopt($session, CURLOPT_POST, true); // POST request type
curl_setopt($session, CURLOPT_HTTPHEADER, $headers); // set headers using $headers array
curl_setopt($session, CURLOPT_POSTFIELDS, $request); // set the body of the POST
curl_setopt($session, CURLOPT_RETURNTRANSFER, true); // return values as a string, not to std out

$response = curl_exec($session); // send the request
curl_close($session); // close the session

$resp = json_decode($response);

header('Content-type: application/json');
echo $resp;

The server’s response:

updated – how many orders were successfully updated

deleted – how many orders were successfully deleted

							
							
					{"status":2,"code":200,"updated":0,"deleted":1}

Grow with confidence

Download Now

Legal documents

Get Started