GET
/
1.0
/
channel
curl --request GET \
  --url https://api.shipbob.com/1.0/channel \
  --header 'Authorization: Bearer <token>'
[
  {
    "application_name": "Api",
    "id": 0,
    "name": "string",
    "scopes": [
      "channels_read",
      "orders_read",
      "orders_write"
    ]
  }
]

Use the Channel Resource to list channels which you have access to.

You will use this channelId for subsequent API calls made to ShipBob endpoints.

A channel is a specific installation of an application built by a vendor on top of our API e.g. Kevins Shopify Store #133432.

All write and most read endpoints require a channel to be passed in the header to complete the request.

The channel is used to Identify where the data originally came from.

Applications that are granted multi-channel permissions will be able to read data from all channels that belong to a user.

However, multi-channel applications will only be able to write on behalf of their own channel.

Authorizations

​
Authorization
string
header
required

Authentication using Personal Access Token (PAT) token

Response

200
application/json

Success

​
application_name
string | null

Name of the application that owns the channel

Example:

"Api"

​
id
integer

Unique id of the channel

​
name
string | null

Name of the channel

​
scopes
string[] | null

Array of permissions granted for the channel

Example:
[
  "channels_read",
  "orders_read",
  "orders_write"
]