Skip to content
Crossmart Docs

The connection’s listings, most recently changed first

GET
/api/v1/workspaces/{workspaceId}/channel-connections/{connectionId}/listings
curl --request GET \
  --url 'https://api.crossmart.io/api/v1/workspaces/example/channel-connections/example/listings?status=PENDING&limit=25'

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
workspaceId
required
string
connectionId
required
string

Query Parameters

Section titled “Query Parameters”
status
string
Allowed values: PENDING ACTIVE INACTIVE ERROR DELISTED
cursor
string format: uuid
page
number
>= 1

1-based page number, for tables with page numbers. It wins over cursor.

limit
number
default: 25 >= 1 <= 100

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
object
items
required
Array<object>
object
id
required
string format: uuid
status
required
string
Allowed values: PENDING ACTIVE INACTIVE ERROR DELISTED
source
required

How the product joined the store: by hand, by an import, or by the automatic rule

string
Allowed values: MANUAL IMPORT RULE
externalId
required

The product’s id on the channel

string
nullable
externalUrl
required

Where to see it on the channel

string
nullable
lastError
required

Why the last sync failed

string
nullable
missingRequirement
required

What the channel refused the last publish for lacking (such as item_specifics), when the merchant can add it; null otherwise

string
Allowed values: reconnect account_settings shipping_policy payment_policy return_policy ship_from_location listing_setup images active_product category item_specifics option_names
lastSyncedAt
required
string format: date-time
nullable
category
required

The channel category it is listed in, on channels with categories (eBay)

object
id
required
string
name
required

The category with its ancestors, as the channel shows it

string
productId
required
string format: uuid
productTitle
required
string
imageUrl
required
string
nullable
variantCount
required
number
displayState
required

The product on this store, in one state computed by the server: draft (not selected for the store), needs_details (selected, but the store setup or the product lacks something publishing needs), ready (publishable, not sent yet), publishing (queued or in flight), published, failed, removing (being taken off) or removed.

string
Allowed values: draft needs_details ready publishing published failed removing removed
displayReason
required

For needs_details and failed: a short, merchant-readable reason (what to add, or the channel’s message). Never holds secrets. Null for the other states.

string
nullable
nextCursor
required
string
nullable
total
required

How many match in all, for page numbers

number

Example 

{
  "items": [
    {
      "status": "PENDING",
      "source": "MANUAL",
      "missingRequirement": "reconnect",
      "category": {
        "id": "20625",
        "name": "Home & Garden > Kitchen, Dining & Bar > Dinnerware & Serving Dishes > Mugs"
      },
      "displayState": "draft",
      "displayReason": "Choose a shipping policy in this eBay connection’s listing defaults."
    }
  ]
}