Retrieving Shipping Label Partner 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 shipping label partner basis.

Resource URL / Endpoint

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

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=ShippingLabelPartnerAccountsShipping Label Partner AccountsRequiredInclude in URL. Displays ShippingLabelPartnerAccounts collection data under a Profile.
Example Request
GET https://api.channeladvisor.com/v1/Profiles?&access_token=xxxxxxxxxx&$expand=ShippingLabelPartnerAccounts
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,
            "ShippingLabelPartnerAccounts": [
                {
                    "ID": 123,
                    "AccountName": "Acme Pitney Bowes Account 1",
                    "PartnerName": "Pitney Bowes",
                }
            ]
        },
        {
            "ID": 98765432,
            "AccountName": "Acme Company, Inc. - US",
            "CompanyName": "Acme Company, Inc.",
            "CurrencyCode": "USD",
            "TimeZoneRegion": "Eastern",
            "TimeZoneDescription": "Eastern time (US & Canada)",
            "DefaultDistributionCenterID": 0,
            "ShippingLabelPartnerAccounts": [
            ]
        }
    ]
}