Skip to content

Latest commit

 

History

History
57 lines (39 loc) · 4.96 KB

RateTableApi.md

File metadata and controls

57 lines (39 loc) · 4.96 KB
Raw

SapientPro\EbayAccountSDK\Api\RateTableApi

All URIs are relative to https://api.ebay.com/sell/account/v1

Method HTTP request Description
getRateTables GET /rate_table

getRateTables

getRateTables(CountryCodeEnum $countryCode): RateTableResponse

This method retrieves a seller's shipping rate tables for the country specified in the country_code query parameter. If you call this method without specifying a country code, the call returns all of the seller's shipping rate tables.

The method's response includes a rateTableId for each table defined by the seller. This rateTableId value is used in add/revise item call or in create/update fulfillment business policy call to specify the shipping rate table to use for that policy's domestic or international shipping options.

This call currently supports getting rate tables related to the following marketplaces:

  • EBAY_AU
  • EBAY_CA
  • EBAY_DE
  • EBAY_ES
  • EBAY_FR
  • EBAY_GB
  • EBAY_IT
  • EBAY_US
<span class="tablenote">Note: Rate tables created with the Trading API might not have been assigned a rateTableId at the time of their creation. This method can assign and return rateTableId values for rate tables with missing IDs if you make a request using the country_code where the seller has defined rate tables.

Sellers can define up to 40 shipping rate tables for their account, which lets them set up different rate tables for each of the marketplaces they sell into. Go to <a href="https://www.ebay.com/ship/rt\">Shipping rate tables in My eBay to create and update rate tables.

Example

<?php
use SapientPro\EbayAccountSDK\Configuration;
use SapientPro\EbayAccountSDK\Api\RateTableApi;
use SapientPro\EbayAccountSDK\Enums\CountryCodeEnum;

// Configure OAuth2 access token for authorization: api_auth
$config = Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new EBay\Account\Api\RateTableApi(
    config: $config
);

try {
    $result = $apiInstance->getRateTables(CountryCodeEnum::BG);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RateTableApi->getRateTables: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
countryCode \SapientPro\EbayAccountSDK\Enums\CountryCodeEnum This query parameter specifies the two-letter <a href=&quot;https://www.iso.org/iso-3166-country-codes.html\" title=&quot;https://www.iso.org\" target=&quot;_blank&quot;>ISO 3166</a> code of country for which you want shipping rate table information. If you do not specify a country code, the request returns all of the seller's defined shipping rate tables for all eBay marketplaces. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/account/types/ba:CountryCodeEnum [optional]

Return type

\SapientPro\EbayAccountSDK\Models\RateTableResponse

Authorization

api_auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]