Download all orders:

<?php
require_once 'vendor/autoload.php';

use Wish\WishClient;

$access_token = 'an_example_access_token';

$client = new WishClient($access_token,'prod');
$unfulfilled_orders = $client->getAllUnfulfilledOrdersSince('2010-01-20');
$changed_orders = $client->getAllChangedOrdersSince('2010-01-20');
?>

<?php

$access_token = urlencode('an_example_access_token');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/order/create-download-job?access_token=%s",
$access_token);
$context = stream_context_create(array(
'http' => array(
'method' => 'GET',
'ignore_errors' => true,
),
));
// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
?>

Assume your access token is "an_example_access_token" , you can now make a GET request to the following API to test your authentication:
https://sandbox.merchant.wish.com/api/v2/auth_test?access_token=an_example_access_token

Example

<?php

$access_token = urlencode('an_example_access_token');

$url = sprintf("https://sandbox.merchant.wish.com/api/v2/auth_test?access_token=%s);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'GET',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

<?php
require_once 'vendor/autoload.php';

use Wish\WishClient;

$access_token = 'an_example_access_token';

$client = new WishClient($access_token,'prod');
echo $client->authTest();
?>

Example

Lets say you had product named "red shoe" with a SKU of red-shoe-11,with price $100.00 and shipping of $10.00. If you want the description to be "this is a cool shoe" and its tags to be "red,shoe,cool". You want "http://i.imgur.com/Q1a32kD.jpg" to be the main image for your product and have additional imge "http://i.imgur.com/Cxagv.jpg" and "http://i.imgur.com/LuPSxBM.jpg". Assume your access token is "an_example_access_token"

• name = red shoe
• parent_sku = red-shoe
• sku = red-shoe-11
• inventory = 100
• price = 100
• localized_price = 600
• shipping = 10
• localized_shipping = 60
• country_shipping_prices = {"US":3.99,"CA":4.99,"LOCAL_US":24.0}
• description = this is a cool shoe
• tags = red,shoe,cool
• main_image = http://i.imgur.com/Q1a32kD.jpg
• extra_images=http://i.imgur.com/Cxagv.jpg|http://i.imgur.com/Cxagv.jpg
• access_token = an_example_access_token

Example Request

<?php
require_once 'vendor/autoload.php';

use Wish\WishClient;

$access_token = 'an_example_access_token';

$client = new WishClient($access_token,'prod');
$product = array(
  'name'=>'red shoe',
  'main_image'=>'http://i.imgur.com/Q1a32kD.jpg',
  'extra_images'=>'http://i.imgur.com/Cxagv.jpg|http://i.imgur.com/Cxagv.jpg',
  'sku'=>'red-shoe-11',
  'parent_sku'=>'red-shoe',
  'country_shipping_prices'=>'{"US":3.99,"CA":4.99,"LOCAL_US":24.0}'
  'tags'=>'red,shoe,cool',
  'description'=>'a cool shoe',
  'inventory'=>'100',
  'price'=>'100',
  'localized_price'=>'600',
  'shipping'=>'10',
  'localized_shipping'=>'60',

  'localized_currency_code'=>'CNY'
);
$prod_res = $client->createProduct($product);
print_r($prod_res);
?>

<?php

$access_token = urlencode('an_example_access_token');

$name = urlencode('red shoe');
$parent_sku = urlencode('red-shoe');
$sku = urlencode('red-shoe-11');
$inventory = urlencode('100');
$price = urlencode('100');
$shipping = urlencode('10');
$localized_price = urlencode('600');
$localized_shipping = urlencode('60');
$localized_currency_code = urlencode('CNY');
$country_shipping_prices = urlencode('{"US":3.99,"CA":4.99,"LOCAL_US":24.0}')
$description = urlencode('this is a cool shoe');
$tags = urlencode('red,shoe,cool');
$main_image = urlencode('http://i.imgur.com/Q1a32kD.jpg');
$extra_images = urlencode('http://i.imgur.com/Cxagv.jpg|http://i.imgur.com/Cxagv.jpg');
$url = sprintf(
"https://sandbox.merchant.wish.com/api/v2/product/add?access_token=%s&main_image=%s&name=%s&description=%s&tags=%s&sku=%s&inventory=%s&price=%s&shipping%s&localized_price=%s&localized_shipping=%s&localized_currency_code=%s&extra_images=%s&parent_sku=%s",
$access_token, $main_image, $name, $description, $tags, $sku, $inventory, $price, $shipping, $localized_price, $localized_shipping, $localized_currency_code, $extra_images, $parent_sku);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'POST',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{'code': 0,
 'data':
    {'Product': {'description': ' this is a cool shoe',
                 'id': '52a11ebdf94adc0cfee0dbd9',
                 'name': 'red shoe',
                 'number_saves': '0',
                 'number_sold': '0',
                 'parent_sku': 'red-shoe',
                 'review_status': 'pending',
                 'tags': [{'Tag': {'id': 'red',
                                   'name': 'red'}},
                          {'Tag': {'id': 'cool',
                                   'name': 'cool'}},
                          {'Tag': {'id': 'shoe',
                                   'name': 'shoe'}}],
                 'country_shippings': [{'CountryShipping': {'price': '4.99',
                                                                                                                'localized_price': '30.0',
                                                    'localized_currency_code': 'CNY',
                                                    'country_code': 'CA'}},
                                       {'CountryShipping': {'price': '3.99',
                                                    'localized_price': '24.0',
                                                    'localized_currency_code': 'CNY',
                                                    'country_code': 'US'}}],
                  'variants': [{'Variant': {'enabled': 'True',
                                           'id': '52a11ebef94adc0cfee0dbdb',
                                           'product_id': '52a11ebdf94adc0cfee0dbd9',
                                           'inventory': '100',
                                           'shipping_time': '5-10',
                                           'sku': 'red-shoe-11',
                                           'price': '100.0',
                                           'shipping': '10.0'
                                           'localized_price': '600.0',
                                           'localized_shipping': '60.0'
                                           'localized_currency_code': 'CNY'}]}},
'message': ''}

Example

Assume your access token is "an_example_access_token" . If you want to retrieve a product with the id 4ef2858a9795c776ce000120:

• id = 4ef2858a9795c776ce000120
• access_token = an_example_access_token

Example Request

<?php
require_once 'vendor/autoload.php';

use Wish\WishClient;

$access_token = 'an_example_access_token';

$client = new WishClient($access_token,'prod');
$product = $client->getProductById('4ef2858a9795c776ce000120');
print_r($product);
?>

<?php

$access_token = urlencode('an_example_access_token');

$id = urlencode('4ef2858a9795c776ce000120');

$url = sprintf("https://sandbox.merchant.wish.com/api/v2/product?access_token=%s$id);
$context = stream_context_create(array(
'http' => array(
'method' => 'GET',
'ignore_errors' => true,
),
));
// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{'code': 0,
 'data': {'Product':{'description': ' Cotton Women Fashion Dresses',
                      'id': '51e0a2c47d41a236cfffe3a0',
                      'name': 'TEST!!!',
                      'number_saves': '12529',
                      'number_sold': '14',
                      'review_status': 'approved',
                      'tags': [{'Tag': {'id': 'Dress', 'name': 'Dress'}},
                              ],
                      'default_shipping_price': '5.0',
                      'country_shippings': [{'CountryShipping': {'price': '4.99',
                                                                 'localized_price': '30',
                                                                 'localized_currency_code': 'CNY',
                                                                 'country_code': 'CA'}},
                                            {'CountryShipping': {'price': '3.99',
                                                                 'localized_price': '24',
                                                                 'localized_currency_code': 'CNY',
                                                                 'country_code': 'US'}}],
                      'variants': [{'Variant': {'enabled': 'True',
                                                'id': '51e0a2c67d41a236cfffe3a2',
                                                'product_id': '51e0a2c47d41a236cfffe3a0',
                                                'inventory': '10000',
                                                'msrp': '20000.0',
                                                'price': '10000.0',
                                                'shipping': '101.0',
                                                'localized_price': '60000.0',
                                                'localized_shipping': '606.0',
                                                'localized_currency_code': 'CNY',
                                                'sku': 'Bottle',
                                                'LogisticsMetadata': {
                                                   'declared_name': 'Bottle',
                                                   'declared_local_name': '瓶子',
                                                   'pieces': 1,
                                                   'height': '12.0',
                                                   'weight': '2.0',
                                                   'width': '23.0',
                                                   'length': '2.0',
                                                   'origin_country': 'US',
                                                   'hscode':'6104299034',
                                                   'product_id': '59c17fbae3a3f61e0dba33b8',
                                                   'id': '51e0a2c67d41a236cfffe3a2',
                                                   'declared_value': '32.0',
                                                   'Composition': {
                                                   'has_liquid': 'True',
                                                   'has_battery': 'False',
                                                   'has_powder': 'False',
                                                   'has_metal': 'False'
                                                    }
                                                }
                                                }}]}},
                      'country_shippings': [{'CountryShipping': {'price': '4.99',
                                                                 'localized_price': '30',
                                                                 'localized_currency_code': 'CNY',
                                                                 'country_code': 'CA'}},
                                            {'CountryShipping': {'price': '3.99',
'localized_price': '24'
                                                                 'localized_currency_code': 'CNY',
                                                                 'country_code': 'US'}}],
'message': ''}

Example

Assume your access token is "an_example_access_token" . If you had a product with id 123456789009876543211234 and you wanted to change the name to "Awesome shoe", update the description to "This shoe is the best on Wish" and change the tags to "shoe,awesome,size 11" your parameters would be:

• id = 123456789009876543211234
• name = Awesome shoe
• description = This shoe is the best on Wish
• tags = shoe, awesome, size 11
• access_token = an_example_access_token

If you did not want to update the tags, you would omit that parameter from your API call.

Example Request

<?php
require_once 'vendor/autoload.php';

use Wish\WishClient;

$access_token = 'an_example_access_token';

$client = new WishClient($access_token,'prod');
$product = $client->getProductById('123456789009876543211234');
$product->name = "Awesome name";
$product->description = "This shoe is the best on Wish";
$product->tags = "shoe, awesome, size 11";
$client->updateProduct($product);
?>

<?php

$access_token = urlencode('an_example_access_token');

$id = urlencode('123456789009876543211234')
$name = urlencode('Awesome shoe');
$description = urlencode('This shoe is the best on Wish');
$tags = urlencode('shoe, awesome, size 11')

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/product/update?access_token=%s&id=%s&name=%s&description=%s&tags=%s",
    $access_token, $id, $name, $description, $tags);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'POST',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    'code': 0,
    'data': {},
    'message': ''
}

Example

Assume your access token is "an_example_access_token" . If you had a product with id 123456789009876543211234 and you wanted to enable it, your parameters would be:

• id = 123456789009876543211234
• access_token = an_example_access_token

Example Request

<?php
require_once 'vendor/autoload.php';

use Wish\WishClient;

$access_token = 'an_example_access_token';

$client = new WishClient($access_token,'prod');
$client->enableProductById('123456789009876543211234');
?>

<?php

$access_token = urlencode('an_example_access_token');

$id = urlencode('123456789009876543211234')

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/product/enable?access_token=%s&id=%s",
    $access_token, $id);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'POST',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    'code': 0,
    'data': {},
    'message': ''
}

Example

Assume your access token is "an_example_access_token" . If you had a product with id 123456789009876543211234 and you wanted to disable it, your parameters would be:

• id = 123456789009876543211234
• access_token = an_example_access_token

Example Request

<?php
require_once 'vendor/autoload.php';

use Wish\WishClient;

$access_token = 'an_example_access_token';

$client = new WishClient($access_token,'prod');
$client->disableProductById('123456789009876543211234');
?>

<?php

$access_token = urlencode('an_example_access_token');

$id = urlencode('123456789009876543211234')

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/product/disable?access_token=%s&id=%s",
    $access_token, $id);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'POST',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    'code': 0,
    'data': {},
    'message': ''
}

Example

Assume your access token is "an_example_access_token" . If you would like to view your products updated after 2014-10-15 and before 2015-06-10 01:00:00 in groups of 2 and you would like to see the 10th group your parameters would be:

• start = 20
• limit = 2
• since = 2014-10-15
• upto = 2015-06-10T01:00:00
• access_token = an_example_access_token

Example Request

<?php
require_once 'vendor/autoload.php';

use Wish\WishClient;

$access_token = 'an_example_access_token';

$client = new WishClient($access_token,'prod');
$products = $client->getAllProducts();
echo "You have ".count($products)." products!\n";

<?php

$access_token = urlencode('an_example_access_token');

$start = urlencode('20');
$limit = urlencode('2');
$since = urlencode('2014-10-15');
$upto = urlencode('2015-06-10T01:00:00');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/product/multi-get?access_token=%s&limit=%s&start=%s&upto=%s",
    $access_token, $limit, $start, $since, $upto);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'GET',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{'code': 0,
 'data': [{'Product': {'description': 'Example description',
                       'id': '5284e18fb5baba49d5xxxxxx',
                       'name': 'Cute Ring',
                       'number_saves': '6',
                       'number_sold': '0',
                       'parent_sku': 'Cute Bow Ring',
                       'review_status': 'approved',
                       'default_shipping_price': '10.5',
                       'tags': [{'Tag': {'id': 'womensring', 'name': 'womens ring'}},
                                {'Tag': {'id': 'jewelry', 'name': 'Jewelry'}},
                                {'Tag': {'id': 'bow', 'name': 'Bow'}}],
                       'variants': [{'Variant': {'color': 'green',
                                                 'enabled': 'True',
                                                 'id': '5284e192b111ba49d5xxxxxx',
                                                 'product_id': '5284e18fb5baba49d5xxxxxx',
                                                 'inventory': '11',
                                                 'msrp': '113.9',
                                                 'price': '110.9',
                                                 'shipping': '10.5',
                                                 'localized_price': '660.0',
                                                 'localized_shipping': '63.0',
                                                 'localized_currency_code': 'CNY',
                                                 'sku': 'AA1'}},
                                    {'Variant': {'color': 'blue',
                                                 'enabled': 'True',
                                                 'id': '5284e19qqqbaba49d5bbbbbb',
                                                 'product_id': '5284e18fb5baba49d5xxxxxx',
                                                 'inventory': '100',
                                                 'msrp': '19.9',
                                                 'price': '15.9',
                                                 'shipping': '10.5',
                                                 'localized_price': '90.0',
                                                 'localized_shipping': '63.0',
                                                 'localized_currency_code': 'CNY',
                                                 'sku': 'ZZ1'}}]}},
           {'Product': {'description': 'Example Description',
                         'id': '5284efafb5bab119d1zzzzzz',
                         'name': 'Fairisle Scarf',
                         'number_saves': '0',
                         'number_sold': '0',
                         'parent_sku': 'Fairisle Scarf',
                         'review_status': 'rejected',
                         'default_shipping_price': '10.0',
                         'tags': [{'Tag': {'id': 'cottonscarf', 'name': 'cotton scarf'}},
                                  {'Tag': {'id': 'fashionaccessorie', 'name': 'Fashion Accessories'}},
                                  {'Tag': {'id': 'fashion', 'name': 'Fashion'}},
                                  {'Tag': {'id': 'scarf', 'name': 'scarf'}}],
                         'variants': [{'Variant': {'color': 'gray',
                                                   'enabled': 'True',
                                                   'id': '5284efb1b111ba49d1qqqqqq',
                                                   'product_id': '5284efafb5bab119d1zzzzzz',
                                                   'inventory': '1010',
                                                   'msrp': '25.9',
                                                   'price': '21.91',
                                                   'shipping': '10.0',
                                                   'localized_price': '120.0',
                                                   'localized_shipping': '60.0',
                                                   'localized_currency_code': 'CNY',
                                                   'sku': 'AA4'}},
                                       {'Variant': {'color': 'red',
                                                    'enabled': 'True',
                                                    'id': '5284efbaaababa49d1eiwqdf',
                                                    'product_id': '5284efafb5bab119d1zzzzzz',
                                                    'inventory': '1100',
                                                    'msrp': '21.99',
                                                    'price': '21.91',
                                                    'shipping': '11.0',
                                                    'localized_price': '120.0',
                                                    'localized_shipping': '66.0',
                                                    'localized_currency_code': 'CNY',
                                                    'sku': 'AAB'}}]}}],
                         'country_shippings': [{'CountryShipping': {'price': '4.99',
                                                                    'localized_price': '30.0',
                                                                    'localized_currency_code': 'CNY',
                                                                    'country_code': 'CA'}},
                                               {'CountryShipping': {'price': '3.99',
'localized_price': '24.0',
                                                                    'localized_currency_code': 'CNY',
                                                                    'country_code': 'US'}}],
'message': '',
'paging': {'next': 'https://sandbox.merchant.wish.com/api/v2/product/multi-get?start=22&limit=2&since=2014-10-15&access_token=an_example_access_token',
'previous': 'https://sandbox.merchant.wish.com/api/v2/product/multi-get?start=18&limit=2&since=2014-10-15&access_token=an_example_access_token'}}

Example

Assume your access token is "an_example_access_token". If you had a product with id 123456789009876543211234 and you wanted to remove its extra images, your parameters would be:

• id = 123456789009876543211234
• access_token = an_example_access_token

Example Request

<?php

$access_token = urlencode('an_example_access_token');
$id = urlencode('123456789009876543211234');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/product/remove-extra-images?access_token=%s&id=%s",
    $access_token, $id);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'POST',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

<?php
require_once 'vendor/autoload.php';

use Wish\WishClient;

$access_token = 'an_example_access_token';

$client = new WishClient($access_token,'prod');
$client->removeExtraImagesById('123456789009876543211234');
?>

Example Response

{
    "message":"",
    "code":0,
    "data":{}
}

Example

Assume your access token is "an_example_access_token". If you had a product with id 123456789009876543211234 and you wanted to edit its shipping price of Canada to $2.99 USD, enable Wish Express to Canada, and set the default shipping price to $3.99 USD, your parameters would be:

• id = 123456789009876543211234
• access_token = an_example_access_token
• country = CA
• price = 2.99
• localized_price = 18
• localized_currency_code = CNY
• wish_express = true
• default_shipping_price = 3.99
• localized_default_shipping_price = 24

Example Request

<?php

$access_token = urlencode('an_example_access_token');
$id = urlencode('123456789009876543211234');
$country = urlencode('CA');
$price = urlencode('2.99');
$localized_price = urlencode('18.0');
$loclaized_currency_code = urlencode('CNY');
$wish_express = urlencode('true');
$default_shipping_price = urlencode('3.99');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/product/update-shipping?access_token=%s&id=%s&country=%s&price=%s&localized_price=%s&localized_currency_code=%s&localized_default_shipping_price=%s&wish_express=%s&default_shipping_price=%s",
    $access_token, $id, $country, $price, $localized_price, $localized_currency_code, $localized_default_shipping_price, $wish_express, $default_shipping_price);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'POST',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

<?php
require_once 'vendor/autoload.php';

use Wish\WishClient;

$access_token = 'an_example_access_token';

$client = new WishClient($access_token,'prod');
$client->updateShippingById('123456789009876543211234', 'CA', 2.99);

?>

Example Response

{
    "message":"",
    "code":0,
    "data":{}
}

Example

Assume your access token is "an_example_access_token". If you had a product with id 123456789009876543211234 and you wanted to edit its shipping price of Canada to $2.99 USD, of Australia to $1.99, of Great Britain and Italy to "Use product variation prices", disable the product Mexico and Brazil, enable Wish Express for the product in France and Spain, disable Wish Express for the product in the United States and Canada, and set the default shipping price to $3.99 USD, your parameters would be:

• id = 123456789009876543211234
• access_token = an_example_access_token
• CA = 2.99
• localized_CA = 18
• AU = 1.99
• localized_AU = 12
• localized_currency_code = CNY
• disabled_countries = 'MX,BR'
• wish_express_add_countries = 'FR,ES'
• wish_express_remove_countries = 'US,CA'
• default_shipping_price = 3.99
• localized_default_shipping_price = 24

Example Request

<?php

$access_token = urlencode('an_example_access_token');
$id = urlencode('123456789009876543211234');
$CA = urlencode('2.99');
$localized_CA = urlencode('18');
$AU = urlencode('1.99');
$localized_AU = urlencode('18');
$localized_currency_code = urlencode('CNY');
$disabled_countries = urlencode('MX,BR');
$wish_express_add_countries = urlencode('FR,ES');
$wish_express_remove_countries = urlencode('US,CA');
$default_shipping_price = urlencode('3.99');
$localized_default_shipping_price = urlencode('24');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/product/update-multi-shipping?access_token=%s&id=%s&CA=%s&AU=%s&localized_CA=%s&localized_AU=%s&localized_currency_code=%s&disabled_countries=%s&wish_express_add_countries=%s&wish_express_remove_countries=%s&default_shipping_price=%s&localized_default_shipping_price=%s",
    $access_token, $id, $CA, $AU, $localized_CA, $localized_AU, $localized_currency_code, $disabled_countries, $wish_express_add_countries, $wish_express_remove_countries, $default_shipping_price, $localized_default_shipping_price);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'POST',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

<?php

?>

Example Response

{
    "message":"",
    "code":0,
    "data":{}
}

Example

Assume your access token is "an_example_access_token". If you had a product with id 123456789009876543211234 and you wanted to know its shipping price to Canada, your parameters would be:

• id = 123456789009876543211234
• access_token = an_example_access_token
• country = CA

Example Request

<?php

