GoDaddy
Support
API ReferenceCommerceStores & channelsChannels APIGet channel by ID GET

Get channel by ID

View as Markdown

Returns a single channel by ID.

Full description

Returns a single channel by ID. Access requires a service principal in GLOBAL or channel-scoped customer permissions. Authorization is checked before existence; an unknown channelId might return 401 instead of 404.

GET
/channels/{channelId}

Authorization

PAT commerce.channel:read
AuthorizationBearer <token>

Personal Access Token (PAT). Include as Authorization: Bearer $GODADDY_PAT. Required scopes: commerce.channel:read.

In: header

Scope: commerce.channel:read

Path Parameters

channelId*Id

unique identifier

Match^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/channels/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "channelId": "5f6d08bc-455a-4532-98b8-19e2cee51160",  "name": "string",  "type": "RETAIL",  "channelProviderId": "2a6fb5ff-c953-442e-aa39-8649347a8f25",  "externalChannelId": "string",  "subType": "string",  "status": "PENDING_SETUP",  "registeredStores": [    {      "storeId": "b8adcdc8-9238-4168-90f8-77b2d14c211c",      "status": "ENABLED",      "default": false,      "links": [        {          "href": "http://example.com",          "rel": "string",          "title": "string",          "targetMediaType": "string",          "targetSchema": null,          "method": "string",          "submissionMediaType": "application/json",          "submissionSchema": null        }      ],      "createdAt": "stringstringstringst",      "updatedAt": "stringstringstringst"    }  ],  "location": {    "alias": "string",    "address": {      "addressLine1": "string",      "addressLine2": "string",      "addressLine3": "string",      "adminArea4": "string",      "adminArea3": "string",      "adminArea2": "string",      "adminArea1": "string",      "postalCode": "string",      "countryCode": "st",      "addressDetails": {        "streetNumber": "string",        "streetName": "string",        "streetType": "string",        "deliveryService": "string",        "buildingName": "string",        "subBuilding": "string",        "addressType": "s",        "geoCoordinates": {          "longitude": "string",          "latitude": "string"        }      }    },    "contacts": [      {        "type": "FAX",        "phone": {          "countryCode": "str",          "nationalNumber": "string",          "extensionNumber": "string"        }      }    ]  },  "links": [    {      "href": "http://example.com",      "rel": "string",      "title": "string",      "targetMediaType": "string",      "targetSchema": null,      "method": "string",      "submissionMediaType": "application/json",      "submissionSchema": null    }  ],  "createdAt": "stringstringstringst",  "updatedAt": "stringstringstringst"}

Last updated on

How is this guide?