Skip to content

Get listings

GET
/listings
curl --request GET \
--url 'https://acme.mykreezalid.com/api/partners/v1/listings?admin_status=waiting%2Crejected&category_id=12%2C34&fields=title%2Cprice%2Cattributes&order_type_id=2&status=published%2Cdraft&page=1&limit=25' \
--header 'Authorization: Basic <credentials>'

Returns a paginated list of your listings, most recent first. Filter the results with the query parameters below; each filter takes a single value, a comma-separated list or an array (status[]=draft&status[]=archived). Reduce the payload by listing the fields you need in fields (for example /listings?category_id=5,9&fields=id,title,price): when it is omitted, every field is returned. Required yes/no attributes that have no value on a listing are filled in with their default value.

admin_status
string

Example

waiting,rejected

Filter by moderation status: approved, rejected, waiting or blocked. A single value or a comma-separated list.

category_id
string

Example

12,34

Filter by category ID(s). Can be a single ID or a comma-separated list.

fields
string

Example

title,price,attributes

Comma-separated list of fields to include in the response (e.g. title,price,attributes).

order_type_id
string

Example

2

Filter by order type ID(s), as returned by GET /listings/order_types. A single ID or a comma-separated list.

status
string

Example

published,draft

Filter by listing status: published, draft or archived. A single value or a comma-separated list.

page
integer
default: 1 >= 1

Page to return, starting at 1.

limit
integer
default: 25 >= 1 <= 100

Number of listings per page, at most 100.

Your listings

Media typeapplication/json
object
listings
Array<object>
object
id

Listing’s unique identifier

integer
object
string
default: Listing
admin_status

Admin validation status of the listing. Possible values: waiting (awaiting approval), approved (visible if status also published), rejected (hidden from the marketplace).

string
Allowed values: waiting approved rejected blocked
attributes
Array
category
object
id

Category’s unique identifier

integer
object
string
default: Category
title
string
url
string
category_id
required

Category’s unique identifier

integer
city
string
nullable
country
string
nullable
cover
string
nullable
currency
string
date_online
string format: date-time
description
string
nullable
external_id
string
nullable
lat
number
nullable
lng
number
nullable
location
string
nullable
min_qty
number
nullable
medias
string
order_type_id
required

Order type’s unique identifier

integer
price
number format: double
nullable
price_unit
integer
nullable
price_with_currency
string
quantity
integer
nullable
quantity_selector
string
nullable
requires_shipping
boolean
shipping_methods
Array<object>
object
id
integer
carrier_alias
string
price
number
sort_priority
number
step_price
number
title
string
slug
string
nullable
state
string
nullable
status

Public status of the listing. Possible values: draft, published (visible), archived (hidden).

string
Allowed values: draft published archived
store_id

The store that holds this listing, by its id (as returned by GET /stores). The listing then shows at that store’s address, and buyers are told where to collect it. Leave the field out entirely to keep whatever store it already had. To move the listing, send the store it moves TO: a listing already in a store CANNOT be taken out of one by sending an empty value, because attaching replaced its own address and there is none to fall back to — unpublish it instead. A store that is not one of yours is refused. Send either store_id or store_external_id, not both.

integer
nullable
store_external_id

Optional alternative to store_id: YOUR OWN code for the store, the external_id you gave it. Only usable for a store that has one. Same rules as store_id: leave it out to keep the current store, send the code of the store the listing moves to, an empty value cannot take a listing out of its store. Send either store_id or store_external_id, not both.

string
nullable
supplier
User resource
object
id

User’s unique identifier

integer
object
string
default: User
account_type
string
Allowed values: individual company non-profit
external_id
string
nullable
address_city
string
address_country
string
address_line1
string
nullable
address_line2
string
nullable
address_state
string
nullable
address_zipcode
string
nullable
attributes
Array
nullable
avatar

Absolute URL of the profile image

string
nullable
business_name

Company or organization name

string
nullable
can_post_listing
boolean
created
string format: date-time
email
required
string
first_name
string
nullable
group
Array<object>
object
object
string
default: Group
id

Group’s unique identifier

integer
name
string
alias
string
group_alias
string
group_id
required
integer
group_name
string
lang
string
last_name
string
locale
string
nullable
note

Average note based on reviews

integer
phone_country_number
string
nullable
phone_number
string
nullable
profile_url
string
public_name
string
status

Account status. Possible values are “enabled2” or “disabled”