$access_token = urlencode('an_example_access_token');
$id = urlencode('123456789009876543211234');
$country = urlencode('CA');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/product/get-shipping?access_token=%s&id=%s&country=%s",
    $access_token, $id, $country);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'GET',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

<?php
require_once 'vendor/autoload.php';

use Wish\WishClient;

$access_token = 'an_example_access_token';

$client = new WishClient($access_token,'prod');
$client->getShippingById('123456789009876543211234', 'CA');

?>

Example Response

{
  "message": "",
  "code": 0,
  "data": {
    "ProductCountryShipping": {
      "DataV2": {
        "ProductCountryWarehouseShipping": {
          "wish_express": "True",
          "warehouses": [
            {
              "WarehouseShipping": {
                "price_type": "wish_express",
                "price": "3.0",
                "localized_price": "18.00",
                "localized_currency_code": "CNY",
                "warehouse_name": "EXPRESS-CA",
                "enabled": "True",
                "use_product_shipping": "False"
              }
            },
            {
              "WarehouseShipping": {
                "price_type": "normal",
                "price": "None",
                "localized_price": "",
                "localized_currency_code": "CNY",
                "warehouse_name": "STANDARD",
                "enabled": "False",
                "use_product_shipping": "True"
              }
            }
          ],
          "enabled": "True",
          "id": "123456789009876543211234",
          "country_code": "CA"
        }
      },
      "shipping_price": "3.0",
      "localized_shipping_price": "18.00",
      "localized_currency_code": "CNY",
      "country_code": "CA",
      "wish_express": "True",
      "enabled": "True",
      "id": "123456789009876543211234",
      "use_product_shipping": "True"
    }
  }
}

Example

Assume your access token is "an_example_access_token". If you had a product with id 123456789009876543211234, your parameters would be:

• id = 123456789009876543211234
• access_token = an_example_access_token

Example Request

<?php

$access_token = urlencode('an_example_access_token');
$id = urlencode('123456789009876543211234');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/product/get-shipping?access_token=%s&id=%s",
    $access_token, $id);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'GET',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

<?php
require_once 'vendor/autoload.php';

use Wish\WishClient;

$access_token = 'an_example_access_token';

$client = new WishClient($access_token,'prod');
$client->getAllShippingById('123456789009876543211234');

?>

Example Response

{
  "message": "",
  "code": 0,
  "data": {
    "ProductCountryAllShipping": {
      "shipping_prices": [
        {
          "ProductCountryShipping": {
            "shipping_price": "4.0",
            "localized_shipping_price": "24.0",
            "localized_currency_code": "CNY",
            "country_code": "CA",
            "wish_express": "False",
            "enabled": "True",
            "id": "53ec23e3104dae0ad27e1ecf",
            "use_product_shipping": "False"
          }
        },
        {
          "ProductCountryShipping": {
            "shipping_price": "Use Product Shipping Price",
            "localized_shipping_price": "",
            "localized_currency_code": "CNY",
            "country_code": "US",
            "wish_express": "False",
            "enabled": "True",
            "id": "53ec23e3104dae0ad27e1ecf",
            "use_product_shipping": "False"
          }
        }
      ],
      "id": "123456789009876543211234",
      "DataV2": {
        "ProductCountryWarehouseAllShipping": {
          "id": "123456789009876543211234",
          "countries": [
            {
              "ProductCountryWarehouseShipping": {
                "wish_express": "False",
                "warehouses": [
                  {
                    "WarehouseShipping": {
                      "price_type": "normal",
                      "price": "4.0",
                      "localized_shipping_price": "24.0",
                      "localized_currency_code": "CNY",
                      "warehouse_name": "STANDARD",
                      "enabled": "True",
                      "use_product_shipping": "False"
                    }
                  }
                ],
                "enabled": "True",
                "id": "123456789009876543211234",
                "country_code": "CA"
              }
            },
            {
              "ProductCountryWarehouseShipping": {
                "wish_express": "False",
                "warehouses": [
                  {
                    "WarehouseShipping": {
                      "price_type": "wish_express",
                      "price": "None",
                      "localized_shipping_price": "24.0",
                      "localized_currency_code": "CNY",
                      "warehouse_name": "EXPRESS-US",
                      "enabled": "True",
                      "use_product_shipping": "True",
                      "regional_shippings": [
                        {
                          "RegionalShipping": {
                            "state": "California",
                            "use_country_shipping": "True",
                            "localized_currency_code": "USD",
                            "price": "None",
                            "enabled": "False",
                            "localized_price": "None"
                        },
                      ]
                    }
                  },
                  {
                    "WarehouseShipping": {
                      "price_type": "normal",
                      "price": "None",
                      "localized_shipping_price": "",
                      "localized_currency_code": "CNY",
                      "warehouse_name": "STANDARD",
                      "enabled": "False",
                      "use_product_shipping": "True",
                      "regional_shippings": [
                        {
                          "RegionalShipping": {
                            "state": "Hawaii",
                            "use_country_shipping": "False",
                            "localized_currency_code": "USD",
                            "price": "5.0",
                            "enabled": "True",
                            "localized_price": "5.0"
                        },
                      ]
                    }
                  }
                ],
                "enabled": "True",
                "id": "123456789009876543211234",
                "country_code": "US"
              }
            }
          ]
        }
      }
    }
  }
}

Example

Assume your access token is "an_example_access_token". If you had a product with id 123456789009876543211234, your parameters would be:

• ids = 123456789009876543211234,111122223333444455556666
• access_token = an_example_access_token

Example Request

<?php

$access_token = urlencode('an_example_access_token');
$ids = urlencode('123456789009876543211234,111122223333444455556666');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/product/get-shipping?access_token=%s&ids=%s",
    $access_token, $ids);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'GET',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

<?php
require_once 'vendor/autoload.php';

use Wish\WishClient;

$access_token = 'an_example_access_token';

$client = new WishClient($access_token,'prod');
$client->getAllShippingById('123456789009876543211234');

?>

Example Response

{
  "message": "",
  "code": 0,
  "data": [
    {
      "ProductCountryAllShipping": {
        "shipping_prices": [
          {
            "ProductCountryShipping": {
              "shipping_price": "4.0",
              "localized_shipping_price": "24.0",
              "localized_currency_code": "CNY",
              "country_code": "CA",
              "wish_express": "False",
              "enabled": "True",
              "id": "123456789009876543211234",
              "use_product_shipping": "False"
            }
          },
          {
            "ProductCountryShipping": {
              "shipping_price": "None",
              "localized_shipping_price": "",
              "localized_currency_code": "CNY",
              "country_code": "US",
              "wish_express": "False",
              "enabled": "True",
              "id": "123456789009876543211234",
              "use_product_shipping": "False"
            }
          }
        ],
        "id": "123456789009876543211234",
        "DataV2": {
          "ProductCountryWarehouseAllShipping": {
            "id": "123456789009876543211234",
            "countries": [
              {
                "ProductCountryWarehouseShipping": {
                  "wish_express": "False",
                  "warehouses": [
                    {
                      "WarehouseShipping": {
                        "price_type": "normal",
                        "price": "4.0",
                        "localized_price": "24.0",
                        "localized_currency_code": "CNY",
                        "warehouse_name": "STANDARD",
                        "enabled": "True",
                        "use_product_shipping": "False"
                      }
                    }
                  ],
                  "enabled": "True",
                  "id": "123456789009876543211234",
                  "country_code": "CA"
                }
              },
              {
                "ProductCountryWarehouseShipping": {
                  "wish_express": "False",
                  "warehouses": [
                    {
                      "WarehouseShipping": {
                        "price_type": "wish_express",
                        "price": "None",
                        "localized_price": "",
                        "localized_currency_code": "CNY",
                        "warehouse_name": "EXPRESS-US",
                        "enabled": "True",
                        "use_product_shipping": "True",
                        "regional_shippings": [
                          {
                            "RegionalShipping": {
                              "state": "California",
                              "use_country_shipping": "True",
                              "price": "None",
                              "localized_price": "None",
                              "localized_currency_code": "CNY",
                              "enabled": "False",
                          },
                        ]
                      }
                    },
                    {
                      "WarehouseShipping": {
                        "price_type": "normal",
                        "price": "None",
                        "localized_price": "",
                        "localized_currency_code": "CNY",
                        "warehouse_name": "STANDARD",
                        "enabled": "True",
                        "use_product_shipping": "True",
                        "regional_shippings": [
                          {
                            "RegionalShipping": {
                              "state": "Hawaii",
                              "use_country_shipping": "False",
                              "price": "5.0",
                              "localized_price": "30.0",
                              "localized_currency_code": "CNY",
                              "enabled": "True",
                          },
                        ]
                      }
                    }
                  ],
                  "enabled": "True",
                  "id": "123456789009876543211234",
                  "country_code": "US"
                }
              }
            ]
          }
        }
      }
    },
    {
      "ProductCountryAllShipping": {
        "shipping_prices": [
          {
            "ProductCountryShipping": {
              "shipping_price": "7.0",
              "localized_shipping_price": "42.0",
              "localized_currency_code": "CNY",
              "country_code": "CA",
              "wish_express": "False",
              "enabled": "True",
              "id": "111122223333444455556666",
              "use_product_shipping": "False"
            }
          },
          {
            "ProductCountryShipping": {
              "shipping_price": "None",
              "localized_shipping_price": "",
              "localized_currency_code": "CNY",
              "country_code": "US",
              "wish_express": "False",
              "enabled": "True",
              "id": "111122223333444455556666",
              "use_product_shipping": "False"
            }
          }
        ],
        "id": "111122223333444455556666",
        "DataV2": {
          "ProductCountryWarehouseAllShipping": {
            "id": "111122223333444455556666",
            "countries": [
              {
                "ProductCountryWarehouseShipping": {
                  "wish_express": "False",
                  "warehouses": [
                    {
                      "WarehouseShipping": {
                        "price_type": "normal",
                        "price": "7.0",
                        "localized_price": "42.0",
                        "localized_currency_code": "CNY",
                        "warehouse_name": "STANDARD",
                        "enabled": "True",
                        "use_product_shipping": "False"
                      }
                    }
                  ],
                  "enabled": "True",
                  "id": "111122223333444455556666",
                  "country_code": "CA"
                }
              },
              {
                "ProductCountryWarehouseShipping": {
                  "wish_express": "False",
                  "warehouses": [
                    {
                      "WarehouseShipping": {
                        "price_type": "wish_express",
                        "price": "3.0",
                        "localized_price": "18.0",
                        "localized_currency_code": "CNY",
                        "warehouse_name": "EXPRESS-US",
                        "enabled": "True",
                        "use_product_shipping": "False",
                        "regional_shippings": [
                          {
                            "RegionalShipping": {
                              "state": "Alaska",
                              "use_country_shipping": "False",
                              "price": "None",
                              "localized_price": "None",
                              "localized_currency_code": "CNY",
                              "enabled": "False",
                          },
                        ]
                      }
                    },
                    {
                      "WarehouseShipping": {
                        "price_type": "normal",
                        "price": "None",
                        "localized_price": "",
                        "localized_currency_code": "CNY",
                        "warehouse_name": "STANDARD",
                        "enabled": "True",
                        "use_product_shipping": "True",
                        "regional_shippings": [
                          {
                            "RegionalShipping": {
                              "state": "Hawaii",
                              "use_country_shipping": "False",
                              "price": "5.0",
                              "localized_price": "30.0",
                              "localized_currency_code": "CNY",
                              "enabled": "True",
                          },
                        ]
                      }
                    }
                  ],
                  "enabled": "True",
                  "id": "111122223333444455556666",
                  "country_code": "US"
                }
              }
            ]
          }
        }
      }
    }
  ]
}

Example

Assume your access token is "an_example_access_token". your parameters would be:

• access_token = an_example_access_token

Example Request

<?php

$access_token = urlencode('an_example_access_token');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/product/get-shipping-setting?access_token=%s",
    $access_token);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'GET',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

<?php
require_once 'vendor/autoload.php';

use Wish\WishClient;

$access_token = 'an_example_access_token';

$client = new WishClient($access_token,'prod');
$client->getShippingSetting();

?>

Example Response

{'code': 0,
 'data': {'ShippingSetting': {'country_settings': [
    {'CountryShippingSetting': {'country_code': 'AU',
      'shipping_price': '1.00',
      'use_product_shipping': 'False',
      'currency_code': 'USD'}},
    {'CountryShippingSetting': {'country_code': 'CA',
      'shipping_price': '2.00',
      'use_product_shipping': 'False',
      'currency_code': 'USD'}},
    {'CountryShippingSetting': {'country_code': 'GB',
      'shipping_price': '3.00',
      'use_product_shipping': 'False',
      'currency_code': 'USD'}},
    {'CountryShippingSetting': {'country_code': 'US',
      'shipping_price': 'Use Product Shipping Price',
      'use_product_shipping': 'True',
      'currency_code': 'N/A'}}],
   'ships_worldwide': 'False'}},
 'message': ''}

Example #1

Assume your access token is "an_example_access_token". Suppose you want to download all of your Products:

Example Request

Example #2

Suppose you want to download a batch of Products with the following constraints:

• since = 2016-07-01

Example Request

<?php
require_once 'vendor/autoload.php';

use Wish\WishClient;

$access_token = 'an_example_access_token';

$client = new WishClient($access_token,'prod');
$since = '2016-07-01';
$client->productCreateDownloadJob('098765432112345678901234',$since);

<?php

$access_token = urlencode('an_example_access_token');

$since = urlencode('2016-07-01');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/product/create-download-job?access_token=%s&since=%s",
    $access_token, $since);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'POST',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    'code': 0,
    'data': {'job_id': "57bb5803ba2a1f181de31b01"},
    'message': ''
}

Example

Assume your access token is "an_example_access_token" . Suppose you want to check the progress of your batch Product download with job_id "57bb5803ba2a1f181de31b01":

• job_id = 57bb5803ba2a1f181de31b01
• access_token = an_example_access_token

Example Request

<?php
require_once 'vendor/autoload.php';

use Wish\WishClient;

$access_token = 'an_example_access_token';

$client = new WishClient($access_token,'prod');
$job_id = '57bb5803ba2a1f181de31b01';
$client->productGetDownloadJobStatus('098765432112345678901234',$job_id);

<?php

$access_token = urlencode('an_example_access_token');

$job_id = urlencode('57bb5803ba2a1f181de31b01');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/product/change-shipping?access_token=%s&job_id=%s",
    $access_token, $job_id);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'POST',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    'code': 0,
    'data': {
    "status": "PENDING",
        "created_date": "2016-08-18 02:40:25.238000"
    },
    'message': ''
}

Example Response

{
    'code': 0,
    'data': {
        "status": "FINISHED",
        "total_count": 20553,
        "processed_count": 20553,
        "download_link": "https://merchant.wish.com/static/sweeper-production-merchant-export/52f64e7aab980a038d62d61e-57bce38526778a33b3f8c375-2016-08-16-19:27:01.csv",
        "created_date": "2016-08-18 02:40:25.238000",
        "start_run_time": "2016-08-18 03:12:07.135000",
        "end_run_time": "2016-08-18 02:49:28.798000",
    },
    'message': ''
}

Example

Assume your access token is "an_example_access_token" . Suppose you want to cancel your batch Product download with job_id = "57bb5803ba2a1f181de31b01":

• job_id = 57bb5803ba2a1f181de31b01
• access_token = an_example_access_token

Example Request

<?php
require_once 'vendor/autoload.php';

use Wish\WishClient;

$access_token = 'an_example_access_token';

$client = new WishClient($access_token,'prod');
$job_id = '57bb5803ba2a1f181de31b01';
$client->productCancelDownloadJob('098765432112345678901234',$job_id);

<?php

$access_token = urlencode('an_example_access_token');

$job_id = urlencode('57bb5803ba2a1f181de31b01');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/product/change-shipping?access_token=%s&job_id=%s",
    $access_token, $job_id);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'POST',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    'code': 0,
    'data': {'message': 'Job cancelled successfully.'},
    'message': ''
}

Example Response

{
    'code': 0,
    'data': {'message': 'Job has already finished.'},
    'message': ''
}

Example Response

{
    'code': 0,
    'data': {'message': 'Job has already been cancelled.'},
    'message': ''
}

Example

Assume your access token is "an_example_access_token" . If you have a product with a parent sku red-shoe and you would like to add a variant for the size 12, with sku red-shoe-12, your parameters would be:

• parent_sku = red-shoe
• sku = red-shoe-12
• inventory = 10
• price = 10
• localized_price = 60
• localized_currency_code = CNY
• access_token = an_example_access_token
• size = 12

Example Request

<?php
require_once 'vendor/autoload.php';

use Wish\WishClient;

$access_token = 'an_example_access_token';

$client = new WishClient($access_token,'prod');
$product_var = array(
    'parent_sku'=>'red-shoe',
    'color'=>'red',
    'sku'=>'red-shoe-12',
    'inventory'=>10,
    'size'=>12,
    'price'=>10,
    'shipping'=>3,
    'localized_price'=>60,
    'localized_shipping'=>18,
);
$var = $client->createProductVariaiton($product_var);
print_r($var);

<?php

$access_token = urlencode('an_example_access_token');

$parent_sku = urlencode('red-shoe');
$sku = urlencode('red-shoe-12');
$inventory = urlencode('10');
$price = urlencode('10');
$shipping = urlencode('3');
$localized_price = urlencode('60'),
$localized_shipping = urlencode('18'),
$size = urlencode('12');
$url = sprintf(
"https://sandbox.merchant.wish.com/api/v2/variant/add?access_token=%s&sku=%s&inventory=%s&price=%s&shipping=%s&localized_price=%s&localized_shipping=%s&size=%s&parent_sku=%s",
$access_token, $sku, $inventory, $price, $shipping, $localized_cost, $localized_shipping_cost , $size, $parent_sku);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'POST',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{'code': 0,
 'data': {'Variant': {'enabled': 'True',
                      'id': '529e6c2cf94aaa0cfe02846f',
                      'inventory': '10',
                      'size': '12',
                      'sku': 'red-shoe-12',
                      'price': '10',
                      'shipping': '3',
                      'localized_price': '60',
                      'localized_shipping': '18'
                      'localized_currency_code': 'CNY' }}
 'msg' : '',
}

Example

Assume your access token is "an_example_access_token" . If your store has an item with sku "red-shoe-8" and you would like to know its state on with your request's parameters would be:

• sku = red-shoe-8
• access_token = an_example_access_token

Example Request

<?php
require_once 'vendor/autoload.php';

use Wish\WishClient;

$access_token = 'an_example_access_token';

$client = new WishClient($access_token,'prod');

$var = $client->getProductVariationBySKU('red-shoe-8');
print_r($var);

<?php

$access_token = urlencode('an_example_access_token');

$sku = urlencode('red-shoe-8');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/variant?access_token=%s&sku=%s",
    $access_token, $sku);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'GET',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{'code': 0,
 'data': {'Variant': {'enabled': 'True',
                      'id': '51e0a2c61111a236cfffe3a2',
                      'product_id' : '51e0a2c61111axxxcfffeyyy',
                      'inventory': '10100',
                      'msrp': '21100.0',
                      'price': '100.0',
                      'shipping': '10.0',
                                            'localized_price': '60',
                      'localized_shipping': '18',
                      'localized_currency_code': 'CNY',
                      'sku': 'red-shoe-8'}},
'message': ''}

Example

Assume your access token is "an_example_access_token" . If you have an item with the SKU 'blue-shoe-11' and it has the wrong size and you need to update its price, shipping and inventory your parameters would be:

• sku = blue-shoe-11
• price = 10.11
• localized_price = 60
• localized_currency_code = CNY
• inventory = 1000
• access_token = an_example_access_token

Lets say you didn't need to update price, then you would omit this parameter from your request.

Example Request

<?php
require_once 'vendor/autoload.php';

use Wish\WishClient;

$access_token = 'an_example_access_token';

$client = new WishClient($access_token,'prod');

$var = $client->getProductVariationBySKU('blue-shoe-11');
$var->inventory = 1000;
$var->price = 10.11;
$var->shipping = 10;
$var->localized_price = 60;
$var->localized_shipping = 60;
$var->localized_currency_code = CNY

$client->updateProductVariation($var);

<?php

$access_token = urlencode('an_example_access_token');

$sku = urlencode('blue-shoe-11');
$inventory = urlencode('1000');
$price = urlencode('10.11');
$shipping = urlencode('10.00');

$url = sprintf(
"https://sandbox.merchant.wish.com/api/v2/variant/update?access_token=%s&sku=%s&inventory=%s&price=%s&shipping=%s&localized_price=%s&localized_shipping=%s&localized_currency_code=%s",
$access_token, $sku, $inventory, $price, $shipping, $localized_price, $localized_shipping, $localized_currency_code);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'POST',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    'code': 0,
    'data': {},
    'message': ''
}

Example

Assume your access token is "an_example_access_token" . If you have an item with the SKU 'blue-shoe-11' and you would like to change it to 'blue-shoe-12' your parameters would be:

• sku = blue-shoe-11
• new_sku = blue-shoe-12
• access_token = an_example_access_token

Example Request

<?php
require_once 'vendor/autoload.php';

use Wish\WishClient;

$access_token = 'an_example_access_token';

$client = new WishClient($access_token,'prod');
$client->changeProductVariationSKU('blue-shoe-11', 'blue-shoe-12');

<?php

$access_token = urlencode('an_example_access_token');

