All products

Response

When everything goes well, you get back status 200 with all your products in data, newest first:

{
  "data": [
    {
      "slug": "mw6",
      "name": "Linen Shirt",
      "priceRange": {
        "min": 25000,
        "max": 28000
      },
      "isSoldOut": false,
      "imageUrl": "https://…/mw6-red.jpg",
      "colors": [
        {
          "name": "Red",
          "hex": "#C0392B"
        },
        {
          "name": "Navy",
          "hex": "#1F2A44"
        }
      ]
    }
  ]
}

Here is what each part means:

slug is the product’s short name. Keep it: you will need it to get the product’s full details and to start a checkout.

priceRange is the lowest and highest price of the product. When sizes or colors have different prices, they’re not the same, so you can show “From 25,000 RWF”.

isSoldOut is true when nothing is left to buy.

imageUrl is the product’s first photo, or null when it has none.

Archived products are not in the list.

To show one product with all its photos, sizes and stock, use Get product with its slug.

Error Responses

Missing API key

Returned with status 401 when the request has no Authorization header. Add your key as Authorization: Bearer pk_live_xxxxxxxxx.

{
  "error": {
    "code": "missing_api_key",
    "message": "Send your API key as: Authorization: Bearer <key>."
  }
}

Invalid API key

Returned with status 401 when the key is wrong, or it was regenerated in Baag App. Copy your key again from Settings → Developers.

{
  "error": {
    "code": "invalid_api_key",
    "message": "That API key isn't valid. It may have been regenerated."
  }
}

Plan required

Returned with status 403 when your store’s plan doesn’t include the API. Your key works again as soon as your store is on the Basic or Pro plan.

{
  "error": {
    "code": "plan_required",
    "message": "This store's plan doesn't include API access."
  }
}

Rate limited

Returned with status 429 when your key sent too many requests in a short time. Wait a moment, then try again.

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Slow down and try again shortly."
  }
}

Internal error

Returned with status 500 when something went wrong on Baag’s side. It’s not your fault. Wait a moment, then try again.

{
  "error": {
    "code": "internal_error",
    "message": "Something went wrong on our side. Please try again."
  }
}

Get started

Store

Products

Collections

Checkout

All products

Authorization

Response

Error Responses

​Authorization

​Response

​Error Responses

Authorization

Response

Error Responses