Skip to content
Veeqo, An Amazon company Developers
Login Signup

List All Store Listings

GET
/api/v2/channel_sellables

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
page[size]
number
default: 10

Number of items to show per page, between 1 and 100.

page[number]
number

Page number to show.

filter[remote_sku]
string

Show only store listings with this remote SKU code.

filter[remote_id]
string

Show only store listings with this remote ID.

filter[channel_id]
string

Show only store listings belonging to this specific store.

sort
string
Allowed values: active -active

Sort the results by criteria. Defaults to creation date in ascending order.

include
string
Allowed values: remote_url created_by channel_product.main_image

Comma-separated list of related resources to include.

Responses

Section titled “ Responses ”

200

Section titled “200 ”
object
data

A list of store listings.

Array<object>

A listing on a remote store (aka channel sellable).

object
id

ID of the store listing in Veeqo.

number
attributes
object
remote_title

The title of this store listing.

string
remote_sku

The SKU code of this store listing as it appears on the remote store.

string
remote_price

The price of this listing as it appears on the remote store.

string
currency_code

The unit of currency of the remote_price.

string
remote_inventory_quantity

The number of units shown for sale on the remote store.

number
remote_id

The ID of store listing on the remote store.

number
active

Whether this listing is active on the remote store.

boolean
relationships
object
channel
object
data
object
id

ID of the channel this store listing is linked to.

string
type 
channel
created_by
object
data
object
id

ID of the user who created this store listing.

string
type 
user
updated_by
object
data
object
id

ID of the last user who updated this store listing.

string
type 
user
product
object
data
object
id

ID of the product in Veeqo this store listing is linked to.

string
channel_product
object
data
object
id

ID of the channel product this listing is linked to.

string
type 
channel_product
sellable
object
data
object
id

ID of the sellable this store listing is linked to in Veeqo.

string
type 
sellable
meta
object
page

Metadata about pagination of the results.

object
current

Current page number.

string
size

Number of results shown per page.

string
total_pages

Number of pages in total.

string
total_count

Number of entities in total.

string
Example
{
  "data": [
    {
      "id": "6789",
      "type": "channel_sellable",
      "attributes": {
        "remote_title": "Test Product",
        "remote_sku": "SKU123456",
        "remote_price": 19.99,
        "currency_code": "GBP",
        "remote_inventory_quantity": null,
        "active": true
      },
      "relationships": {
        "channel": {
          "data": {
            "id": "54321",
            "type": "channel"
          }
        },
        "created_by": {
          "data": {
            "id": "101",
            "type": "user"
          }
        },
        "updated_by": {
          "data": null
        },
        "product": {
          "data": {
            "id": "2468",
            "type": "product"
          }
        },
        "channel_product": {
          "data": {
            "id": "9876",
            "type": "channel_product"
          }
        },
        "sellable": {
          "data": {
            "id": "12345",
            "type": "sellable"
          }
        },
        "remote_url": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "page": {
      "current": "1",
      "size": "10",
      "total_pages": "1",
      "total_count": "1"
    }
  }
}