$sku = urlencode('blue-shoe-11');
$new_sku = urlencode('blue-shoe-12');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/variant/update?access_token=%s&sku=%s&new_sku=%s",
    $access_token, $sku, $new_sku);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'POST',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    'code': 0,
    'data': {},
    'message': ''
}

Example

Assume your access token is "an_example_access_token" . If you have an item with the SKU 'blue-shoe-11' and you want to enable it, your parameters would be:

• sku = blue-shoe-11
• access_token = an_example_access_token

Example Request

<?php
require_once 'vendor/autoload.php';

use Wish\WishClient;

$access_token = 'an_example_access_token';

$client = new WishClient($access_token,'prod');
$client->enableProductVariationBySKU('blue-shoe-11');

<?php

$access_token = urlencode('an_example_access_token');

$sku = urlencode('blue-shoe-11');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/variant/enable?access_token=%s&sku=%s",
    $access_token, $sku);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'POST',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    'code': 0,
    'data': {},
    'message': ''
}

Example

Assume your access token is "an_example_access_token" . If you have an item with the SKU 'blue-shoe-11' and you want to disable it, your parameters would be:

• sku = blue-shoe-11
• access_token = an_example_access_token

Example Request

<?php
require_once 'vendor/autoload.php';

use Wish\WishClient;

$access_token = 'an_example_access_token';

$client = new WishClient($access_token,'prod');
$client->disableProductVariationBySKU('blue-shoe-11');

<?php

$access_token = urlencode('an_example_access_token');

$sku = urlencode('blue-shoe-11');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/variant/disable?access_token=%s&sku=%s",
    $access_token, $sku);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'POST',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    'code': 0,
    'data': {},
    'message': ''
}

Example

Assume your access token is "an_example_access_token" . If you have an item with the SKU 'blue-shoe-11' and you want to update the inventory to 100, your parameters would be:

• sku = blue-shoe-11
• access_token = an_example_access_token
• inventory = 100

Example Request

<?php
require_once 'vendor/autoload.php';

use Wish\WishClient;

$access_token = 'an_example_access_token';

$client = new WishClient($access_token,'prod');
$client->updateProductInventoryBySKU('blue-shoe-11',100);

<?php

$access_token = urlencode('an_example_access_token');

$sku = urlencode('blue-shoe-11');
$inventory = urlencode('100');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/variant/update-inventory?access_token=%s&sku=%s&inventory=%s",
    $access_token, $sku, $inventory);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'POST',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    'code': 0,
    'data': {},
    'message': ''
}

Example

Assume your access token is "an_example_access_token" . If you would like to fetch information about all your items in groups of 2 and you would like to see the 10th group:

• start = 20
• limit = 2
• access_token = an_example_access_token

Example Request

<?php
require_once 'vendor/autoload.php';

use Wish\WishClient;

$access_token = 'an_example_access_token';

$client = new WishClient($access_token,'prod');
$variations = $client->getAllProductVariations();
echo "You have ".count($variations)." product variations!\n";

<?php

$access_token = urlencode('an_example_access_token');

$start = urlencode('20');
$limit = urlencode('2');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/variant/multi-get?access_token=%s&start=%s&limit=%s",
    $access_token, $start, $limit);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'GET',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

Example Response
{'code': 0,
 'data': [{'Variant': {'enabled': 'True',
                       'id': '5215451b31111f73ff2xxxxxx',
                       'product_id' : '51e0a2c61111axxxcfffeyyy',
                       'inventory': '1314',
                       'msrp': '150.0',
                       'price': '100.0',
                       'shipping': '21.0',
                                              'localized_price': '600.0',
                       'localized_shipping': '126.0',
                       'localized_currency_code': 'CNY',
                       'sku': 'MMM'}},
            {'Variant': {'color': 'blue',
                       'enabled': 'True',
                       'id': '5214c1111c238837cdiiiiii',
                       'product_id' : '51e0a2c61111axxxcfffeyyy',
                       'inventory': '917',
                       'msrp': '100.0',
                       'price': '50.0',
                       'shipping': '9.81',
                       'localized_price': '300.0',
                       'localized_shipping': '60.0',
                       'localized_currency_code': 'CNY',
                       'sku': 'DD1111'}}],
'message': '',
'paging': {'next': 'https://sandbox.merchant.wish.com/api/v2/variant/multi-get?start=22&limit=2&access_token=an_example_access_token',
'previous': 'https://sandbox.merchant.wish.com/api/v2/variant/multi-get?start=18&limit=2&access_token=an_example_access_token'}}

Example

Assume your access token is "an_example_access_token". If you would like to update the inventory of SKU "aaa" to 10, and disable SKU "bbb":

• updates=[{"sku":"aaa","inventory":10},{"sku":"bbb","enabled":false}]
• access_token = an_example_access_token

Example Request

    Not supported in SDK yet.

<?php

$access_token = urlencode('an_example_access_token');

$updates = urlencode('[{"sku":"aaa","inventory":10},{"sku":"bbb","enabled":false}]');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/variant/bulk-sku-update?access_token=%s&updates=%s",
    $access_token, $updates);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'POST',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

Example Response
{
  "message": "",
  "code": 0,
  "data": {
    "job_id": "59e15a939a64f71c5024a1e3"
  }
}

Example

Assume your access token is "an_example_access_token". Suppose you want to check the status of your bulk update for product variations with job_id "59e00339b2d5b8367ac3e8bd":

• job_id = 59e00339b2d5b8367ac3e8bd
• access_token = an_example_access_token

Example Request

    Not supported in SDK yet.

<?php

$access_token = urlencode('an_example_access_token');

$job_id = urlencode('59e00339b2d5b8367ac3e8bd');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/variant/get-bulk-update-job-status?access_token=%s&job_id=%s",
    $access_token, $job_id);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'GET',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
  "message": "",
  "code": 0,
  "data": {
    "status": 4,
    "state": "FINISHED",
    "merchant_id": "515a29092f533b2778a7f625",
    "success_count": 10
    "end_time": 2017-10-17T05:48:21,
    "failure_count": 10,
    "start_time": "2017-10-17T05:46:51",
    "processed_count": 20,
    "results": {
        "successes": "https://merchant.wish.com/api/v2/variant/get-bulk-update-job-successes?job_id=59e00339b2d5b8367ac3e8bd"
        "failures": "https://merchant.wish.com/api/v2/variant/get-bulk-update-job-failures?job_id=59e00339b2d5b8367ac3e8bd"
    }
    "id": "59e5994b9a64f72cafea7730",
    "uploader_id": "5ae5923b9a64f72cab4a772a"
  }
}

Example

Assume your access token is "an_example_access_token". Suppose you want to check the first 5 SKUs from your bulk update for product variations with job_id "59e00339b2d5b8367ac3e8bd" that were updated successfully:

• job_id = 59e00339b2d5b8367ac3e8bd
• access_token = an_example_access_token
• limit = 5

Example Request

    Not supported in SDK yet.

<?php

$access_token = urlencode('an_example_access_token');

$job_id = urlencode('59e00339b2d5b8367ac3e8bd');

$limit = urlencode('5');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/variant/get-bulk-update-job-successes?access_token=%s&job_id=%s&limit=%s",
    $access_token, $job_id, $limit);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'GET',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
  "message": "",
  "code": 0,
  "data": {
    "successes": [
      "SKU1",
      "SKU2",
      "SKU3",
      "SKU4",
      "SKU5"
    ]
  },
  "paging": {
    "next": "https://merchant.wish.com/api/v2/variant/get-bulk-update-job-successes?start=5&limit=5"
  }
}

Example

Assume your access token is "an_example_access_token". Suppose you want to check the first 3 errors that were raised from your bulk update for product variations with job_id "59e00339b2d5b8367ac3e8bd":

• job_id = 59e00339b2d5b8367ac3e8bd
• access_token = an_example_access_token
• limit = 3

Example Request

    Not supported in SDK yet.

<?php

$access_token = urlencode('an_example_access_token');

$job_id = urlencode('59e00339b2d5b8367ac3e8bd');

$limit = urlencode('3');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/variant/get-bulk-update-job-failures?access_token=%s&job_id=%s&limit=%s",
    $access_token, $job_id, $limit);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'GET',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
  "message": "",
  "code": 0,
  "data": {
    "errors": [
      {
        "sku": "fake_sku1",
        "error_code": 29,
        "error": "Your store does not have product with SKU 'fake_sku1', therefore no update can be done."
      },
      {
        "sku": "fake_sku2",
        "error_code": 29,
        "error": "Your store does not have product with SKU 'fake_sku2', therefore no update can be done."
      },
      {
        "sku": "fake_sku3",
        "error_code": 29,
        "error": "Your store does not have product with SKU 'fake_sku3', therefore no update can be done."
      }
    ]
  },
  "paging": {
    "next": "https://merchant.wish.com/api/v2/variant/get-bulk-update-job-failures?start=3&limit=3"
  }
}

Example

Assume your access token is "an_example_access_token" . If you have an order with order_id "123456789009876543210164" and you would like to retrieve any updates to it:

• id = 123456789009876543210164
• access_token = an_example_access_token

Example Request

                                <?php
                                require_once 'vendor/autoload.php';

                                use Wish\WishClient;

                                $access_token = 'an_example_access_token';

                                $client = new WishClient($access_token,'prod');
                                $order = $client->getOrderById('123456789009876543210164');
                                print_r($order);
                                

                                    <?php

                                    $access_token = urlencode('an_example_access_token');

                                    $id = urlencode('123456789009876543210164');

                                    $url = sprintf(
                                        "https://sandbox.merchant.wish.com/api/v2/order?access_token=%s&id=%s",
                                        $access_token, $id);

                                    $context = stream_context_create(array(
                                        'http' => array(
                                            'method'        => 'GET',
                                            'ignore_errors' => true,
                                        ),
                                    ));

                                    // Send the request
                                    $response = file_get_contents($url, TRUE, $context);
                                    echo $response;
                                    echo "\n";
                                    ?>
                                

Example Response

{
    "message": "",
    "code": 0,
    "data": {
        "Order": {
            "is_fbw": "False",
            "last_updated": "2018-04-24T07:30:52",
            "order_time": "2018-04-23T05:24:53",
            "color": "lightbrown",
            "price": "1.0",
            "variant_id": "aabfd88a7ddb06714ae5dde3",
            "ShippingDetail": {
                "phone_number": "+86 13816792755",
                "city": "Shanghai",
                "state": "Shanghai",
                "name": "EPC Shanghai - 542195",
                "country": "CN",
                "zipcode": "201901",
                "street_address1": "No.419 Gongyue RD Baoshan District Shanghai - 542195"
            },
            "shipped_date": "2018-04-24",
            "cost": "0.85",
            "shipping_cost": "0.85",
            "currency_code": "USD",
            "is_wish_express": "False",
            "requires_delivery_confirmation": "False",
            "product_image_url": "https://contestimg.wish.com/api/webimage/5abfd8801ab08a1da66447ad-normal.jpg?cache_buster=4b66fc88f4ad4c7c3176cd07fbfab237",
            "size": "One Size",
            "sku": "aa2620a43d9844313509e019-light brown-One Size",
            "shipping_provider": "WishPost",
            "order_total": "1.7",
            "product_id": "aabfd8801ab08a1da66447ad",
            "tracking_confirmed": "True",
            "state": "SHIPPED",
            "shipping": "1.0",
            "OriginalShippingDetail": {
                "phone_number": "01233434",
                "city": "Edinburg",
                "state": "Texas",
                "name": "Mabel hinojosa",
                "country": "US",
                "zipcode": "78511",
                "street_address1": "aaaa n terry rd"
            },
            "order_id": "aadd6e252ad6c17fd4542195",
            "tracking_number": "WI0000000aa056EPC",
            "released_to_merchant_time": "2018-04-23T13:30:50",
            "is_combined_order": "True",
            "tracking_confirmed_date": "2018-04-24T15:43:40",
            "quantity": "1",
            "product_name": "Waterproof Eyebrow Pencil Pen Eye Brow Liner Cosmetic Makeup Beauty Tool Lasting waterproof eye brow pencil",
            "transaction_id": "aadd6e22a016522e7b6f781e",
            "fine_ids": ["5ab4e367ae3004ebb12c28ab"],
            "confirmed_delivery": "Yes",
            "date_shipping_carrier_confirmed_delivery": "2018-08-28"
        }
    }
}
                            

Example

Assume your access token is "an_example_access_token" . If you use this API to sync Wish orders into your order tracking software and you need all the orders that have changed since Jan 20, 2014 and you would like them in pages of 100 and you need the second page: (And you would like to get the original shipping details)

• start = 200
• limit = 100
• since = 2014-01-20
• access_token = an_example_access_token
• show_original_shipping_detail = True

Example Request

                                <?php
                                require_once 'vendor/autoload.php';

                                use Wish\WishClient;

                                $access_token = 'an_example_access_token';

                                $client = new WishClient($access_token,'prod');
                                $orders = $client->getAllChangedOrdersSince('2010-01-20');
                                echo "You have ".count($orders)." changed orders since 2010-01-20\n";
                                

                                <?php

                                $access_token = urlencode('an_example_access_token');

                                $start = urlencode('200');
                                $limit = urlencode('100');
                                $since = urlencode('2014-01-20');

                                $url = sprintf(
                                    "https://sandbox.merchant.wish.com/api/v2/order/multi-get?access_token=%s&start=%s&limit=%s&since=%s",
                                    $access_token, $start, $limit, $since);

                                $context = stream_context_create(array(
                                    'http' => array(
                                        'method'        => 'GET',
                                        'ignore_errors' => true,
                                    ),
                                ));

                                // Send the request
                                $response = file_get_contents($url, TRUE, $context);
                                echo $response;
                                echo "\n";
                                ?>
                                

Example Response

{
    "message": "",
    "code": 0,
    "data": [
        {
            "Order": {
                "is_fbw": "False",
                "last_updated": "2018-04-20T09:58:20",
                "order_time": "2018-04-15T22:06:32",
                "color": "white",
                "price": "8.0",
                "variant_id": "aa4a4305227c624cbe00698c",
                "ShippingDetail": {
                    "phone_number": "3282833435",
                    "city": "Phillsburfg%b",
                    "state": "New Jersey",
                    "name": "John",
                    "country": "US",
                    "zipcode": "08865",
                    "street_address1": "111 Thomas St"
                },
                "shipped_date": "2018-04-20",
                "cost": "6.8",
                "shipping_cost": "5.1",
                "currency_code": "USD",
                "is_wish_express": "False",
                "requires_delivery_confirmation": "True",
                "product_image_url": "https://contestimg.wish.com/api/webimage/5a4a42ffd20e930b10742434-normal.jpg?cache_buster=60a9f08ac10fba8a58d571996f336a3f",
                "size": "7(EUR37)",
                "sku": "aaf3106_7_White",
                "shipping_provider": "EMS",
                "order_total": "11.9",
                "product_id": "aa4a42ffd20e930b10742434",
                "tracking_confirmed": "True",
                "state": "SHIPPED",
                "shipping": "6.0",
                "order_id": "aad3cce86cb7a067f1680a92",
                "tracking_number": "LY113628433CN",
                "released_to_merchant_time": "2018-04-16T06:20:21",
                "is_combined_order": "False",
                "tracking_confirmed_date": "2018-04-24T12:15:48",
                "quantity": "1",
                "product_name": "Fashion Womens Sneakers Breathable Mesh Running Sports Shoes",
                "transaction_id": "aad3cce5d130801451d77758",
                "fine_ids": ["5ab4e367ae3004ebb12c28ab"]
            }
        },
        {
            "Order": {
                "is_fbw": "False",
                "last_updated": "2018-04-20T07:09:09",
                "order_time": "2018-03-12T20:23:25",
                "color": "rose",
                "price": "8.0",
                "variant_id": "aa4a433695f79f3bc9f0c381",
                "ShippingDetail": {
                    "phone_number": "+86 13816792755",
                    "city": "Shanghai",
                    "state": "Shanghai",
                    "name": "EPC Shanghai - 088220",
                    "country": "CN",
                    "zipcode": "201901",
                    "street_address1": "No.419 Gongyue RD Baoshan District Shanghai - 088220"
                },
                "shipped_date": "2018-03-15",
                "cost": "6.8",
                "shipping_cost": "5.1",
                "currency_code": "USD",
                "is_wish_express": "False",
                "requires_delivery_confirmation": "True",
                "product_image_url": "https://contestimg.wish.com/api/webimage/5a4a42ffd20e930b10742434-normal.jpg?cache_buster=60a9f08ac10fba8a58d571996f336a3f",
                "size": "6(EUR35)",
                "sku": "aaf31048_6_Rose",
                "shipping_provider": "WishPost",
                "order_total": "11.9",
                "product_id": "aa4a42ffd20e930b10742434",
                "tracking_confirmed": "True",
                "state": "SHIPPED",
                "shipping": "6.0",
                "OriginalShippingDetail": {
                    "phone_number": "206446113765",
                    "city": "Des moines",
                    "state": "Washington",
                    "name": "Uyen John",
                    "country": "US",
                    "zipcode": "98198",
                    "street_address1": "1111 marine view dr. S"
                },
                "order_id": "aaa6e1bd631b6c703c088220",
                "tracking_number": "WI110000001743EPC",
                "released_to_merchant_time": "2018-03-13T04:31:02",
                "is_combined_order": "True",
                "tracking_confirmed_date": "2018-03-15T15:54:24",
                "quantity": "1",
                "product_name": "Fashion Womens Sneakers Breathable Mesh Running Sports Shoes",
                "transaction_id": "aaa6e1bcb40365735be165a9",
                "fine_ids": []
            }
        }
    ],
    "paging": {
        "next": "https://merch.corp.contextlogic.com/api/v2/order/multi-get?show_original_shipping_detail=True&start=121&limit=20&access_token=8f937c7c6cea4f8c89f6428444edb178&since=2018-04-20",
        "previous": "https://merch.corp.contextlogic.com/api/v2/order/multi-get?show_original_shipping_detail=True&start=81&limit=20&access_token=8f937c7c6cea4f8c89f6428444edb178&since=2018-04-20"
    }
}
                            

Example

Assume your access token is "an_example_access_token" . If you want to get all the orders which still require fulfillment in pages of 100:

• start = 0
• limit = 100
• access_token = an_example_access_token

Example Request

<?php
require_once 'vendor/autoload.php';

use Wish\WishClient;

$access_token = 'an_example_access_token';

$client = new WishClient($access_token,'prod');
$orders = $client->getAllUnfulfilledOrdersSince('2010-01-20');
echo "You have ".count($orders)." unfulfilled orders since 2010-01-20";

<?php

$access_token = urlencode('an_example_access_token');

$start = urlencode('0');
$limit = urlencode('100');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/order/get-fulfill?access_token=%s&start=%s&limit=%s",
    $access_token, $start, $limit);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'GET',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{'code': 0,
 'data': [{'Order': {'ShippingDetail': {'city': 'New York City',
                                        'country': 'US',
                                        'name': 'Guadalupe Smith',
                                        'phone_number': '5554191609',
                                        'state': 'California',
                                        'street_address1': '3317 w 51st Street',
                                        'zipcode': '60632'},
                      'last_updated': '2014-01-20T20:20:20',
                      'order_time': '2014-01-20T20:20:20',
                      'released_to_merchant_time': '2014-01-20T21:20:20',
                      'order_id': '123456789009876543210164',
                      'order_total': '17.6',
                      'product_id': '1113fad43deaf71536cb2c74',
                      'quantity': '2',
                      'price':'8',
                      'cost':u’6.8',
                      'shipping':'2.35',
                      'shipping_cost':'2',
                      'product_name':'Dandelion Necklace',
                      'product_image_url':'http://d1zog42tnv26ho.cloudfront.net/4fea11fac43bf532f4001419-normal.jpg',
                      'days_to_fulfill': '2',
                      'hours_to_fulfill': '49',
                      'sku': 'Dandelion Necklace',
                      'state': 'APPROVED',
                      'transaction_id': '11114026a99e980d4e500269',
                      'variant_id': '1111fad63deaf71536cb2c76',
                      'is_combined_order': False,
                      'fine_ids': []}},
           {'Order': {'ShippingDetail': {'city': 'Lake City',
                                         'country': 'US',
                                         'name': 'Marko Schroeder',
                                         'phone_number': '+1 555-399-7785',
                                         'state': 'NY',
                                         'street_address1': '20685 W Verona Ave',
                                         'zipcode': '60046'},
                       'last_updated': '2014-01-20T20:20:20',
                       'order_time': '2014-01-20T20:20:20',
                       'released_to_merchant_time': '2014-01-20T21:20:20',
                       'order_id': '1114a7cfb2ec2d42d272b627',
                       'order_total': '17.6',
                      'product_id': '1113fad43deaf71536cb2c74',
                      'quantity': '2',
                      'price':'8',
                      'cost':'6.8',
                      'shipping':'2.35',
                      'shipping_cost':'2',
                      'currency_code': 'USD',
                      'product_name':'Dandelion Necklace',
                      'product_image_url':'http://d1zog42tnv26ho.cloudfront.net/4fea11fac43bf532f4001419-normal.jpg',
                      'days_to_fulfill': '2',
                      'hours_to_fulfill': '49',
                      'sku': 'Dandelion Necklace',
                      'state': 'APPROVED',
                      'transaction_id': '11114026a99e980d4e500269',
                      'variant_id': '1111fad63deaf71536cb2c76',
                      'is_combined_order': False,
                      'fine_ids': []}}],
 'message': '',
 'paging': {'next': 'https://sandbox.merchant.wish.com/api/v2/order/get-fulfill?start=100&limit=100&access_token=an_example_access_token'}}

