PrepBusiness LogoAPI Documentation

Channels

GET/channels

List channels

Request

GET/channels
curl -G https://YOUR_DOMAIN/api/channels \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json"
Loading response...
POST/channels/amazon/connection-invitation

Create an Amazon channel connection invitation

Required attributes

  • Name
    marketplace
    Type
    string
    Description
    The Amazon marketplace identifier to connect ATVPDKIKX0DER
  • Name
    redirect_url
    Type
    string
    Description
    The URL to redirect the merchant to after they successfully connect their Amazon channel https://app.example.com/channels/connected

Optional attributes

  • Name
    nickname
    Type
    string
    Description
    An optional nickname for the channel

Request

POST/channels/amazon/connection-invitation
curl -X POST https://YOUR_DOMAIN/api/channels/amazon/connection-invitation \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "marketplace": "ATVPDKIKX0DER",
    "nickname": "string",
    "redirect_url": "https://app.example.com/channels/connected"
}'
Loading response...
GET/channels/{channel}

Show a channel

Get a single channel by its ID. Used to populate the channel edit page.

Required attributes

  • Name
    channel
    Type
    integer
    Description
    The ID of the channel 1

Request

GET/channels/{channel}
curl -G https://YOUR_DOMAIN/api/channels/{channel} \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json"
Loading response...
DELETE/channels/{channel}

Delete a channel

Delete a channel and its associated listings, listing-product links, and Amazon feeds.

Required attributes

  • Name
    channel
    Type
    integer
    Description
    The ID of the channel 1

Request

DELETE/channels/{channel}
curl -X DELETE https://YOUR_DOMAIN/api/channels/{channel} \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json"
Loading response...
GET/channels/{channel}/activate

Activate a channel

Mark a channel as active. Used on the channel edit page.

Required attributes

  • Name
    channel
    Type
    integer
    Description
    The ID of the channel 1

Request

GET/channels/{channel}/activate
curl -G https://YOUR_DOMAIN/api/channels/{channel}/activate \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json"
Loading response...
GET/channels/{channel}/deactivate

Deactivate a channel

Deactivate a channel, setting its connection status to `unauthorized`. Used on the channel edit page.

Required attributes

  • Name
    channel
    Type
    integer
    Description
    The ID of the channel 1

Request

GET/channels/{channel}/deactivate
curl -G https://YOUR_DOMAIN/api/channels/{channel}/deactivate \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json"
Loading response...
POST/channels/amazon

Create an Amazon channel

Create a new Amazon channel for the current merchant. The channel is created in an unauthorized state; use the authorize-url endpoint to begin the OAuth flow.

Required attributes

  • Name
    marketplace
    Type
    string
    Description
    The Amazon marketplace identifier to connect ATVPDKIKX0DER

Optional attributes

  • Name
    nickname
    Type
    string
    Description
    An optional nickname for the channel Amazon Store

Request

POST/channels/amazon
curl -X POST https://YOUR_DOMAIN/api/channels/amazon \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "marketplace": "ATVPDKIKX0DER",
    "nickname": "Amazon Store"
}'
Loading response...
PUT/channels/amazon/{channel}

Update an Amazon channel

Update an Amazon channel's nickname and marketplace. Changing the marketplace disconnects the channel and sets its connection status to `unauthorized`, requiring re-authorization.

Required attributes

  • Name
    channel
    Type
    integer
    Description
    The ID of the Amazon channel 1
  • Name
    marketplace
    Type
    string
    Description
    The Amazon marketplace identifier ATVPDKIKX0DER

Optional attributes

  • Name
    nickname
    Type
    string
    Description
    An optional nickname for the channel Amazon Store

Request

PUT/channels/amazon/{channel}
curl -X PUT https://YOUR_DOMAIN/api/channels/amazon/{channel} \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "marketplace": "ATVPDKIKX0DER",
    "nickname": "Amazon Store"
}'
Loading response...
GET/channels/amazon/{channel}/authorize-url

Get the Amazon channel authorize URL

Return the Amazon OAuth URL to redirect the merchant to in order to authorize the channel. This is the real "authorize" step of connecting an Amazon channel.

Required attributes

  • Name
    channel
    Type
    integer
    Description
    The ID of the Amazon channel 1

Request

GET/channels/amazon/{channel}/authorize-url
curl -G https://YOUR_DOMAIN/api/channels/amazon/{channel}/authorize-url \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json"
Loading response...
GET/channels/amazon/marketplaces

List Amazon marketplaces

Return the list of Amazon marketplaces that a channel can be connected to.

Request

GET/channels/amazon/marketplaces
curl -G https://YOUR_DOMAIN/api/channels/amazon/marketplaces \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json"
Loading response...
POST/channels/custom

Create a custom channel

Create a new custom channel for the current merchant. Custom channels are created in an active state.

Required attributes

  • Name
    nickname
    Type
    string
    Description
    A nickname for the channel My Custom Channel

Request

POST/channels/custom
curl -X POST https://YOUR_DOMAIN/api/channels/custom \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "nickname": "My Custom Channel"
}'
Loading response...
PUT/channels/custom/{channel}

Update a custom channel

Update a custom channel's nickname.

Required attributes

  • Name
    channel
    Type
    integer
    Description
    The ID of the custom channel 1
  • Name
    nickname
    Type
    string
    Description
    A nickname for the channel My Custom Channel

Request

PUT/channels/custom/{channel}
curl -X PUT https://YOUR_DOMAIN/api/channels/custom/{channel} \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "nickname": "My Custom Channel"
}'
Loading response...