ProductsProduct listing variants

Get Many Product Listing Variants

Get multiple product listing variants with pagination and filtering

GET
/shipos/product-listing-variants
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 variants by title or SKU

Default""
product_listing_id?string

Filter by product listing ID

Default""
shop_id?string

Filter by shop ID

Default""
product_id?string

Filter by linked product ID

Default""
has_product?boolean

Filter for variants with linked products (true for linked, false for unlinked)

order_by?string

Field to order results by

Default"created_at"

Value in

  • "created_at"
  • "updated_at"
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-listing-variants"
{  "data": [    {      "shop_slug": "string",      "shop_name": "string",      "shop_type": "SHOPIFY",      "remote_shopify_inventory_item_id": "string",      "shop_id": "string",      "weight_unit": "G",      "weight": 0,      "sku": "string",      "team_name": "string",      "team_id": "string",      "fulfiller_team_name": "string",      "fulfiller_team_id": "string",      "merchant_team_name": "string",      "merchant_team_id": "string",      "product_listing_name": "string",      "product_listing_id": "string",      "product_type": "STANDARD",      "product_id": "string",      "image_url": "string",      "country_of_origin": "string",      "currency": "string",      "price": 0.1,      "hs_code": "string",      "barcode": "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",      "product": {        "is_hazmat": true,        "subcategory": "string",        "category": "string",        "virtual_bundle_component_count": 0.1,        "product_listing_variant_count": {          "SHOPIFY": 0.1,          "MAGENTO2": 0.1,          "BIGCOMMERCE": 0.1,          "MANUAL": 0.1,          "WOOCOMMERCE": 0.1,          "WIX": 0.1,          "TIKTOK": 0.1        },        "pick_fee_override": 0,        "printed_commodity_identifier": "string",        "eccn": "string",        "manufacturer": "string",        "updated_at": "2019-08-24T14:15:22Z",        "created_at": "2019-08-24T14:15:22Z",        "config": {          "replenishment_source_strategy": "FIFO",          "replenishment_increment_level": 0,          "replenishment_maximum_level": 0,          "replenishment_minimum_level": 0        },        "first_article_inspection_completed_at": "2019-08-24T14:15:22Z",        "customs_value_currency": "string",        "customs_value": 0,        "customs_description": "string",        "country_of_origin": "string",        "hs_code": "string",        "mpn": "string",        "image_url": "string",        "measurement_unit": "MM",        "height": 0.1,        "width": 0.1,        "length": 0.1,        "weight_unit": "G",        "weight": 0,        "cost_currency": "string",        "cost_price": 0,        "sku": "string",        "description": "string",        "type": "STANDARD",        "name": "string",        "team_name": "string",        "team_id": "string",        "fulfiller_team_name": "string",        "fulfiller_team_id": "string",        "merchant_team_name": "string",        "merchant_team_id": "string",        "id": "string"      },      "product_listing": {        "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"      },      "supported_actions": [        {          "action": "VIEW_LISTING_VARIANT"        }      ]    }  ],  "meta": {    "page": 0.1,    "page_size": 0.1,    "has_next_page": true,    "has_previous_page": true,    "start_index": 0.1,    "end_index": 0.1  }}