Example

Assume your access token is "an_example_access_token" . Use this if you have shipped an order to a user and would like to mark it shipped on Wish. If the order's order_id is "098765432112345678901234",the tracking number is "12345679" and the provider is USPS:

• id = 098765432112345678901234
• tracking_provider = USPS
• tracking_number = 12345678
• origin_country_code = CN
• access_token = an_example_access_token

Example Request

<?php
require_once 'vendor/autoload.php';

use Wish\WishClient;
use Wish\Model\WishTracker;

$access_token = 'an_example_access_token';

$client = new WishClient($access_token,'prod');
$tracker = new WishTracker('USPS','12345678','some message');
$client->fulfillOrderById('098765432112345678901234',$tracker);

<?php

$access_token = urlencode('an_example_access_token');

$id = urlencode('098765432112345678901234');
$tracking_provider = urlencode('usps');
$tracking_number = urlencode('12345678');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/order/fulfill-one?access_token=%s&tracking_provider=%s&tracking_number=%s&id=%s",
    $access_token, $tracking_provider, $tracking_number, $id);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'POST',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    'code': 0,
    'data': {'success': True},
    'message': 'Your order is been processed right now!'
}

Example

Assume your access token is "an_example_access_token" . If you want to refund the order with order_id "098765432112345678901234" because you are out of inventory.

• id = 098765432112345678901234
• reason_code = 18
• access_token = an_example_access_token

Example Request

<?php
require_once 'vendor/autoload.php';

use Wish\WishClient;
use Wish\Model\WishReason;

$access_token = 'an_example_access_token';

$client = new WishClient($access_token,'prod');
$client->refundOrderById('098765432112345678901234',WishReason::NO_MORE_INVENTORY);

<?php

$access_token = urlencode('an_example_access_token');

$id = urlencode('098765432112345678901234');
$reason_code = urlencode('18');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/order/refund?access_token=%s&reason_code=%s&id=%s",
    $access_token, $reason_code, $id);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'POST',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    'code': 0,
    'data': {'success': True},
    'message': ''
}

Example

Assume your access token is "an_example_access_token" . Suppose you want to update the order with order_id "098765432112345678901234" to have tracking_provider of 'USPS' and tracking number of "12345678":

• id = 098765432112345678901234
• tracking_provider = USPS
• tracking_number = 12345678
• origin_country_code = CN
• access_token = an_example_access_token

Example Request

<?php
require_once 'vendor/autoload.php';

use Wish\WishClient;
use Wish\Model\WishTracker;

$access_token = 'an_example_access_token';

$client = new WishClient($access_token,'prod');
$tracker = new WishTracker('USPS','12345678','some message');
$client->changeShippingById('098765432112345678901234',$tracker);

<?php

$access_token = urlencode('an_example_access_token');

$id = urlencode('098765432112345678901234');
$tracking_provider = urlencode('usps');
$tracking_number = urlencode('12345678');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/order/modify-tracking?access_token=%s
    &tracking_provider=%s&tracking_number=%s&id=%s",
    $access_token, $tracking_provider, $tracking_number, $id);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'POST',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    'code': 0,
    'data': {'success': True},
    'message': ''
}

Example

Assume your access token is "an_example_access_token" . Suppose you want to update the order with order_id "098765432112345678901234" to have a new, customer provided shipping address:

• id = 098765432112345678901234
• street_address1 = 123 Fake St
• city = Montreal
• state = CA
• access_token = an_example_access_token

Example Request

<?php
require_once 'vendor/autoload.php';

use Wish\WishClient;
use Wish\Model\WishAddress;

$access_token = 'an_example_access_token';

$client = new WishClient($access_token,'prod');
$address = new WishAddress('123 Fake St', null,'Montreal','CA', '123456', 'US', '450-012-3456');
$client->updateShippingAddressInfoById('098765432112345678901234',$address);

<?php

$access_token = urlencode('an_example_access_token');

$id = urlencode('098765432112345678901234');
$street_address1 = urlencode('123 Fake St');
$city = urlencode('Montreal');
$state = urlencode('US');
$country = urlencode('CA');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/order/change-shipping?access_token=%s
    &street_address1=%s&city=%s&state=%s&country=%s&id=%s",
    $access_token, $street_address1, $city, $state, $country);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'POST',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    'code': 0,
    'data': {'success': True},
    'message': ''
}

Example #1

Assume your access token is "an_example_access_token". Suppose you want to download all of your Orders:

Example Request

Example #2

Suppose you want to download a batch of Orders with the following constraints:

• start = 2016-07-01
• end = 2016-07-25

Example Request

<?php
require_once 'vendor/autoload.php';

use Wish\WishClient;

$access_token = 'an_example_access_token';

$client = new WishClient($access_token,'prod');
$start = '2016-07-01';
$end = '2016-07-25';
$client->orderCreateDownloadJob('098765432112345678901234',$start,$end);

<?php

$access_token = urlencode('an_example_access_token');

$start = urlencode('2016-07-01');
$end = urlencode('2016-07-25');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/order/create-download-job?access_token=%s
    &start=%s&end=%s",
    $access_token, $start, $end);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'POST',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    'code': 0,
    'data': {'job_id': "57bb5803ba2a1f181de31b01"},
    'message': ''
}

Example

Assume your access token is "an_example_access_token" . Suppose you want to check the progress of your batch Order download with job_id "57bb5803ba2a1f181de31b01":

• job_id = 57bb5803ba2a1f181de31b01
• access_token = an_example_access_token

Example Request

<?php
require_once 'vendor/autoload.php';

use Wish\WishClient;

$access_token = 'an_example_access_token';

$client = new WishClient($access_token,'prod');
$job_id = '57bb5803ba2a1f181de31b01';
$client->orderGetDownloadJobStatus('098765432112345678901234',$job_id);

<?php

$access_token = urlencode('an_example_access_token');

$job_id = urlencode('57bb5803ba2a1f181de31b01');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/order/change-shipping?access_token=%s&job_id=%s",
    $access_token, $job_id);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'POST',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    'code': 0,
    'data': {
    "status": "PENDING",
        "created_date": "2016-08-18 02:40:25.238000"
    },
    'message': ''
}

Example Response

{
    'code': 0,
    'data': {
        "status": "FINISHED",
        "total_count": 20553,
        "processed_count": 20553,
        "download_link": "https://merchant.wish.com/static/sweeper-production-merchant-export/52f64e7aab980a038d62d61e-57bce38526778a33b3f8c375-2016-08-16-19:27:01.csv",
        "created_date": "2016-08-18 02:40:25.238000",
        "start_run_time": "2016-08-18 03:12:07.135000",
        "end_run_time": "2016-08-18 02:49:28.798000",
    },
    'message': ''
}

Example

Assume your access token is "an_example_access_token" . Suppose you want to cancel your batch Order download with job_id = "57bb5803ba2a1f181de31b01":

• job_id = 57bb5803ba2a1f181de31b01
• access_token = an_example_access_token

Example Request

<?php
require_once 'vendor/autoload.php';

use Wish\WishClient;

$access_token = 'an_example_access_token';

$client = new WishClient($access_token,'prod');
$job_id = '57bb5803ba2a1f181de31b01';
$client->orderCancelDownloadJob('098765432112345678901234',$job_id);

<?php

$access_token = urlencode('an_example_access_token');

$job_id = urlencode('57bb5803ba2a1f181de31b01');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/order/change-shipping?access_token=%s&job_id=%s",
    $access_token, $job_id);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'POST',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    'code': 0,
    'data': {'message': 'Job cancelled successfully.'},
    'message': ''
}

Example Response

{
    'code': 0,
    'data': {'message': 'Job has already finished.'},
    'message': ''
}

Example Response

{
    'code': 0,
    'data': {'message': 'Job has already been cancelled.'},
    'message': ''
}

Example

Assume your access token is "an_example_access_token". Suppose you want a list of shipping carriers that provide Delivery Confirmation to the US:

• access_token = an_example_access_token

Example Request

<?php
require_once 'vendor/autoload.php';

use Wish\WishClient;

$access_token = 'an_example_access_token';

$client = new WishClient($access_token,'prod');
$client->orderGetConfirmedDeliveryCountries('098765432112345678901234');

<?php

$access_token = urlencode('an_example_access_token');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/order/get-confirmed-delivery-countries?access_token=%s",
    $access_token);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'POST',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    'message': '',
    'code': 0,
    'data': {
        'countries' : [ 'FR',
                        'DE',
                        'GB',
                        'US' ]
    }
}

Example

Assume your access token is "an_example_access_token". Suppose you want a list of shipping carriers that provide Delivery Confirmation to the US:

• country_code = US
• access_token = an_example_access_token

Example Request

<?php
require_once 'vendor/autoload.php';

use Wish\WishClient;

$access_token = 'an_example_access_token';

$client = new WishClient($access_token,'prod');
$country_code = 'US'
$client->orderGetConfirmedDeliveryShippingCarriersForCountry('098765432112345678901234',$country_code);

<?php

$access_token = urlencode('an_example_access_token');

$country_code = urlencode('US');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/order/get-confirmed-delivery-shipping-carriers-for-country?access_token=%s&country_code=%s",
    $access_token, $country_code);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'POST',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    'message': '',
    'code': 0,
    'data': {
        'carriers': [ 'USPS',
                      'WishPost',
                      'EMS (China)',
                      'AsendiaUSA',
                      'BRTBartolini',
                      'DHLExpress',
                      'DPD',
                      'DPEXChina',
                      'EMPSExpress',
                      'EPacket',
                      'FedEx',
                      'GLS',
                      'Hermes',
                      'SFExpress',
                      'TNT',
                      'TollIPEC',
                      'UPS',
                      'XPO',
                      'YODEL'],
        'extra_info': {
            'WishPost': 'https://merchant.wish.com/documentation/confirmeddeliveryshippingcarriers'
        }
  }
}

Example Response

{
    'code': 0,
    'data': {
        'carriers': [],
        'extra_info': {}
  },
  'message': ''
}

Example

Assume your access token is "an_example_access_token" .

• access_token = an_example_access_token

Example Request

<?php
require_once 'vendor/autoload.php';

use Wish\WishClient;

$access_token = 'an_example_access_token';

$client = new WishClient($access_token,'prod');
$warehouses = $client->getAllWarehouses();
print_r($warehouses);

<?php

$access_token = urlencode('an_example_access_token');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/warehouse/get-all?access_token=%s",
    $access_token);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'GET',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
  "message": "",
  "code": 0,
  "data": [
    {
      "MerchantWarehouse": {
        "warehouse_type_name": "EXPRESS",
        "destination_countries": [
          "US"
        ],
        "warehouse_type": "2",
        "id": "59e6xxxxxxxxxxxxxxxxxxxx",
        "warehouse_unit_id": "EXPRESS-US"
      }
    },
    {
      "MerchantWarehouse": {
        "warehouse_type_name": "STANDARD",
        "warehouse_type": "1",
        "id": "59e6xxxxxxxxxxxxxxxxxxxx",
        "warehouse_unit_id": "STANDARD"
      }
    }
  ]
}

Example

Assume your access token is "an_example_access_token" . If you have an ticket with id "123456789009876543210164" and you would like to retrieve any updates to it:

• id = 123456789009876543210164
• access_token = an_example_access_token

Example Request

<?php
require_once 'vendor/autoload.php';

use Wish\WishClient;

$access_token = 'an_example_access_token';

$client = new WishClient($access_token,'prod');
$ticket = $client->getTicketById('123456789009876543210164');
print_r($ticket);

<?php

$access_token = urlencode('an_example_access_token');

$id = urlencode('123456789009876543210164');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/ticket?access_token=%s&id=%s",
    $access_token, $id);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'GET',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{'code': 0,
 'data': {'Ticket': {'UserInfo': {'id': '123456789012345678901234',
                                     'joined_date': '2012-02-02T11:22:21',
                                     'locale': 'en',
                                     'name': 'George Forman'},
                       'close_date': '2015-03-08T22:31:02',
                       'closed_by': 'wish support',
                       'id': '123456789012345678901234',
                       'items': [{'Order': {'ShippingDetail': {'city': '',
                                                                  'country': 'US',
                                                                  'name': 'George Forman',
                                                                  'phone_number': '123456',
                                                                  'state': 'California',
                                                                  'street_address1': '123 Fake St',
                                                                  'zipcode': '11111'},
                                              'cost': '6.69',
                                              'currency_code': 'USD',
                                              'last_updated': '2011-03-08T22:31:02',
                                              'order_id': '123456789012345678901234',
                                              'order_time': '2015-02-20T02:55:27',
                                              'released_to_merchant_time': '2015-02-20T03:55:27',
                                              'order_total': '9.39',
                                              'price': '6.4',
                                              'product_id': '123456789012345678901234',
                                              'product_image_url': 'https://google.com/not-a-image',
                                              'product_name': 'A product',
                                              'quantity': '1',
                                              'refunded_by': 'REFUNDED BY WISH FOR MERCHANT',
                                              'refunded_reason': 'Item did not work as described',
                                              'refunded_time': '2015-03-18',
                                              'shipped_date': '2015-02-20',
                                              'shipping': '3.0',
                                              'shipping_cost': '2.7',
                                              'shipping_provider': 'USPS',
                                              'sk': 'SKU123',
                                              'state': 'REFUNDED',
                                              'tracking_number': 'TR1234ACK',
                                              'transaction_id': '1223456789012345678901234',
                                              'variant_id': '123456789012345678901234'}}],
                       'label': 'Return or Exchange',
                       'last_update_date': '2015-02-09T12:13:43',
                       'merchant_id': '123456789012345678901234',
                       'open_date': '2015-03-06T21:23:01',
                       'photo_proof': 'True',
                       'replies': [{'Reply': {'date': '2015-03-06T21:23:01',
                                                'image_urls': "['https://fake-url']",
                                                'message': "Where is my product?",
                                                'sender': 'user',
                                                'translated_message': "Where is my product?",
                                                'translated_message_zh': '哪里是我的产品？'}}]
                       'state': 'Awaiting your response',
                       'state_id': '1',
                       'subject': 'Return or Exchange',
                       'sublabel': '',
                       'transaction_id': '123456789012345678901234'}},
 'message': ''}

Example

Assume your access token is "an_example_access_token" . If you would like to view your tickets in groups of 2 and you would like to see the 10th group your parameters would be:

• start = 20
• limit = 2
• access_token = an_example_access_token

Example Request

<?php
require_once 'vendor/autoload.php';

use Wish\WishClient;

$access_token = 'an_example_access_token';

$client = new WishClient($access_token,'prod');
$tickets = $client->getAllActionRequiredTickets();
echo "You have ".count($tickets)." tickets!\n";

<?php

$access_token = urlencode('an_example_access_token');

$start = urlencode('20');
$limit = urlencode('2');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/ticket/get-action-required?access_token=%s&limit=%s&start=%s",
    $access_token, $limit, $start);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'GET',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{'code': 0,
 'data': [{'Ticket': {'UserInfo': {'id': '54f8e4ef2743dxxxxxxxxxxx',
                                      'joined_date': '2014-03-05T13:21:19',
                                      'locale': 'pt',
                                      'name': 'Mr. Rogers'},
                        'default_refund_reason': '19',
                        'id': '54f8ecd2f0812xxxxxxxxxx',
                        'items': [{'Order': {'ShippingDetail': {'city': 'San Fransicso',
                                                                   'country': 'BR',
                                                                   'name': 'Mr. Rogers',
                                                                   'phone_number': '1234567890',
                                                                   'state': 'S\xe3o Paulo',
                                                                   'street_address1': '123 Fake St',
                                                                   'street_address2': 'Apt 5',
                                                                   'zipcode': '10000000'},
                                               'color': 'black',
                                               'cost': '16.2',
                                               'currency_code': 'USD',
                                               'last_updated': '2014-03-06T07:37:16',
                                               'order_id': '123456789012345678901234',
                                               'order_time': '2015-03-05T23:40:53',
                                               'released_to_merchant_time': '2015-03-05T23:45:53',
                                               'order_total': '22.5',
                                               'price': '18.0',
                                               'product_id': '123456789012345678901234',
                                               'product_image_url': 'http://contestimg.wish.com/api/webimage/123456789012345678901234-normal.jpg',
                                               'product_name': 'Cloth',
                                               'quantity': '1',
                                               'refunded_by': 'CANCELLED BY CUSTOMER',
                                               'refunded_reason': 'Customer cancelled the order',
                                               'refunded_time': '2015-03-05',
                                               'shipping': '7.0',
                                               'shipping_cost': '6.3',
                                               'size': 'M',
                                               'sk': 'SKU123-XL',
                                               'state': 'REFUNDED',
                                               'transaction_id': '123456789012345678901234',
                                               'variant_id': '5285bd3fb5baba7*********'}}],
                        'label': 'Request Refund/Cancel Order: Request a Different Color',
                        'last_update_date': '2015-03-09T12:13:57',
                        'merchant_id': '123456789012345678901234',
                        'open_date': '2015-03-05T23:54:58',
                        'photo_proof': 'False',
                        'replies': [{'Reply': {'date': '2015-03-05T23:54:58',
                                                 'image_urls': '[]',
                                                 'message': 'Quero meu reembolso ',
                                                 'sender': 'user',
                                                 'translated_message': 'I want my refund',
                                                 'translated_message_zh': '我希望我的退款'}}],
                        'state': 'Awaiting your response',
                        'state_id': '4',
                        'subject': 'Solicitar Reembolso/ Cancelar Pedido',
                        'sublabel': 'Request a Different Color',
                        'transaction_id': '123456789012345678901234'}},
           {'Ticket': {'UserInfo': {'id': '123456789012345678901234',
                                      'joined_date': '2011-12-12T05:22:52',
                                      'locale': 'en',
                                      'name': 'George Bush'},
                        'id': '123456789012345678901234',
                        'items': [{'Order': {'ShippingDetail': {'city': 'Waterloo',
                                                                   'country': 'CA',
                                                                   'name': 'George Bush',
                                                                   'phone_number': '1123-123-1234',
                                                                   'state': 'Ontario',
                                                                   'street_address1': 'Fake St',
                                                                   'zipcode': 'A0A 0A0'},
                                               'cost': '4.6',
                                               'currency_code': 'USD',
                                               'last_updated': '2015-03-09T10:23:13',
                                               'order_id': '123456789012345678901234',
                                               'order_time': '2012-12-12T06:40:12',
                                               'released_to_merchant_time': '2012-12-12T07:40:12',
                                               'order_total': '29.2',
                                               'price': '5.11',
                                               'product_id': '123456789012345678901234',
                                               'product_image_url': 'http://contestimg.wish.com/api/webimage/5253fd0b1xxxxxxxxxxx-normal.jpg',
                                               'product_name': 'Automatic Car',
                                               'quantity': '4',
                                               'shipped_date': '2011-12-12',
                                               'shipping': '3.0',
                                               'shipping_cost': '2.7',
                                               'shipping_provider': 'SwissPost',
                                               'sk': 'SKU123',
                                               'state': 'SHIPPED',
                                               'tracking_number': 'TR1ACK',
                                               'transaction_id': '123456789012345678901234',
                                               'variant_id': '123456789012345678901234'}}],
                        'label': 'Shipping Status or ETA Inquiry',
                        'last_update_date': '2015-03-09T11:02:28',
                        'merchant_id': '123456789012345678901234',
                        'open_date': '2012-03-09T04:11:00',
                        'photo_proof': 'False',
                        'replies': [{'Reply': {'date': '2015-03-09T04:57:33',
                                                 'image_urls': '[]',
                                                 'message': 'I did not yet receive this item and it is know march 8 2015 it was estimated that it would be here Jan 2 2015 and it has not arrived ',
                                                 'sender': 'user',
                                                 'translated_message': 'I did not yet receive this item and it is know march 8 2015 it was estimated that it would be here Jan 2 2015 and it has not arrived ',
                                                 'translated_message_zh': '我还不接受这个项目，这是了解2015年3月8日，据估计，这将是这里2015年1月2日，也没有到达'}},
                                     {'Reply': {'date': '2015-03-09T10:23:12',
                                                 'image_urls': '[]',
                                                 'message': "Hello,friend\n\nSorry for caused you any troubles \n\nWe got the sad news from our shipping agent that your parcel may be lost due to the long time no information online. \n\nPlease don't worry, we won't let our customer lost their money, would you like us to sent your a new parcel for your order to your address:\n\nDain Steiner\nbox 203\nTeslin, Yukon, Y0A 1B0\nCanada\n\nOr you perfer a full refund for this order? Your reply will be highly appreciated, have a nice day :)\n\nRegards\nScreamprice Service Team",
                                                 'sender': 'merchant'}},
                                     {'Reply': {'date': '2015-03-09T11:02:28',
                                                 'image_urls': '[]',
                                                 'message': 'Please send me a new parcel thank yo',
                                                 'sender': 'user',
                                                 'translated_message': 'Please send me a new parcel thank yo',
                                                 'translated_message_zh': '请给我一个新的包裹谢谢'}}],
                        'state': 'Awaiting your response',
                        'state_id': '4',
                        'subject': 'Where is my order?',
                        'sublabel': '',
                        'transaction_id': '548a8de6baa0830ffxxxxxxx'}}],
 'message': '',
 'paging': {'next': 'https://sandbox.merchant.wish.com/api/v2/ticket/get-action-required?start=2&limit=2&access_token=an_example_access_token'}}

