Products
Get Many Products
Get multiple products with pagination and filtering
Authorization
api_key x-access-token<token>
In: header
Query Parameters
page?number
Page number for pagination (starting from 0)
Format
doubleDefault
0limit?number
Number of items per page
Format
doubleDefault
20search?string
Search term to filter products by name, SKU, or product barcode
Default
""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"
type?string
Filter by product types (comma-separated for multiple)
Default
""team_id?string
Default
""has_image?boolean
Filter products that have/don't have images
has_barcode?boolean
Filter products that have/don't have product barcodes
has_remote_products?boolean
Filter products that have/don't have remote products
was_inspected?boolean
Filter products that were/weren't inspected
warehouse_id?string
Filter inventory results by warehouse IDs (comma-separated for multiple)
Default
""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/products"{ "data": [ { "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", "available": 0.1, "on_hand": 0.1, "committed": 0.1, "unavailable": 0.1, "on_order": 0.1, "inventory_by_warehouse": [ { "on_order": { "operations": [ { "count": 0.1, "label": "string" } ], "count": 0.1 }, "unavailable": { "operations": [ { "count": 0.1, "label": "string" } ], "count": 0.1 }, "committed": { "operations": [ { "count": 0.1, "label": "string" } ], "count": 0.1 }, "on_hand": { "operations": [ { "count": 0.1, "label": "string" } ], "count": 0.1 }, "available": { "operations": [ { "count": 0.1, "label": "string" } ], "count": 0.1 }, "warehouse_name": "string", "warehouse_id": "string" } ], "supported_actions": [ { "action": "VIEW_PRODUCT" } ], "increment_level": 0.1, "maximum_level": 0.1, "minimum_level": 0.1, "barcode": "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 }}