Skip to main content
GET
/
products
List products
curl --request GET \
  --url https://api.bitbybit.studio/customer/open/v1/products \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "productId": "<string>",
      "name": "<string>",
      "description": "<string>",
      "media": "<string>",
      "medias": [
        "<string>"
      ],
      "status": "<string>",
      "variants": [
        {
          "id": "<string>",
          "key": "<string>",
          "price": 123,
          "compareAtPrice": 123,
          "inventorySku": "<string>",
          "media": "<string>"
        }
      ],
      "options": [
        {
          "id": "<string>",
          "name": "<string>",
          "values": [
            "<string>"
          ]
        }
      ],
      "tags": [
        "<string>"
      ],
      "types": [
        "<string>"
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "page": 123,
    "limit": 123,
    "total": 123,
    "hasNextPage": true
  }
}

Authorizations

x-api-key
string
header
required

API key for authentication. Create one in Settings > Developer.

Query Parameters

page
integer
default:1
limit
integer
default:20
Required range: x <= 100

Search by product name

Response

200 - application/json

Successful response

data
object[]
meta
object