Example

Assume your access token is "an_example_access_token" . If you would like to view your notifications in groups of 2 and you would like to see the 10th group your parameters would be:

• start = 20
• limit = 2
• access_token = an_example_access_token

Example Request

<?php
require_once 'vendor/autoload.php';

use Wish\WishClient;

$access_token = 'an_example_access_token';

$client = new WishClient($access_token,'prod');
$notifications = $client->getAllNotifications();
echo $notifications;

<?php

$access_token = urlencode('an_example_access_token');

$start = urlencode('20');
$limit = urlencode('2');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/noti/fetch-unviewed?access_token=%s&limit=%s&start=%s",
    $access_token, $limit, $start);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'GET',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{"message":"","code":0,"data":[
{"GetNotiResponse":{
    "perma_link":"http:\/\/merchant.wish.com\/release\/57180d6c49xxxxxxxxxxxxxx",
    "message":"Sizing Chart XXXXX",
    "id":"571810da7exxxxxxxxxxxxxx",
    "title":"There is a new xxxxxxxxxx"}},
{"GetNotiResponse":{
    "perma_link":"http:\/\/merchant.wish.com\/release\/57180d6c49xxxxxxxxxxxxxx",
    "message":"Sizing Chart XXXXX",
    "id":"571812abf9xxxxxxxxxxxxxx",
    "title":"There is a new xxxxxxxxxx"}}],
"paging":{"next":"https:\/\/merchant.wish.com\/api\/v2\/noti\/fetch-unviewed?start=12","previous":"https:\/\/merchant.wish.com\/api\/v2\/noti\/fetch-unviewed?start=8"}}

Example

Assume your access token is "an_example_access_token" . If you have a notification with id "123456789009876543210164" and you would like to mark is viewed.

• id = 123456789009876543210164
• access_token = an_example_access_token

Example Request

<?php
require_once 'vendor/autoload.php';

use Wish\WishClient;

$access_token = 'an_example_access_token';

$client = new WishClient($access_token,'prod');
$client->markNotificationAsViewed('98753984xxxxxxx');

<?php

$access_token = urlencode('an_example_access_token');

$noti_id = urlencode('123456789009876543210164');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/noti/mark-as-viewed?access_token=%s&id=%s",
    $access_token, $noti_id);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'GET',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    'code': 0,
    'data': {'success': True},
    'message': ''
}

Example

Assume your access token is "an_example_access_token" and if you would like to get the unviewed notification count

• access_token = an_example_access_token

Example Request

<?php
require_once 'vendor/autoload.php';

use Wish\WishClient;

$access_token = 'an_example_access_token';

$client = new WishClient($access_token,'prod');
$count = $client->getUnviewedNotiCount();

<?php

$access_token = urlencode('an_example_access_token');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/noti/mark-as-viewed?access_token=%s",
    $access_token);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'GET',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    'code': 0,
    'data': {'count': 8},
    'message': ''
}

Example

Assume your access token is "an_example_access_token" and if you would like to fetch the announcement

• access_token = an_example_access_token

Example Request

<?php
require_once 'vendor/autoload.php';

use Wish\WishClient;

$access_token = 'an_example_access_token';

$client = new WishClient($access_token,'prod');
$count = $client->getBDAnnouncemtns();

<?php

$access_token = urlencode('an_example_access_token');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/fetch-bd-announcement?access_token=%s",
    $access_token);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'GET',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    'message': '', 'code': 0, 'data': {
        'GetBDAnnResponse': {
            'title': '关于下调XXXXXXXXXXXXXXXXXXX',
            'created': 'Apr 01, 2016',
            'bd_id': '55781a50d29XXXXXXXXXX',
            'bd_name': 'TraXX XXXX',
            'message': '感谢大家XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX',
            'viewed': 'False'
        }
    }
}

Example

Assume your access token is "an_example_access_token" and if you would like to get the system updatez

• access_token = an_example_access_token

Example Request

<?php
require_once 'vendor/autoload.php';

use Wish\WishClient;

$access_token = 'an_example_access_token';

$client = new WishClient($access_token,'prod');
$count = $client->getSystemUpdatesNotifications();

<?php

$access_token = urlencode('an_example_access_token');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/fetch-sys-updates-noti?access_token=%s",
    $access_token);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'GET',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    'message': '', 'code': 0, 'data': [{
        'SystemUpdatesResponse': {
            'release_date': 'Thursday May 19, 2016',
            'id': '573e46218db5d1487ee4bdd8',
            'features': [{
                'Feature': {
                    'cn_title': '关于更新每个产品国际运费的新功能',
                    'body': 'We are very excited to announce that you can set international shipping prices per product now. No matter what sizes and weights your products are or what countries you are shipping to, you can always set shipping prices accordingly. You can start with changing overall default shipping prices on shipping settings page. Next step is to update per product shipping prices for specific countries by updating manually or a CSV file.\n\nFor a step to step guide, please visit our FAQ page for more information:',
                    'title': 'New Feature About Updating International Shipping Prices Per Product',
                    'link': 'http://merchantfaq.wish.com/hc/en-us/articles/218812008',
                    'cn_body': '尊敬的商户，我们非常荣幸的通知您，您现在可以给每个产品针对不同国家来设置不同运费了。无论您的产品是什么尺寸和重量或者要寄往哪些国家，您总可以根据不同的产品设定邮费。操作方法如下，您可以先使用配送设置页面来设置每个国家的默认运费，再去产品一览页面根据不同的国家更改每个产品的运费，可以手动修改或者上传CSV文件。 如果您想要获取更多信息和具体操作步骤，请访问常见问题:',
                    'cn_link': 'http://merchantfaq.wish.com/hc/zh-cn/articles/218812008'
                }
            }]
        }
    }, {
        'SystemUpdatesResponse': {
            'release_date': 'Monday August 03, 2015',
            'id': '55bfae216daddd41f93512ce',
            'features': [{
                'Feature': {
                    'cn_title': '商户APP(Android)最新上线',
                    'body': 'We are happy to announce a new mobile app for merchants. This app will be released initially on Android and will allow merchants to keep up to date with the latest metrics about their store. The app will also enable you to get the latest system updates and notifications right to your phone.\n\nGet the app from Google play, Xiaomi store, or direct download here: ',
                    'title': 'Announcing New Merchant Android App',
                    'link': 'http://merchant.wish.com/mobile',
                    'cn_body': '我们很高兴地宣布：Wish商户APP上线了。该APP会首先在安卓系统上线, 让广大商户在手机上便能查看店铺内的最新数据动态，了解最新的系统更新，并收到更新信息的及时通知。请从Google play，Xiaomi应用商店下载。也可直接点击以下链接下载：',
                    'cn_link': 'http://merchant.wish.com/mobile'
                }
            }]
        }
    }]
}

Example

Assume your access token is "an_example_access_token" and if you would like to get the count of the infractions that need the attention of the merchant

• access_token = an_example_access_token

Example Request

<?php
require_once 'vendor/autoload.php';

use Wish\WishClient;

$access_token = 'an_example_access_token';

$client = new WishClient($access_token,'prod');
$count = $client->getInfractionCount();

<?php

$access_token = urlencode('an_example_access_token');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/count/infractions?access_token=%s",
    $access_token);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'GET',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    'message': '', 'code': 0, 'data': {
        'CountInfractionsResponse': {
            'count': '156'
        }
    }
}

Example

Assume your access token is "an_example_access_token" and if you would like to get the infractions that need the attention of the merchant

• access_token = an_example_access_token

Example Request

<?php
require_once 'vendor/autoload.php';

use Wish\WishClient;

$access_token = 'an_example_access_token';

$client = new WishClient($access_token,'prod');
$count = $client->getInfractionLinks();

<?php

$access_token = urlencode('an_example_access_token');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/get/infractions?access_token=%s",
    $access_token);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'GET',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

    {
        "message": "",
        "code": 0,
        "data": {
            "InfractionsResponse": {
                "infractions": [
                    {
                        "Infraction": {
                            "fine_amount": "10.0",
                            "reason": "Inappropriate content detected for product listing",
                            "last_updated": "2018-06-01T23:15:57",
                            "state": "AWAITING_MERCHANT",
                            "created_time": "2018-05-12T05:07:59",
                            "link": "https://merch.corp.contextlogic.com/warning/view/5af67aaf2232612b29f6c5eb",
                            "extra_reason": "Weapon",
                            "id": "5af676af22326ssb29f6c5eb",
                            "proof": [
                                {
                                    "InfractionProof": {
                                        "message": "Inappropriate content detected for product listing",
                                        "proof_type": "PRODUCT",
                                        "object_id": "5af4317fb9c68aa5f9f25022"
                                    }
                                }
                            ]
                        }
                    }
                ]
            }
        },
        "paging": {
            "next": "https://merch.corp.contextlogic.com/api/v2/get/infractions?access_token=xxx&start=50"
        }
    }

Example

Assume your access token is "an_example_access_token" . If the ticket's id is "098765432112345678901234":

• id = 098765432112345678901234
• reply = "some message"/li>
• access_token = an_example_access_token

Example Request

<?php
require_once 'vendor/autoload.php';

use Wish\WishClient;

$access_token = 'an_example_access_token';

$client = new WishClient($access_token,'prod');
$client->replyToTicketById('098765432112345678901234',"some message");

<?php

$access_token = urlencode('an_example_access_token');

$id = urlencode('098765432112345678901234');
$reply = "some message"

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/ticket/reply?access_token=%s&reply=%s&id=%s",
    $access_token, $reply, $id);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'POST',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    'code': 0,
    'data': {'success': True},
    'message': ''
}

Example

Assume your access token is "an_example_access_token" . If you want to close the ticket with id "098765432112345678901234" because the order has been refunded.

• id = 098765432112345678901234

Example Request

<?php
require_once 'vendor/autoload.php';

use Wish\WishClient;

$access_token = 'an_example_access_token';

$client = new WishClient($access_token,'prod');
$client->closeTicketById('098765432112345678901234');

<?php

$access_token = urlencode('an_example_access_token');

$id = urlencode('098765432112345678901234');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/ticket/close?access_token=%s&id=%s",
    $access_token, $id);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'POST',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    'code': 0,
    'data': {'success': True},
    'message': ''
}

Example

Assume your access token is "an_example_access_token" . If you want wish to be aware of the ticket.

• id = 098765432112345678901234

Example Request

<?php
require_once 'vendor/autoload.php';

use Wish\WishClient;
use Wish\Model\WishReason;

$access_token = 'an_example_access_token';

$client = new WishClient($access_token,'prod');
$client->appealTicketById('098765432112345678901234');

<?php

$access_token = urlencode('an_example_access_token');

$id = urlencode('098765432112345678901234');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/ticket/appeal-to-wish-support?access_token=%s&id=%s",
    $access_token, $id);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'POST',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    'code': 0,
    'data': {'success': True},
    'message': ''
}

Example

Assume your access token is "an_example_access_token" . If you want to re-open the ticket with id "098765432112345678901234" because you have been notified delivery failed

• id = 098765432112345678901234
• reply = "some message"

Example Request

<?php
require_once 'vendor/autoload.php';

use Wish\WishClient;

$access_token = 'an_example_access_token';

$client = new WishClient($access_token,'prod');
$client->reOpenTicketById('098765432112345678901234', "some message");

<?php

$access_token = urlencode('an_example_access_token');

$id = urlencode('098765432112345678901234');
$reply = urlencode('some message');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/ticket/re-open?access_token=%s&id=%s&message=%s",
    $access_token, $id, $reply);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'POST',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    'code': 0,
    'data': {'success': True},
    'message': ''
}

Example

Assume your access token is "an_example_access_token". Say your id is "5ab4e367ae3004ebb12c28ab".

• access_token = an_example_access_token
• id = 5ab4e367ae3004ebb12c28ab

Example Request

<?php
require_once 'vendor/autoload.php';

use Wish\WishClient;

$access_token = 'an_example_access_token';

$client = new WishClient($access_token,'prod');
$id = '5ab4e367ae3004ebb12c28ab'
$client->getProductBoostCampaign($id);

<?php

$access_token = urlencode('an_example_access_token');

$id = '5ab4e367ae3004ebb12c28ab'

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/product-boost/campaign/get?access_token=%s&id=%s",
    $access_token, $id);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'POST',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
  "message": "",
  "code": 0,
  "data": {
    "Campaign": {
      "campaign_max_budget": "17.89",
      "total_enrollment_fees_charged": "0.0",
      "auto_renew": "False",
      "start_time": "2018-05-19T00:00:00",
      "total_impressions": "0",
      "impression_fees_breakdown": [
        {
          "ImpressionFee": {
            "end_time": "2018-05-21",
            "amount": "0.0",
            "fee_state": "NOT_CHARGED",
            "start_time": "2018-05-14"
          }
        }
      ],
      "campaign_id": "5ad4d3ba6cdcf03e10294812",
      "paid_impressions": "0",
      "sales": "0",
      "total_impression_fees_charged": "0.0",
      "products": [
        {
          "Product": {
            "actual_charge_rate": "3.5",
            "keywords": ["test"],
            "merchant_bid_rate": "3.5",
            "product_id": "521d93e7f2e02888c18c0d6e",
            "enrollment_fee": "0.0"
          }
        }
      ],
      "campaign_name": "my campaign",
      "end_time": "2018-05-20T00:00:00",
      "merchant_id": "577cece8ca00000e8153dffa",
      "total_campaign_spend": "0.0",
      "gmv": "0.0",
      "campaign_state": "NEW",
      "can_edit": "True",
      "is_automated_campaign": "False",
      "is_simple_boost": "True"
    }
  }
}

Example

Assume your access token is "an_example_access_token". Say you want to get all 'NEW' Simple Boost campaigns starting on or after 2018-01-01, that do not auto renew upon completion, and are not automated campaigns.

• access_token = an_example_access_token
• start_time = 2018-01-01
• campaign_state = NEW
• auto_renew = false
• campaign_type = SIMPLE_BOOST
• automated_campaign = false

Example Request

Not available

<?php

$access_token = urlencode('an_example_access_token');

$start_time = urlencode('2018-01-01')

$campaign_state = urlencode('NEW')

$auto_renew = urlencode('false')

$campaign_type = urlencode('SIMPLE_BOOST')

$automated_campaign = urlencode('false')

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/product-boost/campaign/multi-get?access_token=%s&start_time=%s&campaign_state=%s&auto_renew=%s&campaign_type=%s&automated_campaign=%s",
    $access_token, $start_time, $campaign_state, $auto_renew, $campaign_type, $automated_campaign);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'GET',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
  "message": "",
  "code": 0,
  "data": [
    {
      "Campaign": {
        "campaign_max_budget": "17.89",
        "total_enrollment_fees_charged": "0.0",
        "auto_renew": "False",
        "start_time": "2018-05-19T00:00:00",
        "total_impressions": "0",
        "impression_fees_breakdown": [
          {
            "ImpressionFee": {
              "end_time": "2018-05-21",
              "amount": "0.0",
              "fee_state": "NOT_CHARGED",
              "start_time": "2018-05-14"
            }
          }
        ],
        "campaign_id": "5ce4d3ba6cdcf03e15307766",
        "paid_impressions": "0",
        "sales": "0",
        "total_impression_fees_charged": "0.0",
        "products": [
          {
            "Product": {
              "actual_charge_rate": "3.5",
              "keywords": ["soap"],
              "merchant_bid_rate": "3.5",
              "product_id": "589d93e7f2e02872c18cce3a",
              "enrollment_fee": "0.0"
            }
          },
          ...
        ],
        "campaign_name": "my campaign",
        "end_time": "2018-05-20T00:00:00",
        "merchant_id": "556cece8ee99102e8153dffa",
        "total_campaign_spend": "0.0",
        "gmv": "0.0",
        "campaign_state": "NEW",
        "can_edit": "True",
        "is_automated_campaign": "False",
        "is_simple_boost": "True"
      }
    },
    ...
  ],
  "paging": {
    "next": "https://merch.corp.contextlogic.com/api/v2/product-boost/campaign/multi-get?access_token=ab12ab40b05c46ec9bf0e507af9517d9&start=4&limit=2",
    "previous": "https://merch.corp.contextlogic.com/api/v2/product-boost/campaign/multi-get?access_token=ab12ab40b05c46ec9bf0e507af9517d9&start=0&limit=2"
  }
}

Example

Assume your access token is "an_example_access_token".

• access_token = an_example_access_token

Example Request

Not available

<?php

$access_token = urlencode('an_example_access_token');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/product-boost/campaign/list-low-budget?access_token=%s",
    $access_token);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'GET',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
  "message": "",
  "code": 0,
  "data": [
    {
      "Campaign": {
        "campaign_max_budget": "10",
        "total_enrollment_fees_charged": "0.0",
        "auto_renew": "False",
        "start_time": "2018-05-19T00:00:00",
        "total_impressions": "0",
        "impression_fees_breakdown": [
          {
            "ImpressionFee": {
              "end_time": "2018-05-21",
              "amount": "0.0",
              "fee_state": "NOT_CHARGED",
              "start_time": "2018-05-14"
            }
          }
        ],
        "campaign_id": "5ce4d3ba6cdcf03e15307766",
        "paid_impressions": "9.99",
        "sales": "0",
        "total_impression_fees_charged": "0.0",
        "products": [
          {
            "Product": {
              "actual_charge_rate": "3.5",
              "keywords": ["soap"],
              "merchant_bid_rate": "3.5",
              "product_id": "589d93e7f2e02872c18cce3a",
              "enrollment_fee": "0.0"
            }
          },
          ...
        ],
        "campaign_name": "my campaign",
        "end_time": "2018-05-20T00:00:00",
        "merchant_id": "556cece8ee99102e8153dffa",
        "total_campaign_spend": "0.0",
        "gmv": "0.0",
        "campaign_state": "NEW",
        "can_edit": "True",
        "is_automated_campaign": "False",
        "is_simple_boost": "True"
      }
    },
    ...
  ],
  "paging": {
    "next": "https://merch.corp.contextlogic.com/api/v2/product-boost/campaign/list-low-budget?access_token=ab12ab40b05c46ec9bf0e507af9517d9&start=20&limit=20",
    "previous": "https://merch.corp.contextlogic.com/api/v2/product-boost/campaign/list-low-budget?access_token=ab12ab40b05c46ec9bf0e507af9517d9&start=0&limit=20"
  }
}

Example

Assume your access token is "an_example_access_token". Say you want to create a new campaign without auto renew starting at 2018-05-17 and ending at 2018-05-20, with name "campaign" and maximum budget $200.00. You want to promote one product with product_id "539abb829a188e0bdbe19af9".

• access_token = an_example_access_token
• max_budget = 200
• auto_renew = false
• campaign_name = campaign
• start_date = 2018-05-17
• end_date = 2018-05-20
• products = [{"product_id": "539abb829a188e0bdbe19af9" }]

Example Request

Not available

<?php

$access_token = urlencode('an_example_access_token');

$postdata = http_build_query(array(
    'max_budget'    => '200',
    'auto_renew'    => 'false',
    'campaign_name' => 'campaign',
    'start_date'    => '2018-05-17',
    'end_date'      => '2018-05-20',
    'products'      => '[{"product_id": "539abb829a188e0bdbe19af9"}]'
));
$url = sprintf(
"https://sandbox.merchant.wish.com/api/v2/product-boost/campaign/create?
    access_token=%s", $access_token);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'POST',
        'ignore_errors' => true,
        'content'       => $postdata
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    "message": "",
    "code": 0,
    "data": {
        "Campaign": {
            "campaign_max_budget": "200.0",
            "total_enrollment_fees_charged": "0.0",
            "total_campaign_spend": "0.0",
            "start_time": "2018-05-17T00:00:00",
            "auto_renew": "False",
            "total_impressions": "0",
            "sales": "0",
            "has_feedback": "False",
            "campaign_id": "5ad1a7e869c96b0c5a8ef7fc",
            "paid_impressions": "0",
            "total_impression_fees_charged": "0.0",
            "products": [
                {
                    "Product": {
                        "actual_charge_rate": "3.5",
                        "keywords": ["a", "c", "b"],
                        "merchant_bid_rate": "3.5",
                        "product_id": "544abb829a188e0dbea19af0",
                        "enrollment_fee": "0.0"
                    }
                }
            ],
            "campaign_name": "my campaign",
            "end_time": "2018-05-20T00:00:00",
            "merchant_id": "514a9a994f69ca276a9ef682",
            "impression_fees_breakdown": [
                {
                    "ImpressionFee": {
                        "end_time": "2018-05-21T00:00:00",
                        "amount": "0.0",
                        "fee_state": "NOT_CREATED",
                        "start_time": "2018-05-14T00:00:00"
                    }
                }
            ],
            "gmv": "0.0",
            "campaign_state": "NEW",
            "can_edit": "True",
            "is_automated_campaign": "False",
            "is_simple_boost": "True"
        }
    }
}

Example

Assume your access token is "an_example_access_token". Say you want to update a campaign without auto renew starting at 2018-05-17 and ending at 2018-05-20, with name "campaign" and maximum budget $200.00. You want to promote one product with product_id "539abb829a188e0bdbe19af9".

• access_token = an_example_access_token
• max_budget = 200
• auto_renew = false
• campaign_name = campaign
• start_date = 2018-05-17
• end_date = 2018-05-20
• products = [{"product_id": "539abb829a188e0bdbe19af9" }]

