Retrieving Site Account Information

When to Use

  • Locate profile name, associated client/company name, currency information, and time zone information about one or profiles authorized under the access token used.
    AND
  • Display unique seller account information on a site/marketplace basis.

Considerations

  • Where is the Username/Account Unique Identifier?

    • Located in the SiteAccountName property, inside the parenthesis.

  • What do these values correspond to (these are common marketplaces)?

    • Amazon = the unique Channel Identifier

    • eBay = Seller Username

    • Jet = API Merchant ID

    • NewEgg = Seller ID

    • Walmart = Consumer ID

    • Rakuten US = FTP Username or Seller Tools Username

  • If these values aren't known, they can be found either at the site's seller portal settings, or within the ChannelAdvisor platform in each individual Marketplace's settings page.

Resource URL / Endpoint

GET https://api.channeladvisor.com/v1/Profiles?$expand=SiteAccounts

Important and/or Required Parameters

PropertyNameRequiredNote
ProfileIDProfile IDConditionallyIdentifies the ChannelAdvisor profile - required to access a single profile's information.
Omit to see all profiles under authorization.
$expand=SiteAccountsSite AccountsRequiredInclude in URL. Displays SiteAccounts collection data under a Profile.
Example Request
GET https://api.channeladvisor.com/v1/Profiles?&access_token=xxxxxxxxxx&$expand=SiteAccounts
Example Response (Success)
200 OK
{
    "@odata.context": "https://api.channeladvisor.com/v1/$metadata#Profiles",
    "value": [
        {
            "ID": 23568974,
            "AccountName": "Acme Trading - Trade Me - NZ",
            "CompanyName": "Acme Company, Inc.",
            "CurrencyCode": "NZD",
            "TimeZoneRegion": "Eastern",
            "TimeZoneDescription": "Eastern time (US & Canada)",
            "DefaultDistributionCenterID": 0,
            "SiteAccounts": [
                {
                    "ID": 925,
                    "SiteAccountName": "TradeMe 1 (12345678AB9CD01234E5F678G9102345)",
                    "SiteID": 828,
                    "SiteName": "TradeMe",
                    "Enabled": true
                }
            ]
        },
        {
            "ID": 98765432,
            "AccountName": "Acme Company, Inc. - US",
            "CompanyName": "Acme Company, Inc.",
            "CurrencyCode": "USD",
            "TimeZoneRegion": "Eastern",
            "TimeZoneDescription": "Eastern time (US & Canada)",
            "DefaultDistributionCenterID": 0,
            "SiteAccounts": [
                {
                    "ID": 5432,
                    "SiteAccountName": "Rakuten.com Shopping 1 (username@examplecompany.com)",
                    "SiteID": 656,
                    "SiteName": "Rakuten.com Shopping",
                    "Enabled": true
                },
                {
                    "ID": 5433,
                    "SiteAccountName": "Newegg 1 (A8X123m3)",
                    "SiteID": 665,
                    "SiteName": "Newegg",
                    "Enabled": true
                },
                {
                    "ID": 5598,
                    "SiteAccountName": "Amazon Seller Central - US 1 (ABC0DE1FGHI2J)",
                    "SiteID": 640,
                    "SiteName": "Amazon Seller Central - US",
                    "Enabled": true
                }
                {
                    "ID": 8631,
                    "SiteAccountName": "eBay US Fixed Price 1 (acmeco_fixed_1)",
                    "SiteID": 576,
                    "SiteName": "eBay US Fixed Price",
                    "Enabled": true
                },
                {
                    "ID": 8632,
                    "SiteAccountName": "eBay US Fixed Price 2 (acmeco_fixed_2)",
                    "SiteID": 576,
                    "SiteName": "eBay US Fixed Price",
                    "Enabled": true
                }
                {
                    "ID": 12345,
                    "SiteAccountName": "Walmart Marketplace 1 (123a4b56-78c9-01de-234f-5ghi6789j9kl)",
                    "SiteID": 996,
                    "SiteName": "Walmart Marketplace",
                    "Enabled": true
                }
            ]
        }
    ]
}