From 9563632ce6cf687794efa6b2d6654f681b05c5cc Mon Sep 17 00:00:00 2001 From: Ian Miller Date: Fri, 8 Sep 2023 12:05:32 -0700 Subject: [PATCH] Update README.md --- README.md | 230 ------------------------------------------------------ 1 file changed, 230 deletions(-) diff --git a/README.md b/README.md index 2e7ec22..ea97838 100644 --- a/README.md +++ b/README.md @@ -31,161 +31,6 @@ echo $wfClient->device_token; // Device Token is used for authing device - it ex ``` -### Get Specific Merchant(s) Metadata -The getMerchants call can be used to fetch metadata (including images) for a given merchant. This call can take either a single integer or an array of integers. - -```php -// single merchant request -$singleMerchant = $wfClient->getMerchantsById(5477615); -var_dump($singleMerchant); - -// multiple merchant request -$multipleMerchants = $wfClient->getMerchantsById(array(5482877,5478747)); -var_dump($multipleMerchants); -``` - -#### Example return -``` -Array -( - [0] => stdClass Object - ( - [ID] => 5478747 - [Name] => Hotels.com - [ShortCode] => mPEE27LOAhI - [ShortURL] => http://wild.link/mPEE27LOAhI - [Images] => Array - ( - [0] => stdClass Object - ( - [ID] => 3 - [Kind] => FEATURED - [Ordinal] => 1 - [ImageID] => 3 - [URL] => https://images.wildlink.me/wl-image/a3a4df7b12404451fe3f2099122847e5dc3ed6b5.jpeg - [Width] => 660 - [Height] => 380 - ) - [1] => stdClass Object - ( - [ID] => 808 - [Kind] => LOGO - [Ordinal] => 1 - [ImageID] => 809 - [URL] => https://images.wildlink.me/wl-image/2fe289045e0794f3bcf7f3ae03d7850f5b51cf6c.jpeg - [Width] => 200 - [Height] => 200 - ) - ) - ) - [1] => stdClass Object - ( - [ID] => 5482877 - [Name] => Target - [ShortCode] => mPEE_dLOAhE - [ShortURL] => http://wild.link/mPEE_dLOAhE - [Images] => Array - ( - [0] => stdClass Object - ( - [ID] => 29 - [Kind] => FEATURED - [Ordinal] => 1 - [ImageID] => 29 - [URL] => https://images.wildlink.me/wl-image/480b5c95d607854052a9f583c51ee1b8f168e640.jpeg - [Width] => 660 - [Height] => 380 - ) - [1] => stdClass Object - ( - [ID] => 713 - [Kind] => LOGO - [Ordinal] => 10 - [ImageID] => 714 - [URL] => https://images.wildlink.me/wl-image/15b28fdfc04006589492a620fca2a4290547b394.jpeg - [Width] => 200 - [Height] => 200 - ) - ) - ) -) -``` - -### Get Commission Rate Data for a Merchant -The getMerchantCommissionRates call can be used to fetch commission rate information for a given merchant. Some merchants have a single commission rate and others have a segmented series of rates (sometimes by product category, sometimes by other attributes). The commission rate in the return data takes into account your agreed-upon commission split (so you see your commission amount after Wildfire Systems has taken their share). Some commission terms are percentage rates while others are flat amounts. Where there are flat amounts, a currency code will be included. Wildlink doesn't convert currencies in this context at this time. Wildlink always pays out in USD and will convert the currencies before payment is issued to you. When available, a default commission rate will be denoted, but note that not all merchants have a specified default currency. - -```php -$singleMerchantCommissionRates = $wfClient->getMerchantCommissionRates(5477615); -var_dump($singleMerchantCommissionRates); -``` - -#### Example return -``` -Array -( - [0] => stdClass Object - ( - [ID] => 41 - [Name] => ESR merchant hotel - [DisplayName] => - [Kind] => PERCENTAGE - [Amount] => 3 - [IsDefault] => - ) -) -``` - - -### Get All Merchants (excludes disabled merchants) metadata - -```php -$merchantList = new MerchantList($wfClient); -while ($merchant = $merchantList->getCurrentMerchant()){ - var_dump($merchant); - if ($merchantList->hasNextMerchant()){ - $merchantList->getNextMerchant(); - } else { - break; - } -} -``` - -#### Example return -``` -stdClass Object -( - [ID] => 5520185 - [Name] => Prioritytireoutlet.com - [Disabled] => - [Featured] => - [ShortCode] => 95gFufbQAgQ - [ShortURL] => http://wild.link/95gFufbQAgQ - [Images] => Array - ( - [0] => stdClass Object - ( - [ID] => 3 - [Kind] => FEATURED - [Ordinal] => 1 - [ImageID] => 3 - [URL] => https://images.wildlink.me/wl-image/a3a4df7b12404451fe3f2099122847e5dc3ed6b5.jpeg - [Width] => 660 - [Height] => 380 - ) - [1] => stdClass Object - ( - [ID] => 808 - [Kind] => LOGO - [Ordinal] => 1 - [ImageID] => 809 - [URL] => https://images.wildlink.me/wl-image/2fe289045e0794f3bcf7f3ae03d7850f5b51cf6c.jpeg - [Width] => 200 - [Height] => 200 - ) - ) -) -``` - ### Get App Commissions Detail List (Across all devices) When you want to fetch all commissions, across all devices (i.e. for syncing your backend with Wildfire's) you can use this call to get all changes to commission records since a given date. @@ -271,81 +116,6 @@ while ($commission = $commissionList->getCurrentCommission()){ ``` -### Get Commissions Summary -When you want to display a high level summary of the earnings to a user (assuming you are passing compensation along to your end users) you can call getCommissionSummary. - -```php -$commissionSummary = $wfClient->getCommissionSummary(); -var_dump($commissionSummary); -``` - -#### Example return -``` -stdClass Object -( - [PendingAmount] => 0.00 - [ReadyAmount] => 0.00 - [PaidAmount] => 0.00 -) -``` - -### Get Commissions Detail List -If you’re including your end users in Wildlink compensation, you can use this call to fetch a detailed record of every commission that Wildlink is aware of for the client/device (including each commission’s status). - - -```php -$commissions = $wfClient->getCommissionDetails(); -var_dump($commissions); -``` - -#### Example return -``` -Array ( - [0] => stdClass Object - ( - "ID": 7455, - "CommissionIDs": Array( - 7455, - 7456 - ], - "Date": "2018-09-18T00:00:00Z", - "Amount": "0.12", - "Status": "PENDING", - "Merchant": "AliExpress" - ), - [1] => stdClass Object - ( - "ID": 7336, - "CommissionIDs": Array( - 7336 - ), - "Date": "2018-09-05T14:24:28Z", - "Amount": "0.04", - "Status": "DISQUALIFIED", - "Merchant": "DressLily" - ) -) -``` - -### Get Click Stats -If appropriate, you can display total clicks for a given device for a time range (by day, month or year). This method takes a start and end date value (the end value is optional). - - -```php -$clicks = $wfClient->getClickStatsByDay('2018-01-01'); -var_dump($clicks); -``` - -#### Example return -``` -stdClass Object -( - [2018-10-15T00:00:00Z] => 3 - [2018-10-16T00:00:00Z] => 12 -) -``` - - ### Create Vanity URL (i.e. http://wild.link/walmart/abc123) Convert a URL (to a product page, listing page, etc.) to a wild.link URL with embedded tracking for the authenticated device.