Example Request

Not available

<?php

$access_token = urlencode('an_example_access_token');

$postdata = http_build_query(array(
    'id'            => '5af5b85532a61f6133520a95'
    'max_budget'    => '200',
    'auto_renew'    => false,
    'campaign_name' => 'campaign',
    'start_date'    => '2018-05-17',
    'end_date'      => '2018-05-20',
    'products'      => '[{"product_id": "539abb829a188e0bdbe19af9"}]'
));
$url = sprintf(
"https://sandbox.merchant.wish.com/api/v2/product-boost/campaign/update?
    access_token=%s", $access_token);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'POST',
        'ignore_errors' => true,
        'content'       => $postdata
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    "message": "",
    "code": 0,
    "data": {
        "Campaign": {
            "campaign_max_budget": "200.0",
            "total_enrollment_fees_charged": "0.0",
            "total_campaign_spend": "0.0",
            "start_time": "2018-05-17T00:00:00",
            "auto_renew": "False",
            "total_impressions": "0",
            "sales": "0",
            "has_feedback": "False",
            "campaign_id": "5ad1a7e869c96b0c5a8ef7fc",
            "paid_impressions": "0",
            "total_impression_fees_charged": "0.0",
            "products": [
                {
                    "Product": {
                        "actual_charge_rate": "3.5",
                        "keywords": ["a", "c", "b"],
                        "merchant_bid_rate": "3.5",
                        "product_id": "544abb829a188e0dbea19af0",
                        "enrollment_fee": "0.0"
                    }
                }
            ],
            "campaign_name": "my campaign",
            "end_time": "2018-05-20T00:00:00",
            "merchant_id": "514a9a994f69ca276a9ef682",
            "impression_fees_breakdown": [
                {
                    "ImpressionFee": {
                        "end_time": "2018-05-20T00:00:00",
                        "amount": "0.0",
                        "fee_state": "NOT_CHARGED",
                        "start_time": "2018-05-17T00:00:00"
                    }
                }
            ],
            "gmv": "0.0",
            "campaign_state": "NEW",
            "can_edit": "True",
            "is_automated_campaign": "False",
            "is_simple_boost": "True"
        }
    }
}

Example

Assume your access token is "an_example_access_token". Say you want to change the end date of a running campaign to 2018-05-20, and maximum budget to $200.00.

• access_token = an_example_access_token
• max_budget = 200
• auto_renew = true
• end_date = 2018-05-20

Example Request

Not available

<?php

$access_token = urlencode('an_example_access_token');

$postdata = http_build_query(array(
    'id'            => '5af5b85532a61f6133520a95'
    'max_budget'    => '200',
    'auto_renew'    => true,
    'end_date'      => '2018-05-20'
));

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/product-boost/campaign/update-running?
    access_token=%s", $access_token);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'POST',
        'ignore_errors' => true,
        'content'       => $postdata
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    "message": "",
    "code": 0,
    "data": {
        "Campaign": {
            "campaign_max_budget": "200.0",
            "total_enrollment_fees_charged": "0.0",
            "total_campaign_spend": "0.0",
            "start_time": "2018-05-17T00:00:00",
            "auto_renew": "True",
            "total_impressions": "0",
            "sales": "0",
            "has_feedback": "False",
            "campaign_id": "5ad1a7e869c96b0c5a8ef7fc",
            "paid_impressions": "0",
            "total_impression_fees_charged": "0.0",
            "products": [
                {
                    "Product": {
                        "actual_charge_rate": "3.5",
                        "keywords": ["a", "c", "b"],
                        "merchant_bid_rate": "3.5",
                        "product_id": "544abb829a188e0dbea19af0",
                        "enrollment_fee": "0.0"
                    }
                }
            ],
            "campaign_name": "my campaign",
            "end_time": "2018-05-20T00:00:00",
            "merchant_id": "514a9a994f69ca276a9ef682",
            "impression_fees_breakdown": [
                {
                    "ImpressionFee": {
                        "end_time": "2018-05-20T00:00:00",
                        "amount": "0.0",
                        "fee_state": "NOT CHARGED",
                        "start_time": "2018-05-17T00:00:00"
                    }
                }
            ],
            "gmv": "0.0",
            "campaign_state": "STARTED",
            "can_edit": "True",
            "is_automated_campaign": "False",
            "is_simple_boost": "True"
        }
    }
}

Example

Assume your access token is "an_example_access_token". Say you want to add extra $2.00 to a campaign with id 5af5b85532a61f6133520a95.

Example Request

Not available

<?php

$access_token = urlencode('an_example_access_token');

$postdata = http_build_query(array(
    'id'      => '5af5b85532a61f6133520a95'
    'amount'  => '2.0',
));

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/product-boost/campaign/add-budget?
    access_token=%s", $access_token);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'POST',
        'ignore_errors' => true,
        'content'       => $postdata
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    "message": "",
    "code": 0,
    "data": {
        "Campaign": {
            "campaign_max_budget": "7.0",
            "total_enrollment_fees_charged": "0.0",
            "total_campaign_spend": "0.0",
            "start_time": "2018-05-17T00:00:00",
            "auto_renew": "False",
            "total_impressions": "0",
            "sales": "0",
            "has_feedback": "False",
            "campaign_id": "5ad1a7e869c96b0c5a8ef7fc",
            "paid_impressions": "0",
            "total_impression_fees_charged": "0.0",
            "products": [
                {
                    "Product": {
                        "actual_charge_rate": "3.5",
                        "keywords": ["a", "c", "b"],
                        "merchant_bid_rate": "3.5",
                        "product_id": "544abb829a188e0dbea19af0",
                        "enrollment_fee": "0.0"
                    }
                }
            ],
            "campaign_name": "my campaign",
            "end_time": "2018-05-20T00:00:00",
            "merchant_id": "514a9a994f69ca276a9ef682",
            "impression_fees_breakdown": [
                {
                    "ImpressionFee": {
                        "end_time": "2018-05-20T00:00:00",
                        "amount": "0.0",
                        "fee_state": "NOT_CHARGED",
                        "start_time": "2018-05-17T00:00:00"
                    }
                }
            ],
            "gmv": "0.0",
            "campaign_state": "NEW",
            "can_edit": "True",
            "is_automated_campaign": "False",
            "is_simple_boost": "True"
        }
    }
}

Example

Assume your access token is "an_example_access_token". Say your id is "5ab4e367ae3004ebb12c28ab".

• access_token = an_example_access_token
• id = 5ab4e367ae3004ebb12c28ab

Example Request

Not available

<?php

$access_token = urlencode('an_example_access_token');

$id = '5ab4e367ae3004ebb12c28ab'

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/product-boost/campaign/stop?access_token=%s&id=%s",
    $access_token, $id);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'POST',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    "message": "",
    "code": 0,
    "data": {}
}

Example

Assume your access token is "an_example_access_token". Say your id is "5ab4e367ae3004ebb12c28ab".

• access_token = an_example_access_token
• id = 5ab4e367ae3004ebb12c28ab

Example Request

Not available

<?php

$access_token = urlencode('an_example_access_token');

$id = '5ab4e367ae3004ebb12c28ab'

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/product-boost/campaign/cancel?access_token=%s&id=%s",
    $access_token, $id);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'POST',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    "message": "",
    "code": 0,
    "data": {}
}

Example

Assume your access token is "an_example_access_token". Say your id is "5ab4e367ae3004ebb12c28ab".

• access_token = an_example_access_token
• id = 5ab4e367ae3004ebb12c28ab

Example Request

Not available

<?php

$access_token = urlencode('an_example_access_token');

$id = urlencode('5ab4e367ae3004ebb12c28ab')

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/product-boost/campaign/
    get-performance?access_token=%s&id=%s", $access_token, $id);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'GET',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
  "message": "",
  "code": 0,
  "data": {
    "Statistics": {
      "before_campaign": [
        {
          "PerformanceData": {
            "date": "2018-03-11",
            "impressions": "0",
            "gmv": "0.0",
            "sales": "0"
          }
        },
        ...
      ],
      "campaign": [
        {
          "PerformanceData": {
            "impressions": "150950",
            "paid_impressions": "34788",
            "date": "2018-03-18",
            "gmv": "25.49",
            "sales": "1"
          }
        },
        ...
      ],
      "after_campaign": [
        {
          "PerformanceData": {
            "impressions": "114868",
            "paid_impressions": "42559",
            "date": "2018-03-25",
            "gmv": "47.6",
            "sales": "1"
          }
        },
        ...
      ]
    }
  }
}

Example

Assume your access token is "an_example_access_token". Say your id is "5ab4e367ae3004ebb12c28ab".

• access_token = an_example_access_token
• id = 5ab4e367ae3004ebb12c28ab

Example Request

Not available

<?php

$access_token = urlencode('an_example_access_token');

$id = urlencode('5ab4e367ae3004ebb12c28ab')

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/product-boost/campaign/
    get-product-stats?access_token=%s&id=%s", $access_token, $id);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'GET',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
  "message": "",
  "code": 0,
  "data": [
    {
      "ProductStat": {
        "product_id": "595d4710e6ba0d032129e4dd",
        "keywords": ["toys", "cars"],
        "product_name": "kid car toy",
        "spend": "0.0",
        "merchant_bid": "2.5",
        "sales": "0",
        "paid_impressions": "0",
        "gmv": "0.0",
        "last_updated_time": "2018-03-29T00:00:00"
      }
    },
    ...
  ]
}

Example

Assume your access token is "an_example_access_token", campaign id is "5ab4e367ae3004ebb12c28ab", and product id is "5aa21a9347d3ae59c11ac151".

• access_token = an_example_access_token
• campaign_id = 5ab4e367ae3004ebb12c28ab
• product_id = 5aa21a9347d3ae59c11ac151

Example Request

Not available

<?php

$access_token = urlencode('an_example_access_token');

$campaign_id = urlencode('5ab4e367ae3004ebb12c28ab')

$product_id = urlencode('5aa21a9347d3ae59c11ac151')

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/product-boost/campaign/
    get-product-daily-stats?access_token=%s&campaign_id=%s&product_id=%s", $access_token, $campaign_id, $product_id);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'GET',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
  "message": "",
  "code": 0,
  "data": {
    "Statistics": {
      "before_campaign": [
        {
          "ProductDailyStatistics": {
            "date": "2018-05-01",
            "sales": "5",
            "total_impressions": "31185",
            "spend": "0.0",
            "paid_impressions": "3235",
            "gmv": "67.15"
          }
        },
        ...
      ],
      "campaign": [
        {
          "ProductDailyStatistics": {
            "date": "2018-05-08",
            "sales": "7",
            "total_impressions": "25471",
            "spend": "10.3885",
            "paid_impressions": "20777",
            "gmv": "94.35"
          }
        },
        ...
      ],
      "after_campaign": [
        {
          "ProductDailyStatistics": {
            "date": "2018-05-15",
            "sales": "4",
            "total_impressions": "32284",
            "spend": "0.0",
            "paid_impressions": "23701",
            "gmv": "52.7"
          }
        },
        ...
      ]
    }
  }
}

Example

Assume your access token is "an_example_access_token". You want to promote your product with keywords "phone", "iphone", "case", "cover" and "accessories".

• access_token = an_example_access_token
• keywords = "phone,iphone,case,cover,accessories"

Example Request

Not available

<?php

$access_token = urlencode('an_example_access_token');

$keywords = urlencode('phone,iphone,case,cover,accessories')

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/product-boost/keyword/multi-get?access_token=%s&keywords=%s", $access_token, $keywords);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'GET',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    "message": "",
    "code": 0,
    "data": [
        {
            "Keyword": {
                "recommended_bid": "1.5",
                "hotness": "VERY_HIGH",
                "min_bid": "0.3",
                "keyword": "iphone",
                "max_bid": "10.0"
            }
        },
        {
            "Keyword": {
                "recommended_bid": "1.1",
                "hotness": "HIGH",
                "min_bid": "0.3",
                "keyword": "phone",
                "max_bid": "10.0"
            }
        },
        {
            "Keyword": {
                "recommended_bid": "1.0",
                "hotness": "HIGH",
                "min_bid": "0.3",
                "keyword": "case",
                "max_bid": "10.0"
            }
        },
        {
            "Keyword": {
                "recommended_bid": "0.9",
                "hotness": "MEDIUM",
                "min_bid": "0.3",
                "keyword": "cover",
                "max_bid": "10.0"
            }
        },
        {
            "Keyword": {
                "recommended_bid": "0.7",
                "hotness": "MEDIUM",
                "min_bid": "0.3",
                "keyword": "accessories",
                "max_bid": "10.0"
            }
        }
    ]
}

Example

Assume your access token is "an_example_access_token".

• access_token = an_example_access_token

Example Request

Not available

<?php

$access_token = urlencode('an_example_access_token');

$postdata = http_build_query(array(
    'keyword' => 'arry'
))

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/product-boost/keyword/search?access_token=%s", $access_token);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'POST',
        'ignore_errors' => true,
        'content'       => $postdata
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
  "message": "",
  "code": 0,
  "data": [
      {
        "Keyword": {
          "recommended_bid": "2.45",
          "min_bid": "0.3",
          "max_bid": "10.0",
          "keyword": "harry potter wand",
          "hotness": "HIGH"
        }
      },
      {
        "Keyword": {
          "recommended_bid": "0.59",
          "min_bid": "0.3",
          "max_bid": "10.0",
          "keyword": "harry potter clothes",
          "keyword": "MEDIUM"
        }
      },
    ...
  ]
}

Example

Assume your access token is "an_example_access_token". Say your campaign id is "5ab4e367ae3004ebb12c28ab".

• access_token = an_example_access_token
• campaign_id = 5ab4e367ae3004ebb12c28ab

Example Request

Not available

<?php

$access_token = urlencode('an_example_access_token');

$campaign_id = '5ab4e367ae3004ebb12c28ab'

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/product-boost/budget?access_token=%s&campaign_id=%s", $access_token, $campaign_id);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'POST',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
  "message": "",
  "code": 0,
  "data": {
    "Budget": {
      "max_budget": "7.1",
      "product_boost_bonus": "1.0",
      "product_boost_loan": "0.0",
      "product_boost_balance": "7.0",
      "product_boost_credit": "2.0",
      "merchant_account_balance": "2.1",
      "product_boost_unpaid_balance": "5.0"
    }
  }
}

Example Request

Not available

<?php

$access_token = urlencode('an_example_access_token');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/product-boost/balance/history?access_token=%s", $access_token);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'GET',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
  "message": "",
  "code": 0,
  "data": [
    {
      "AccountBalanceRecord": {
        "record_type": "DEPOSIT",
        "amount": "100.17",
        "id": "5bca0fac32dec527acfcd539",
        "time": "2018-10-19T10:09:00"
      }
    },
    {
      "AccountBalanceRecord": {
        "charge_type": "IMPRESSION_FEE",
        "record_type": "WITHDRAW",
        "amount": "13.76",
        "time": "2018-09-17T07:43:10",
        "campaign_id": "5b7e81685348a6207797ca7b",
        "id": "5a9fbd7e8a21621612dded82"
      }
    },
    {
      "AccountBalanceRecord": {
        "charge_type": "ENROLLMENT_FEE",
        "record_type": "WITHDRAW",
        "amount": "1.06",
        "time": "2018-09-17T07:43:06",
        "campaign_id": "5b7e81685348a6207797ca7b",
        "id": "5b8fbd7a25187215e8c019cd"
      }
    },
  ],
  "paging": {
    "next": "https://merch.corp.contextlogic.com/api/v2/product-boost/balance/history?access_token=d75be8edc1fb4d7083134b3022527771&start=50&is_api_explorer=true&format=json"
  }
}

Example

Assume your access token is "an_example_access_token". You want to validate bid of $0.5 on keywords "car", "car toys", and "boy toys" to help promote your product with ID "YOUR_PRODUCT_ID", with campaign whose start date is 2018-05-12 and end date 2018-05-19

• access_token = an_example_access_token
• request body = {"campaign_start_time": "2018-05-12","campaign_end_time": "2018-05-19", "bids": [{"product_id": "YOUR_PRODUCT_ID","bid": 0.5, "keywords": ["car", "car toys", "boy toys"]}]}

Example Request

Not available

<?php

$access_token = urlencode('an_example_access_token');

$postdata = http_build_query(array(
    'campaign_start_time' => '2018-05-12',
    'campaign_end_time' => '2018-05-19',
    'bids' => [{"product_id": "YOUR_PRODUCT_ID","bid": 0.5, "keywords": ["car", "car toys", "boy toys"]}]
));

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/product-boost/campaign/
    validate-bids?access_token=%s", $access_token);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'POST',
        'ignore_errors' => true,
        'content'       => $postdata
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
  "message": "",
  "code": 0,
  "data": [
    {
      "Feedback": {
        "status": "OK",
        "product_id": "59d9c05eb882e99c174946d4"
      }
    }
  ]
}

Example

Assume your access token is "an_example_access_token". Say your id is "5ab4e367ae3004ebb12c28ab".

• access_token = an_example_access_token
• id = 5ab4e367ae3004ebb12c28ab

Example Request

<?php

$access_token = urlencode('an_example_access_token');

$id = '5ab4e367ae3004ebb12c28ab'

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/fine?access_token=%s&id=%s",
    $access_token, $id);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'POST',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
  "message": "",
  "code": 0,
  "data": {
    "Fine":{
      "status":"1",
      "amount":"3.0",
      "fine_type":"1",
      "payment_deduction_amount":"3.0",
      "timestamp":"2014-09-01T00:00:00",
      "is_reversed":"False",
      "status_text":"DEDUCTED",
      "id":"5ab4e367ae3004ebb12c28ab",
      "fine_type_text":"INFRACTION"
    }
  }
}

Example

Assume your access token is "an_example_access_token". You want to create a new FBW shipping plan.

• access_token = an_example_access_token
• warehouse_code = LAX
• delivery_option_idx = 0
• num_boxes = 1
• skus=[{"sku": "test_Brown","quantity": 1,"weight_g": 10,"width_cm": 20,"length_cm": 20,"height_cm": 20,"color": "sss","size": "22","product_name": "Good job"},{"sku": "0123456789abcdefghi","quantity": 77,"weight_g": 50,"width_cm": 20,"length_cm": 20,"height_cm": 20,"color": "black","size": "XLL","product_name": "Nice"}]

Example Request

<?php

$access_token = urlencode('an_example_access_token');
$warehouse_code = urlencode('LAX');
$delivery_option_idx = urlencode('0');
$num_boxes = urlencode('1');
$skus = urlencode('[{"sku": "test_Brown","quantity": 1,"weight_g": 10,"width_cm": 20,"length_cm": 20,"height_cm": 20,"color": "sss","size": "22","product_name": "Good job"},{"sku": "0123456789abcdefghi","quantity": 77,"weight_g": 50,"width_cm": 20,"length_cm": 20,"height_cm": 20,"color": "black","size": "XLL","product_name": "Nice"}]');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/fbw/shipping-plan/create?access_token=%s&warehouse_code=%s&delivery_option_idx=%s&num_boxes=%s&skus=%s",
    $access_token, $warehouse_code, &delivery_option_idx, &num_boxes, &skus);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'POST',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    "message": "",
    "code": 0,
    "data": {
        "ShippingPlan": {
            "manifest_file_id": "123456789012345678901234",
            "last_updated": "2018-09-18T02:09:48",
            "num_boxes": "1",
            "state": "5",
            "tracking_numbers": [],
            "warehouse_code": "HZC",
            "case_label_file_id": "123456789012345678901234",
            "Address": {
                "city": "Hangzhou",
                "state": "Zhejiang",
                "zipcode": "123456",
                "street_address1": "000 Some Street",
                "country": "CN"
            },
            "fbw_shipping_id": "WISWKETD000000",
            "id": "123456789012345678901234",
            "skus": [
                {
                    "ShippingPlanSKU": {
                        "sku": "abc",
                        "datetime_delivered": "09-18-2018T14:30:42",
                        "height_cm": "20.0",
                        "label_single_file_id": "123456789012345678901234",
                        "weight_g": "10.0",
                        "quantity_delivered": "30",
                        "fbw_sku_id": "WISWKETD000000",
                        "label_file_id": "123456789012345678901234",
                        "length_cm": "20.0",
                        "width_cm": "20.0",
                        "quantity": "30"
                    }
                }
            ],
            "state_text": "Prepare Boxes"
        }
    }
}

                            

Example

Assume your access token is "an_example_access_token". You want to create FBW shipping plans.

• access_token = an_example_access_token

Example Request

<?php

$access_token = urlencode('an_example_access_token');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/fbw/inventory-distribution?access_token=%s",
    $access_token);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'POST',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    "message": "",
    "code": 0,
    "data": [
        {
            "sku": "111",
            "color": "pink",
            "product_id": "123456789012345678901234",
            "size": "1"
        },
        {
            "sku": "222",
            "color": "pink",
            "product_id": "123456789012345678901234",
            "size": "2"
        },
        {
            "sku": "333",
            "color": "pink",
            "product_id": "123456789012345678901234",
            "size": "3"
        },
    ]
}
                            

Example

Assume your access token is "an_example_access_token". You want to create FBW shipping plans.

• access_token = an_example_access_token
• warehouse_regions = ["US"]
• skus=[{"sku": "test_Brown","total_quantity": 10},{"sku": "0123456789abcdefghi","total_quantity": 77}]

Example Request

<?php

