ProductsProduct listings

Get Many Product Listings

Get multiple product listings with pagination and filtering

GET
/shipos/product-listings
x-access-token<token>

In: header

Query Parameters

page?number

Page number for pagination (starting from 0)

Formatdouble
Default0
limit?number

Number of items per page

Formatdouble
Default20
search?string

Search term to filter product listings by name

Default""
name?string

Filter by product listing name

Default""
status?string

Filter by product listing status

Default""
shop_id?string

Filter by shop ID

Default""
shop_type?string

Filter by shop type

Default""
has_variants?boolean

Filter for listings with variants

order_by?string

Field to order results by

Default"created_at"

Value in

  • "created_at"
  • "updated_at"
  • "name"
order?string

Order direction

Value in

  • "asc"
  • "desc"

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/shipos/product-listings"
{  "data": [    {      "shop_slug": "string",      "shop_name": "string",      "shop_type": "SHOPIFY",      "team_name": "string",      "team_id": "string",      "fulfiller_team_name": "string",      "fulfiller_team_id": "string",      "merchant_team_name": "string",      "merchant_team_id": "string",      "shop_id": "string",      "image_url": "string",      "status": "ARCHIVED",      "slug": "string",      "description": "string",      "name": "string",      "synced_at": "2019-08-24T14:15:22Z",      "remote_id": "string",      "updated_at": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z",      "id": "string"    }  ],  "meta": {    "page": 0.1,    "page_size": 0.1,    "has_next_page": true,    "has_previous_page": true,    "start_index": 0.1,    "end_index": 0.1  }}