All collections

Response

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

{
  "data": [
    {
      "id": "cm8x2k1qv0003l70f9h2d5abc",
      "name": "New arrivals",
      "imageUrl": "https://…/new-arrivals.jpg"
    }
  ]
}

Here is what each part means:

id is the collection’s id. Keep it: you will need it to get the collection’s products.

imageUrl is the collection’s cover photo, or null when it has none.

Collections are part of the Pro plan. On the Basic plan, data is always an empty list.

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 collections

Authorization

Response

Error Responses

​Authorization

​Response

​Error Responses

Authorization

Response

Error Responses