$access_token = urlencode('an_example_access_token');
$warehouse_regions = urlencode('["US"]');
$skus = urlencode('[{"sku": "test_Brown","total_quantity": 10},{"sku": "0123456789abcdefghi","total_quantity": 77}]');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/fbw/inventory-distribution?access_token=%s&warehouse_regions=%s&skus=%s",
    $access_token, $warehouse_regions, &skus);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'POST',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    "message": "",
    "code": 0,
    "data": {
        "CVG": [
            {
                "sku": "abc",
                "quantity": 10
            },
            {
                "sku": "edf",
                "quantity": 29
            }
        ],
        "LAX": [
            {
                "sku": "abc",
                "quantity": 0
            },
            {
                "sku": "edf",
                "quantity": 48
            }
        ]
    }
}
                            

Example

Assume your access token is "an_example_access_token". You want to create FBW shipping plans.

• access_token = an_example_access_token
• warehouse_regions = ["US"]
• skus=[{"sku": "test_Brown","total_quantity": 10},{"sku": "0123456789abcdefghi","total_quantity": 77}]

Example Request

<?php

$access_token = urlencode('an_example_access_token');
$warehouse_regions = urlencode('["US"]');
$skus = urlencode('[{"sku": "test_Brown","total_quantity": 10},{"sku": "0123456789abcdefghi","total_quantity": 77}]');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/fbw/shipping-plan/multi-create-and-submit?access_token=%s&warehouse_regions=%s&skus=%s",
    $access_token, $warehouse_regions, &skus);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'POST',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    "message": "",
    "code": 0,
    "data": [
        {
            "ShippingPlan": {
                "manifest_file_id": "123456789012345678901234",
                "last_updated": "2018-09-18T02:09:48",
                "num_boxes": "1",
                "state": "17",
                "tracking_numbers": [],
                "warehouse_code": "LAX",
                "case_label_file_id": "123456789012345678901234",
                "Address": {
                    "city": "City of Industry",
                    "state": "CA",
                    "zipcode": "91789",
                    "street_address1": "20275 Business Parkway",
                    "country": "US"
                },
                "fbw_shipping_id": "WISWKETD000000",
                "id": "123456789012345678901234",
                "skus": [
                    {
                        "ShippingPlanSKU": {
                            "sku": "abc",
                            "datetime_delivered": "09-18-2018T14:30:42",
                            "height_cm": "20.0",
                            "label_single_file_id": "123456789012345678901234",
                            "weight_g": "10.0",
                            "quantity_delivered": "48",
                            "fbw_sku_id": "WISWKETD000000",
                            "label_file_id": "123456789012345678901234",
                            "length_cm": "20.0",
                            "width_cm": "20.0",
                            "quantity": "48"
                        }
                    }
                ],
                "state_text": "Processing"
            }
        },
        {
            "ShippingPlan": {
                "manifest_file_id": "123456789012345678901234",
                "last_updated": "2018-09-18T02:09:48",
                "num_boxes": "1",
                "state": "17",
                "tracking_numbers": [],
                "warehouse_code": "CVG",
                "case_label_file_id": "123456789012345678901234",
                "Address": {
                    "city": "Erlanger",
                    "state": "Kentucky",
                    "zipcode": "41018",
                    "street_address1": "3300 Turfway Rd",
                    "country": "US"
                },
                "fbw_shipping_id": "WISWKETD000000",
                "id": "123456789012345678901234",
                "skus": [
                    {
                        "ShippingPlanSKU": {
                            "sku": "abc",
                            "datetime_delivered": "09-18-2018T14:30:42",
                            "height_cm": "20.0",
                            "label_single_file_id": "123456789012345678901234",
                            "weight_g": "10.0",
                            "quantity_delivered": "48",
                            "fbw_sku_id": "WISWKETD000000",
                            "label_file_id": "123456789012345678901234",
                            "length_cm": "20.0",
                            "width_cm": "20.0",
                            "quantity": "10"
                        }
                    },
                    {
                        "ShippingPlanSKU": {
                            "sku": "abc",
                            "datetime_delivered": "09-18-2018T14:30:42",
                            "height_cm": "20.0",
                            "label_single_file_id": "123456789012345678901234",
                            "weight_g": "10.0",
                            "quantity_delivered": "48",
                            "fbw_sku_id": "WISWKETD000000",
                            "label_file_id": "123456789012345678901234",
                            "length_cm": "20.0",
                            "width_cm": "20.0",
                            "quantity": "29"
                        }
                    }
                ],
                "state_text": "Processing"
            }
        }
    ]
}
                            

Example

Assume your access token is "an_example_access_token". You want to update an FBW shipping plan.

• access_token = an_example_access_token
• id = 098765432112345678901234
• warehouse_code = LAX
• delivery_option_idx = 0
• num_boxes = 1
• skus=[{"sku": "test_Brown","quantity": 1,"weight_g": 10,"width_cm": 20,"length_cm": 20,"height_cm": 20,"color": "sss","size": "22","product_name": "Good job"},{"sku": "0123456789abcdefghi","quantity": 77,"weight_g": 50,"width_cm": 20,"length_cm": 20,"height_cm": 20,"color": "black","size": "XLL","product_name": "Nice"}]

Example Request

<?php

$access_token = urlencode('an_example_access_token');
$id = urlencode('098765432112345678901234');
$warehouse_code = urlencode('LAX');
$delivery_option_idx = urlencode('0');
$num_boxes = urlencode('1');
$skus = urlencode('[{"sku": "test_Brown","quantity": 1,"weight_g": 10,"width_cm": 20,"length_cm": 20,"height_cm": 20,"color": "sss","size": "22","product_name": "Good job"},{"sku": "0123456789abcdefghi","quantity": 77,"weight_g": 50,"width_cm": 20,"length_cm": 20,"height_cm": 20,"color": "black","size": "XLL","product_name": "Nice"}]');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/fbw/shipping-plan/update?access_token=%s&id=%s&warehouse_code=%s&delivery_option_idx=%s&num_boxes=%s&skus=%s",
    $access_token, $id, $warehouse_code, &delivery_option_idx, &num_boxes, &skus);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'GET',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    'code': 0,
    'data': {},
    'message': ''
}
                            

Example

Assume your access token is "an_example_access_token". You want to submit an FBW shipping plan with id "098765432112345678901234".

• access_token = an_example_access_token
• id = 098765432112345678901234

Example Request

<?php

$access_token = urlencode('an_example_access_token');
$id = urlencode('098765432112345678901234');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/fbw/shipping-plan/submit?access_token=%s&id=%s",
    $access_token, $id);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'GET',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    'code': 0,
    'data': {},
    'message': ''
}
                            

Example

Assume your access token is "an_example_access_token". You want to deliver an FBW shipping plan with id "098765432112345678901234". There is only one tracking number. The carrier will be DHL and the package tracking number is "12345".

• access_token = an_example_access_token
• id = 098765432112345678901234
• tracking_numbers = [{"tracking_provider": "DHL", "tracking_number":"12345"}]

Example Request

<?php

$access_token = urlencode('an_example_access_token');
$id = urlencode('098765432112345678901234');
$tracking_numbers = urlencode('[{"tracking_provider": "DHL", "tracking_number":"12345"}]');


$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/fbw/shipping-plan/deliver?access_token=%s&id=%s&tracking_numbers=%s",
    $access_token, $id, &tracking_numbers);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'POST',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    "message": "",
    "code": 0,
    "data": {
        "ShippingPlan": {
            "manifest_file_id": "0987654321123456789012ab",
            "last_updated": "2018-09-26T04:01:22",
            "num_boxes": "1",
            "state": "10",
            "tracking_numbers": [
                {
                    "ShippingPlanTrackingNumber": {
                        "tracking_number": "125",
                        "tracking_provider": "DHL"
                    }
                }
            ],
            "warehouse_code": "HZC",
            "case_label_file_id": "0987654321123456789012cd",
            "Address": {
                "city": "Hangzhou",
                "state": "Zhejiang",
                "zipcode": "123456",
                "street_address1": "000 Some Street",
                "country": "CN"
            },
            "fbw_shipping_id": "WISWKETD000000",
            "id": "0987654321123456789012efg",
            "skus": [
                {
                    "ShippingPlanSKU": {
                        "sku": "test_silver",
                        "weight_g": "110.0",
                        "quantity_delivered": "0",
                        "label_file_id": "0987654321123456789012hi",
                        "fbw_sku_id": "WISWKETD000000",
                        "height_cm": "2.0",
                        "length_cm": "14.0",
                        "width_cm": "16.0",
                        "label_single_file_id": "0987654321123456789012jk",
                        "quantity": "10"
                    }
                }
            ],
            "state_text": "Delivered"
        }
    }
}
                            

Example

Assume your access token is "an_example_access_token". You want to update FBW shipping plan logistics with id "5b07e24e9e554361304da0d8". There will be two tracking numbers. For one, the carrier is USPS and the package tracking number is "345". For the other, the carrier is DHL and the package tracking number is "34455".

• access_token = an_example_access_token
• id = 098765432112345678901234
• tracking_numbers = [{"tracking_provider": "USPS", "tracking_number":"345"},{"tracking_provider": "DHL", "tracking_number":"34455"}]

Example Request

<?php

$access_token = urlencode('an_example_access_token');
$id = urlencode('098765432112345678901234');
$tracking_numbers = urlencode('[{"tracking_provider": "USPS", "tracking_number":"345"},{"tracking_provider": "DHL", "tracking_number":"34455"}]');


$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/fbw/shipping-plan/update?access_token=%s&id=%s&tracking_numbers=%s",
    $access_token, $id, &tracking_numbers);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'POST',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    "message": "",
    "code": 0,
    "data": {
        "ShippingPlan": {
            "manifest_file_id": "",
            "state": "8",
            "case_label_file_id": "",
            "last_updated": "05-25-2018T10:15:42",
            "warehouse_code": "LAX",
            "Address": {
                "city": "City of Industry",
                "state": "CA",
                "zipcode": "12345",
                "street_address1": "000 Some Street",
                "country": "US"
            },
            "tracking_numbers": [
                {
                    "ShippingPlanTrackingNumber": {
                        "tracking_number": "345",
                        "tracking_provider": "USPS"
                    }
                },
                {
                    "ShippingPlanTrackingNumber": {
                        "tracking_number": "34455",
                        "tracking_provider": "DHL"
                    }
                }
            ],
            "num_boxes": "1",
            "id": "0987654321123456789012ab",
            "skus": [
                {
                    "ShippingPlanSKU": {
                        "sku": "test_Grey",
                        "weight_g": "50.0",
                        "quantity_delivered": "0",
                        "label_file_id": "098765432112345678901234",
                        "label_single_file_id": "098765432112345678901235",
                        "height_cm": "20.0",
                        "length_cm": "20.0",
                        "width_cm": "20.0",
                        "quantity": "700"
                    }
                },
                {
                    "ShippingPlanSKU": {
                        "sku": "abc",
                        "weight_g": "50.0",
                        "quantity_delivered": "0",
                        "label_file_id": "098765432112345678901236",
                        "label_single_file_id": "098765432112345678901237",
                        "height_cm": "20.0",
                        "length_cm": "20.0",
                        "width_cm": "20.0",
                        "quantity": "77"
                    }
                }
            ],
            "state_text": "Shipped"
        }
    }
}

Example

Assume your access token is "an_example_access_token". You want to get a shipping plan with id "098765432112345678901234".

• access_token = an_example_access_token
• id = 098765432112345678901234

Example Request

<?php

$access_token = urlencode('an_example_access_token');
$id = urlencode('098765432112345678901234');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/fbw/shipping-plan?access_token=%s&id=%s",
    $access_token, $id);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'GET',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    "message": "",
    "code": 0,
    "data": {
        "ShippingPlan": {
            "manifest_file_id": "098765432112345678901239",
            "state": "5",
            "case_label_file_id": "09876543211234567890123a",
            "last_updated": "05-03-2018T08:27:04",
            "warehouse_code": "LAX",
            "manifest_file_url": "https://merchant.wish.com/file?file_id=09876543211234567890123a",
            "case_label_file_url": "https://merchant.wish.com/file?file_id=09876543211234567890123a",
            "Address": {
                "city": "Hangzhou",
                "state": "Zhejiang",
                "zipcode": "123456",
                "street_address1": "000 Some Street",
                "country": "CN"
            },
            "tracking_numbers": [],
            "num_boxes": "2",
            "id": "098765432112345678901234",
            "skus": [
                {
                    "ShippingPlanSKU": {
                        "sku": "test",
                        "weight_g": "200.0",
                        "quantity_delivered": "0",
                        "label_file_url": "https://merchant.wish.com/file?file_id=09876543211234567890123a",
                        "label_file_id": "098765432112345678901235",
                        "label_single_file_url": "https://merchant.wish.com/file?file_id=09876543211234567890123a",
                        "label_single_file_id": "098765432112345678901236",
                        "height_cm": "23.0",
                        "length_cm": "25.0",
                        "width_cm": "24.0",
                        "quantity": "20"
                    }
                }
            ],
            "state_text": "Prepare Boxes"
        }
    }
}

Example

Assume your access token is "an_example_access_token". You want to get 10 shipping plans since 2016-03-04 with offset 1.

• access_token = an_example_access_token
• limit = 10
• since = 2016-03-04
• start = 1

Example Request

<?php

$access_token = urlencode('an_example_access_token');
$limit = urlencode('10');
$since = urlencode('2016-03-04');
$start = urlencode('1');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/fbw/shipping-plan/multi-get?access_token=%s&limit=%s&since=%s&start=%s",
    $access_token, $limit, $since, $start);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'GET',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    "message": "",
    "code": 0,
    "data": [
        {
            "ShippingPlan": {
                "manifest_file_id": "098765432112345678901234",
                "state": "13",
                "case_label_file_id": "098765432112345678901234",
                "last_updated": "01-14-2018T14:54:59",
                "warehouse_code": "TLL",
                "Address": {
                    "city": "Tallinn",
                    "state": "Tallinn",
                    "zipcode": "12345",
                    "street_address1": "000 Some Street",
                    "country": "EE"
                },
                "tracking_numbers": [],
                "num_boxes": "6",
                "id": "098765432112345678901234",
                "skus": [
                    {
                        "ShippingPlanSKU": {
                            "sku": "test",
                            "weight_g": "186.0",
                            "datetime_delivered": "01-24-2018T09:30:19",
                            "label_file_id": "098765432112345678901234",
                            "height_cm": "1.0",
                            "label_single_file_id": "098765432112345678901234",
                            "quantity_delivered": "495",
                            "length_cm": "14.0",
                            "width_cm": "7.8",
                            "quantity": "495"
                        }
                    }
                ],
                "state_text": "Complete"
            }
        },
        {
            "ShippingPlan": {
                "manifest_file_id": "098765432112345678901234",
                "state": "13",
                "case_label_file_id": "098765432112345678901234",
                "last_updated": "01-14-2018T14:53:54",
                "warehouse_code": "TLL",
                "Address": {
                    "city": "Tallinn",
                    "state": "Tallinn",
                    "zipcode": "12345",
                    "street_address1": "000 Some Street",
                    "country": "EE"
                },
                "tracking_numbers": [],
                "num_boxes": "3",
                "id": "098765432112345678901234",
                "skus": [
                    {
                        "ShippingPlanSKU": {
                            "sku": "test",
                            "weight_g": "120.0",
                            "datetime_delivered": "01-19-2018T14:30:29",
                            "label_file_id": "098765432112345678901234",
                            "height_cm": "5.0",
                            "label_single_file_id": "098765432112345678901234",
                            "quantity_delivered": "50",
                            "length_cm": "12.0",
                            "width_cm": "16.0",
                            "quantity": "50"
                        }
                    },
                    {
                        "ShippingPlanSKU": {
                            "sku": "test",
                            "weight_g": "120.0",
                            "datetime_delivered": "01-19-2018T14:30:30",
                            "label_file_id": "098765432112345678901234",
                            "height_cm": "5.0",
                            "label_single_file_id": "098765432112345678901234",
                            "quantity_delivered": "50",
                            "length_cm": "12.0",
                            "width_cm": "16.0",
                            "quantity": "50"
                        }
                    },
                    {
                        "ShippingPlanSKU": {
                            "sku": "test",
                            "weight_g": "120.0",
                            "datetime_delivered": "01-19-2018T14:30:30",
                            "label_file_id": "098765432112345678901234",
                            "height_cm": "5.0",
                            "label_single_file_id": "098765432112345678901234",
                            "quantity_delivered": "50",
                            "length_cm": "12.0",
                            "width_cm": "16.0",
                            "quantity": "50"
                        }
                    }
                ],
                "state_text": "Complete"
            }
        }
    ]
}

Example

Assume your access token is "an_example_access_token". You want to cancel a shipping plan (id:098765432112345678901234) before it is delivered.

• access_token = an_example_access_token
• id = 098765432112345678901234

Example Request

<?php

$access_token = urlencode('an_example_access_token');
$id = urlencode('098765432112345678901234');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/fbw/shipping-plan/cancel?access_token=%s&id=%s",
    $access_token, $id);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'POST',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    "message": "",
    "code": 0,
    "data": []
}

Example

Assume your access token is "an_example_access_token". You want to get all available FBW warehouses.

• access_token = an_example_access_token

Example Request

<?php

$access_token = urlencode('an_example_access_token');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/fbw/warehouse/get-available?access_token=%s",
    $access_token);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'GET',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    "message": "",
    "code": 0,
    "data": [
        {
            "FBWWarehouse": {
                "phone_number": "86-20-2985-7994",
                "estimated_fulfill_time": "1",
                "warehouse_code": "TLL",
                "country_code": "EE",
                "delivery_options": [
                    {
                        "WarehouseDeliveryOption": {
                            "pickup_note": "test",
                            "pickup_contact_phone": "12-34-567-890",
                            "pickup_contact_name": "Someone",
                            "Address": {
                                "city": "Tallinn",
                                "state": "Tallinn",
                                "zipcode": "12345",
                                "street_address1": "000 Some Street",
                                "country": "EE"
                            },
                            "pickup_contact_email": "1234@abc.com",
                            "method": "PICK_UP"
                        }
                    }
                ],
                "contact_name": "SF Express",
                "warehouse_name": "FBW-EU-TLL",
                "enabled": "True",
                "region": "EU_BONDED",
                "country_ship_to": [
                    "DE",
                    "DK",
                    "EE",
                    "FR",
                    "NL",
                    "PL",
                    "NO",
                    "GB",
                    "IE",
                    "LV",
                    "IT",
                    "CH",
                    "ES",
                    "HU",
                    "BE"
                ]
            }
        },
        {
            "FBWWarehouse": {
                "phone_number": "1-909-610-2279",
                "estimated_fulfill_time": "1",
                "warehouse_code": "LAX",
                "country_code": "US",
                "delivery_options": [
                    {
                        "WarehouseDeliveryOption": {
                            "method": "SHIP_BULK",
                            "Address": {
                                "city": "City of Industry",
                                "state": "CA",
                                "zipcode": "12345",
                                "street_address1": "000 Some Street",
                                "country": "US"
                            }
                        }
                    }
                ],
                "contact_name": "FBW-US-LAX",
                "warehouse_name": "FBW-US-LAX",
                "enabled": "True",
                "region": "US",
                "country_ship_to": [
                    "US"
                ]
            }
        }
    ]
}

Example

Assume your access token is "an_example_access_token". You want to search an FEB warehouse with code LAX.

• access_token = an_example_access_token
• warehouse_code = LAX

Example Request

<?php

$access_token = urlencode('an_example_access_token');
$warehouse_code = urlencode('LAX');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/fbw/warehouse?access_token=%s&warehouse_code=%s",
    $access_token, $warehouse_code);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'GET',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    "message": "",
    "code": 0,
    "data": {
        "FBWWarehouse": {
            "phone_number": "1-909-610-2279",
            "estimated_fulfill_time": "1",
            "warehouse_code": "LAX",
            "country_code": "US",
            "delivery_options": [
                {
                    "WarehouseDeliveryOption": {
                        "method": "SHIP_BULK",
                        "Address": {
                            "city": "City of Industry",
                            "state": "CA",
                            "zipcode": "12345",
                            "street_address1": "000 Some Street",
                            "country": "US"
                        }
                    }
                }
            ],
            "contact_name": "FBW-US-LAX",
            "warehouse_name": "FBW-US-LAX",
            "enabled": "True",
            "region": "US",
            "country_ship_to" :[
                "US"
            ]
        }
    }
}

Example

Assume your access token is "an_example_access_token". You want to get FBW inventory of product with ID 098765432112345678901234.

• access_token = an_example_access_token
• id = 098765432112345678901234

Example Request

<?php