string
Allowed values: enabled disabled
store_id
integer
nullable
review_count
integer
timezone
string
default: UTC
username
string
nullable
supplier_id
required

Supplier’s unique identifier

integer
title
required
string
url
string
variants
object
id

Variant’s unique identifier

integer
object
string
default: Variant
external_id
string
nullable
listing_id
integer
price
number format: double
nullable
price_unit
number format: double
nullable
quantity

The quantity of the variant that is available for sale

number
default: 1 nullable
sort_priority

Sorts the variants with the lowest number first. Negative numbers are allowed.

number
default: 0 nullable
sku
string
nullable
title
required
string
weight
number
visibility

Defines where the listing is displayed. Possible values: both (visible in catalog and search), catalog (only catalog), search (only search results), none (not visible).

string
Allowed values: both catalog search none
weight
number
pagination

Paging information, added next to the results of a paginated list. Request another page with the page query parameter and change the page size with limit (at most 100).

object
totalResultsCount

Number of results across all pages.

integer
currentPage

Number of the page returned, starting at 1.

integer
nextPage

Whether a next page exists.

boolean
prevPage

Whether a previous page exists.

boolean
resultOnPageCount

Number of results on this page.

integer
pageCount

Number of pages.

integer

Example

{
"listings": [
{
"id": 645646,
"object": "Listing",
"admin_status": "waiting",
"attributes": "[]",
"category": {
"id": 432432,
"object": "Category"
},
"category_id": 432432,
"city": "New York City",
"country": "US",
"currency": "USD",
"description": "<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla dignissim laoreet sem, quis mollis elit rutrum a. Donec nunc urna, rhoncus in sagittis ut, elementum scelerisque libero. Quisque interdum nibh nisl, non gravida nibh molestie quis. Phasellus nunc nunc, luctus a luctus ac, iaculis sit amet turpis.</p><p>Phasellus tortor orci, posuere in mi at, blandit ullamcorper tellus. Proin vel sem aliquam, faucibus dolor quis, dictum leo. Aliquam consectetur massa at ipsum auctor, at mattis nunc porttitor. Suspendisse potenti. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus.</p>",
"external_id": "INTERNAL_REF_234324",
"lat": 40.7572114,
"lng": -73.9913385,
"location": "253 W 42nd St, New York, NY 10036, United States",
"min_qty": 1,
"order_type_id": 986545,
"price": 123.5,
"price_unit": null,
"price_with_currency": "$123.50",
"quantity": 43,
"quantity_selector": null,
"requires_shipping": true,
"shipping_methods": [
{
"id": 1,
"carrier_alias": "fed_ex",
"price": 4.95,
"sort_priority": 4,
"step_price": 0.95,
"title": "FedEx"
}
],
"slug": "listing-s-slug",
"state": "NY",
"status": "draft",
"store_id": 217833,
"store_external_id": "SHOP-BRUSSELS-01",
"supplier": {
"id": 545353,
"object": "User",
"account_type": "individual",
"external_id": "ABCdef123456",
"address_city": "New-York City",
"address_country": "US",
"address_line1": "253 W 42nd St",
"address_line2": null,
"address_state": "NY",
"address_zipcode": "NY 10036",
"attributes": {
"profession": "Web developer"
},
"business_name": "ACME",
"email": "admin@acme.com",
"first_name": "John",
"group": [
{
"object": "Group",
"id": 784568,
"name": "VIP Customers",
"alias": "vip-customers"
}
],
"group_id": 784568,
"last_name": "Doe",
"locale": "en",
"note": "4.5",
"phone_country_number": "+1",
"phone_number": "212-398-2600",
"public_name": "John Doe",
"status": "enabled",
"store_id": "123456",
"review_count": "3",
"timezone": "UTC",
"username": "BestJohnDoe"
},
"supplier_id": 655785,
"title": "Listing's title",
"variants": {
"id": 432432,
"object": "Variant",
"external_id": "INTERNAL_REF_234324",
"listing_id": 324353,
"price": 123.5,
"price_unit": null,
"quantity": "1",
"sort_priority": "0",
"sku": "BASKT-XYZ-BLN-41",
"title": "Blue Shoes Size 41",
"weight": 0.8
},
"visibility": "both",
"weight": 0.8
}
],
"pagination": {
"totalResultsCount": 137,
"currentPage": 1,
"resultOnPageCount": 25,
"pageCount": 6
}
}

category_id or order_type_id holds something other than positive integer IDs.

Missing or wrong API credentials.