Skip to main content

List Products

GET 

/api/shipbob/:instance/products

Paginated, filterable, sortable list of ShipBob products (one row per variant) with their SKU.io product mapping state.

Required scope: integrations:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Authentication: Requires Bearer token.

Free-text search covers name, SKU, barcode, UPC, and GTIN; a wholly numeric search term also matches the record id exactly. Filter by mapping state with filter[mapping] (comma-separable: mapped, unmapped, needs_review, bundle). Advanced numeric, text, and datetime filters with operator variants (e.g. filter[name.contains], filter[total_on_hand.greater_than], filter[last_synced_at.between]) are also available for id, shipbob_product_id, name, sku, barcode, product_type, total_on_hand, total_fulfillable, last_synced_at, created_at, and updated_at.

Sort with the sort param (prefix - for descending). Default page size is 10.

  • filter[sku_product_id] — exact SKU.io product id the ShipBob product is mapped to.

Request​

Responses​

OK

Response Headers
    Content-Type