$access_token = urlencode('an_example_access_token');
$id = urlencode('098765432112345678901234');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/product/fbw-inventory?access_token=%s&id=%s",
    $access_token, $id);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'GET',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    "message": "",
    "code": 0,
    "data": {
        "FBWInventory": {
            "variants": [
                {
                    "Variant": {
                        "sku": "test_red",
                        "inventories": [
                            {
                                "SKUInventory": {
                                    "state": "active",
                                    "warehouse_code": "TLL",
                                    "inventory": "0"
                                }
                            },
                            {
                                "SKUInventory": {
                                    "state": "pending",
                                    "warehouse_code": "TLL",
                                    "inventory": "0"
                                }
                            },
                            {
                                "SKUInventory": {
                                    "state": "active",
                                    "warehouse_code": "LAX",
                                    "inventory": "52"
                                }
                            },
                            {
                                "SKUInventory": {
                                    "state": "pending",
                                    "warehouse_code": "LAX",
                                    "inventory": "0"
                                }
                            },
                            {
                                "SKUInventory": {
                                    "state": "pending",
                                    "warehouse_code": "CVG",
                                    "inventory": "15"
                                }
                            }
                        ]
                    }
                },
                {
                    "Variant": {
                        "sku": "test-black",
                        "inventories": [
                            {
                                "SKUInventory": {
                                    "state": "active",
                                    "warehouse_code": "TLL",
                                    "inventory": "7"
                                }
                            },
                            {
                                "SKUInventory": {
                                    "state": "pending",
                                    "warehouse_code": "TLL",
                                    "inventory": "0"
                                }
                            },
                            {
                                "SKUInventory": {
                                    "state": "active",
                                    "warehouse_code": "LAX",
                                    "inventory": "46"
                                }
                            },
                            {
                                "SKUInventory": {
                                    "state": "pending",
                                    "warehouse_code": "LAX",
                                    "inventory": "0"
                                }
                            },
                            {
                                "SKUInventory": {
                                    "state": "pending",
                                    "warehouse_code": "CVG",
                                    "inventory": "7"
                                }
                            }
                        ]
                    }
                },
                {
                    "Variant": {
                        "sku": "test-blue",
                        "inventories": [
                            {
                                "SKUInventory": {
                                    "state": "active",
                                    "warehouse_code": "TLL",
                                    "inventory": "0"
                                }
                            },
                            {
                                "SKUInventory": {
                                    "state": "pending",
                                    "warehouse_code": "TLL",
                                    "inventory": "0"
                                }
                            },
                            {
                                "SKUInventory": {
                                    "state": "active",
                                    "warehouse_code": "LAX",
                                    "inventory": "35"
                                }
                            },
                            {
                                "SKUInventory": {
                                    "state": "pending",
                                    "warehouse_code": "LAX",
                                    "inventory": "0"
                                }
                            },
                            {
                                "SKUInventory": {
                                    "state": "pending",
                                    "warehouse_code": "CVG",
                                    "inventory": "6"
                                }
                            }
                        ]
                    }
                }
            ],
            "removed": "True"
        }
    }
}

Example

Assume your access token is "an_example_access_token". You want to get FBW inventory of 2 products with offset 2.

• access_token = an_example_access_token
• start = 2
• limit = 2

Example Request

<?php

$access_token = urlencode('an_example_access_token');
$limit = urlencode('2');
$start = urlencode('2');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/product/fbw-inventory/multi-get?access_token=%s&limit=%s&start=%s",
    $access_token, $limit, $start);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'GET',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    "message": "",
    "code": 0,
    "data": [
        {
            "FBWInventory": {
                "variants": [
                    {
                        "Variant": {
                            "sku": "123456789012345678901234-black",
                            "inventories": []
                        }
                    },
                    {
                        "Variant": {
                            "sku": "123456789012345678901234-blue",
                            "inventories": []
                        }
                    },
                    {
                        "Variant": {
                            "sku": "123456789012345678901234-bronze",
                            "inventories": []
                        }
                    },
                    {
                        "Variant": {
                            "sku": "123456789012345678901234-gold",
                            "inventories": [
                                {
                                    "SKUInventory": {
                                        "state": "active",
                                        "warehouse_code": "HZC",
                                        "inventory": "0"
                                    }
                                },
                                {
                                    "SKUInventory": {
                                        "state": "pending",
                                        "warehouse_code": "HZC",
                                        "inventory": "0"
                                    }
                                }
                            ]
                        }
                    },
                    {
                        "Variant": {
                            "sku": "123456789012345678901234-pink",
                            "inventories": []
                        }
                    },
                    {
                        "Variant": {
                            "sku": "123456789012345678901234-purple",
                            "inventories": []
                        }
                    },
                    {
                        "Variant": {
                            "sku": "123456789012345678901234-rose gold",
                            "inventories": []
                        }
                    },
                    {
                        "Variant": {
                            "sku": "123456789012345678901234-silver",
                            "inventories": [
                                {
                                    "SKUInventory": {
                                        "state": "active",
                                        "warehouse_code": "HZC",
                                        "inventory": "0"
                                    }
                                },
                                {
                                    "SKUInventory": {
                                        "state": "pending",
                                        "warehouse_code": "HZC",
                                        "inventory": "0"
                                    }
                                }
                            ]
                        }
                    }
                ],
                "removed": "False"
            }
        },
        {
            "FBWInventory": {
                "variants": [
                    {
                        "Variant": {
                            "sku": "123456789012345678901234-S-Black",
                            "inventories": [
                                {
                                    "SKUInventory": {
                                        "state": "active",
                                        "warehouse_code": "LAX",
                                        "inventory": "9"
                                    }
                                },
                                {
                                    "SKUInventory": {
                                        "state": "pending",
                                        "warehouse_code": "LAX",
                                        "inventory": "0"
                                    }
                                }
                            ]
                        }
                    },
                    {
                        "Variant": {
                            "sku": "123456789012345678901234-S-army green",
                            "inventories": [
                                {
                                    "SKUInventory": {
                                        "state": "active",
                                        "warehouse_code": "LAX",
                                        "inventory": "8"
                                    }
                                },
                                {
                                    "SKUInventory": {
                                        "state": "pending",
                                        "warehouse_code": "LAX",
                                        "inventory": "0"
                                    }
                                }
                            ]
                        }
                    },
                    {
                        "Variant": {
                            "sku": "123456789012345678901234-M-Black",
                            "inventories": [
                                {
                                    "SKUInventory": {
                                        "state": "active",
                                        "warehouse_code": "LAX",
                                        "inventory": "8"
                                    }
                                },
                                {
                                    "SKUInventory": {
                                        "state": "pending",
                                        "warehouse_code": "LAX",
                                        "inventory": "0"
                                    }
                                }
                            ]
                        }
                    },
                    {
                        "Variant": {
                            "sku": "123456789012345678901234-M-army green",
                            "inventories": [
                                {
                                    "SKUInventory": {
                                        "state": "active",
                                        "warehouse_code": "LAX",
                                        "inventory": "6"
                                    }
                                },
                                {
                                    "SKUInventory": {
                                        "state": "pending",
                                        "warehouse_code": "LAX",
                                        "inventory": "0"
                                    }
                                }
                            ]
                        }
                    },
                    {
                        "Variant": {
                            "sku": "123456789012345678901234-L-army green",
                            "inventories": [
                                {
                                    "SKUInventory": {
                                        "state": "active",
                                        "warehouse_code": "LAX",
                                        "inventory": "9"
                                    }
                                },
                                {
                                    "SKUInventory": {
                                        "state": "pending",
                                        "warehouse_code": "LAX",
                                        "inventory": "0"
                                    }
                                }
                            ]
                        }
                    },
                    {
                        "Variant": {
                            "sku": "123456789012345678901234-XL-Black",
                            "inventories": [
                                {
                                    "SKUInventory": {
                                        "state": "active",
                                        "warehouse_code": "LAX",
                                        "inventory": "9"
                                    }
                                },
                                {
                                    "SKUInventory": {
                                        "state": "pending",
                                        "warehouse_code": "LAX",
                                        "inventory": "0"
                                    }
                                }
                            ]
                        }
                    },
                    {
                        "Variant": {
                            "sku": "123456789012345678901234-XL-army green",
                            "inventories": [
                                {
                                    "SKUInventory": {
                                        "state": "active",
                                        "warehouse_code": "LAX",
                                        "inventory": "10"
                                    }
                                },
                                {
                                    "SKUInventory": {
                                        "state": "pending",
                                        "warehouse_code": "LAX",
                                        "inventory": "0"
                                    }
                                }
                            ]
                        }
                    },
                    {
                        "Variant": {
                            "sku": "123456789012345678901234-XXL-Black",
                            "inventories": []
                        }
                    },
                    {
                        "Variant": {
                            "sku": "123456789012345678901234-XXL-army green",
                            "inventories": [
                                {
                                    "SKUInventory": {
                                        "state": "active",
                                        "warehouse_code": "LAX",
                                        "inventory": "10"
                                    }
                                },
                                {
                                    "SKUInventory": {
                                        "state": "pending",
                                        "warehouse_code": "LAX",
                                        "inventory": "0"
                                    }
                                }
                            ]
                        }
                    }
                ],
                "removed": "False"
            }
        }
    ]
}

Example

Assume your access token is "an_example_access_token". You want to get shipping price of product 098765432112345678901234, sku "test" in warehouse "TLL".

• access_token = an_example_access_token
• product_id = 098765432112345678901234
• sku = test
• warehouse_code = TLL

Example Request

<?php

$access_token = urlencode('an_example_access_token');
$product_id = urlencode('098765432112345678901234');
$sku = urlencode('test');
$warehouse_code = urlencode('TLL');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/fbw/shipping-price?access_token=%s&product_id=%s&sku=%s&warehouse_code=%s",
    $access_token, $product_id, $sku, $warehouse_code);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'POST',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    "message": "",
    "code": 0,
    "data": [
        {
            "FBWShippingPrice": {
                "source": "4",
                "price": "5.0",
                "localized_price": "30.0",
                "localized_currency_code": "CNY",
                "country_code": "PL"
            }
        },
        {
            "FBWShippingPrice": {
                "source": "3",
                "price": "15.0",
                "localized_price": "90.0",
                "localized_currency_code": "CNY",
                "country_code": "FR"
            }
        },
        {
            "FBWShippingPrice": {
                "source": "4",
                "price": "5.0",
                "localized_price": "30.0",
                "localized_currency_code": "CNY",
                "country_code": "DE"
            }
        },
        {
            "FBWShippingPrice": {
                "source": "4",
                "price": "5.0",
                "localized_price": "30.0",
                "localized_currency_code": "CNY",
                "country_code": "DK"
            }
        },
        {
            "FBWShippingPrice": {
                "source": "4",
                "price": "5.0",
                "localized_price": "30.0",
                "localized_currency_code": "CNY",
                "country_code": "LV"
            }
        },
        {
            "FBWShippingPrice": {
                "source": "3",
                "price": "5.0",
                "localized_price": "30.0",
                "localized_currency_code": "CNY",
                "country_code": "D"
            }
        },
        {
            "FBWShippingPrice": {
                "source": "4",
                "price": "5.0",
                "localized_price": "30.0",
                "localized_currency_code": "CNY",
                "country_code": "NO"
            }
        },
        {
            "FBWShippingPrice": {
                "source": "4",
                "price": "5.0",
                "localized_price": "30.0",
                "localized_currency_code": "CNY",
                "country_code": "EE"
            }
        },
        {
            "FBWShippingPrice": {
                "source": "4",
                "price": "5.0",
                "localized_price": "30.0",
                "localized_currency_code": "CNY",
                "country_code": "IE"
            }
        },
        {
            "FBWShippingPrice": {
                "source": "4",
                "price": "5.0",
                "localized_price": "30.0",
                "localized_currency_code": "CNY",
                "country_code": "GB"
            }
        },
        {
            "FBWShippingPrice": {
                "source": "4",
                "price": "5.0",
                "localized_price": "30.0",
                "localized_currency_code": "CNY",
                "country_code": "NL"
            }
        }
    ]
}

Example

Assume your access token is "an_example_access_token". You want to set shipping price of product 5aa75256b9135c63742fd294, sku 56691e6b3a698c2b36be8c4c-rose red in warehouse "TLL". You want to set the default price 11 and remove price in France.

• access_token = an_example_access_token
• product_id = 098765432112345678901234
• sku = test
• warehouse_code = TLL
• updates = {"d":"11","fr":"","us":"1","local_us":"6"}
• localized_currency_code = CNY

Example Request

<?php

$access_token = urlencode('an_example_access_token');
$product_id = urlencode('098765432112345678901234');
$sku = urlencode('test');
$warehouse_code = urlencode('TLL');
$updates = urlencode('{"d":"11","fr":"","us":"1","local_us":"6"}');
$localized_currency_code = urlencode('CNY');
$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/fbw/shipping-price/update?access_token=%s&product_id=%s&sku=%s&warehouse_code=%s&updates=%s&localized_currency_code=%s",
    $access_token, $product_id, $sku, $warehouse_code, $updates, $localized_currency_code);
$context = stream_context_create(array(
    'http' => array(
        'method'        => 'POST',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    'code': 0,
    'data': {},
    'message': ''
}
                            

Example

Assume your access token is "an_example_access_token". You want to get 2 pieces (no offset) of Transaction inventory history of sku WT2018030526-Big Vertical Version-Black in warehouse HZC.

• access_token = an_example_access_token
• history_type = Transaction
• sku = test
• warehouse_code = HZC
• limit = 2
• start = 0

Example Request

<?php

$access_token = urlencode('an_example_access_token');
$history_type = urlencode('Transaction');
$sku = urlencode('test');
$warehouse_code = urlencode('HZC');
$limit = urlencode('2');
$start = urlencode('0');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/product/fbw-sku-history?access_token=%s&warehouse_code=%s&limit=%s&start=%s&sku=%s&history_type=%s",
    $access_token, $warehouse_code, $limit, $start, $sku, $history_type);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'GET',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    "message": "",
    "code": 0,
    "data": {
        "FBWSKUHistoryData": {
            "total_history_count": "2",
            "fbw_sku_history_list": [
                {
                    "FBWSKUHistory": {
                        "SKUHistorySource": {
                            "state": "SHIPPED",
                            "type": "order",
                            "id": "098765432112345678901234"
                        },
                        "time": "2018-04-26T14:53:20",
                        "quantity": "-1"
                    }
                },
                {
                    "FBWSKUHistory": {
                        "SKUHistorySource": {
                            "state": "SHIPPED",
                            "type": "order",
                            "id": "098765432112345678901234"
                        },
                        "quantity": "-1"
                    }
                }
            ]
        }
    }
}

Example

Assume your access token is "an_example_access_token". You want to get 2 pieces (no offset) of FBW fee generated by order in warehouse LAX.

• access_token = an_example_access_token
• fee_type = 2
• warehouse_code = LAX
• limit = 2

Example Request

<?php

$access_token = urlencode('an_example_access_token');
$fee_type = urlencode('2');
$warehouse_code = urlencode('LAX');
$limit = urlencode('2');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/fbw/fee?access_token=%s&warehouse_code=%s&limit=%s&fee_type=%s",
    $access_token, $warehouse_code, $limit, $fee_type);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'GET',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    "message": "",
    "code": 0,
    "data": [
        {
            "FBWFee": {
                "currency": "USD",
                "amount": "0.38",
                "invoice_url": "https://merchant.wish.com/fbw/invoice/view/098765432112345678901234",
                "created_time": "2018-01-14",
                "shipping_plan_id": "None",
                "order_id": "098765432112345678901234",
                "fee_name": "order fee"
            }
        },
        {
            "FBWFee": {
                "currency": "USD",
                "amount": "2.81",
                "invoice_url": "https://merchant.wish.com/fbw/invoice/view/098765432112345678901234",
                "created_time": "2018-01-14",
                "shipping_plan_id": "None",
                "order_id": "098765432112345678901234",
                "fee_name": "shipping fee"
            }
        }
    ]
}

Example

Assume your access token is "an_example_access_token". You want to return 2 items of variants from warehouse LAX.

• access_token = an_example_access_token
• sku = abc
• warehouse_code = LAX
• inventory = 2
• firstname = abc
• lastname = abc
• street = abc
• city = abc
• state = abc
• country_code = cn
• zipcode = 12345

Example Request

<?php

$access_token = urlencode('an_example_access_token');
$sku = urlencode('abc');
$warehouse_code = urlencode('LAX');
$inventory = urlencode('2');
$firstname = urlencode('abc');
$lastname = urlencode('abc');
$street = urlencode('abc');
$city = urlencode('abc');
$state = urlencode('abc');
$country_code = urlencode('cn');
$zipcode = urlencode('12345');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/fbw/inventory/return?access_token=%s&sku=%s&warehouse_code=%s&inventory=%s&firstname=%s&lastname=%s&street=%s&city=%s&state=%s&country_code=%s&zipcode=%s",
    $access_token, $sku, $warehouse_code, $inventory, $firstname, $lastname, $street, $city, $state, $country_code, $zipcode);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'POST',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    "message": "",
    "code": 0,
    "data": {
        "request_id": "1234567890123456789012"
    }
}

Example

Assume your access token is "an_example_access_token". You want to get status of a return inventory request.

• access_token = an_example_access_token
• id = 1234567890123456789012

Example Request

<?php

$access_token = urlencode('an_example_access_token');
$id = urlencode('1234567890123456789012');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/fbw/inventory/return?access_token=%s&id=%s",
    $access_token, $id);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'GET',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    "message": "",
    "code": 0,
    "data": {
        "request_id": "1234567890123456789012"
        "status": "PENDING"
    }
}

Example

Assume your access token is "an_example_access_token". If you had an image with base64 encoding "ABCD1234abcd", your parameters would be:

• image = ABCD1234abcd
• access_token = an_example_access_token

Example Request

<?php

$access_token = urlencode('an_example_access_token');
$image = urlencode('ABCD1234abcd');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/image?access_token=%s&image=%s",
    $access_token, $image);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'POST',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    "message":"",
    "code":0,
    "data":{"url" : http://merchant.wish.com/static/tmp-uploads/12345678901234567890123456789012.jpg?v=e3456}
}

Example

Assume your access token is "an_example_access_token":

• access_token = an_example_access_token

Example Request

<?php

$access_token = urlencode('an_example_access_token');

$url = sprintf(
    "https://sandbox.merchant.wish.com/api/v2/get-shipping-carriers?access_token=%s",
    $access_token, $image);

$context = stream_context_create(array(
    'http' => array(
        'method'        => 'POST',
        'ignore_errors' => true,
    ),
));

// Send the request
$response = file_get_contents($url, TRUE, $context);
echo $response;
echo "\n";
?>

Example Response

{
    "message":"",
    "code":0,
    "data":{
        "shipping_carriers":["4PX",
                            "AirpakExpress",
                            "AnjunExpress",
                            "Aramex",
                            "AsendiaGermany",
                            "AsendiaUK",
                            "AsendiaUSA",
                            "AuPostChina",
                            "AustraliaPost",
                            "AustrianPost",
                            "AustrianPostRegistered",
                            "BPost",
                            "BPostInternational",
                            "Belpost",
                            "CNEExpress",
                            "CanadaPost",
                            "ChinaAirPost",
                            "Chukou1",
                            "ColisPrive",
                            "Colissimo",
                            "CorreosDeEspana",
                            "CorreosExpress",
                            "CroatianPost",
                            "DHL",
                            "DHL2MannHandling",
                            "DHLBenelux",
                            "DHLExpress",
                            "DHLGermany",
                            "DHLGlobalMail",
                            "DHLGlobalMailAsia",
                            "DHLNetherlands",
                            "DHLParcelNL",
                            "DHLPoland",
                            "DHLSpainDomestic",
                            "DPD",
                            "DPDFrance",
                            "DPDGermany",
                            "DPDIreland",
                            "DPDPoland",
                            "DPDUK",
                            "DPEXChina",
                            "DanmarkPost",
                            "DeutschePost",
                            "DirectLink",
                            "ECFirstClass",
                            "EMPSExpress",
                            "EMS",
                            "EPacket",
                            "Envialia",
                            "EquickChina",
                            "FedEx",
                            "FedExApex",
                            "FedExUK",
                            "FlytExpress",
                            "GLS",
                            "GLSItaly",
                            "GLSNetherlands",
                            "GlobegisticsInc",
                            "Hermes",
                            "HermesGermany",
                            "HongKongPost",
                            "IndiaPost",
                            "IndiaPostInternational",
                            "IndonesiaPost",
                            "IsraelPost",
                            "ItalySDA",
                            "JapanPost",
                            "KoreaPost",
                            "LandmarkGlobal",
                            "LaoPost",
                            "LaPosteColissimo",
                            "LithuaniaPost",
                            "MagyarPosta",
                            "MalaysiaPost",
                            "MalaysiaPostPosDaftar",
                            "NewZealandPost",
                            "Nexive",
                            "OnTrac",
                            "OneWorldExpress",
                            "ParcelForce",
                            "PTTPosta",
                            "PocztaPolska",
                            "PosteItaliane",
                            "PostNL",
                            "PostNLInternational",
                            "PostNLInternational3S",
                            "RoyalMail",
                            "RussianPost",
                            "SFCService",
                            "SFExpress",
                            "SFInternational",
                            "SimplyPost",
                            "SingaporePost",
                            "SingaporeSpeedpost",
                            "Sinotrans",
                            "SwedenPosten",
                            "SwissPost",
                            "TNT",
                            "TNTAustralia",
                            "TNTClickItaly",
                            "TNTFrance",
                            "TNTItaly",
                            "TNTPostItaly",
                            "TNTUK",
                            "TaiwanPost",
                            "ThailandThaiPost",
                            "TollIPEC",
                            "TollPriority",
                            "TrakPak",
                            "TransMission",
                            "TurkishPost",
                            "UBISmartParcel",
                            "UKMail",
                            "UPS",
                            "UPSFreight",
                            "UPSMailInnovations",
                            "USPS",
                            "VietnamPost",
                            "VietnamPostEMS",
                            "Wanb",
                            "WeDoLogisitics",
                            "WishPost",
                            "YODEL",
                            "Yanwen",
                            "YodelInternational",
                            "YunExpress"
                            ]
    }
}