PrepBusiness LogoAPI Documentation

Channel Listings

GET/channels/{channel_id}/listings

List listings for a channel

Required attributes

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

Request

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

Create a listing for a channel

Required attributes

  • Name
    channel_id
    Type
    integer
    Description
    The ID of the channel 1
  • Name
    channel_identifier
    Type
    string
    Description
    The channel-specific identifier for the listing (e.g. ASIN for Amazon) B01234567

Optional attributes

  • Name
    item_id
    Type
    integer
    Description
    The ID of the inventory item to link to this listing. If omitted, the listing is created without a linked item. 1
  • Name
    merchant_sku
    Type
    string
    Description
    The merchant SKU to use for this listing. If omitted, the item's SKU is used, falling back to the channel identifier when there is no linked item.
  • Name
    condition
    Type
    string
    Description
    Accepted for compatibility and not stored. Walmart conditions are set when the listing is pushed to Walmart.

Request

POST/channels/{channel_id}/listings
curl -X POST https://YOUR_DOMAIN/api/channels/{channel-id}/listings \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "channel_identifier": "B01234567",
    "item_id": 1,
    "merchant_sku": "string",
    "condition": "string"
}'
Loading response...
POST/channels/listings/{listing}/link

Link a listing to a product

Required attributes

  • Name
    listing
    Type
    integer
    Description
    The ID of the listing 1
  • Name
    item_id
    Type
    integer
    Description
    The ID of the inventory item to link to this listing 1

Request

POST/channels/listings/{listing}/link
curl -X POST https://YOUR_DOMAIN/api/channels/listings/{listing}/link \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "item_id": 1
}'
Loading response...