Errors

{
  "error": {
    "code": "product_not_found",
    "message": "No product with the slug \"mw6\"."
  }
}

Note: check code in your code. message is for people and may change.

Any endpoint

Missing API key

Returned with status 401 when there’s no Authorization header.

{
  "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.

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

Plan required

Returned with status 403 when the store’s plan doesn’t include API access. The keys work again once the store is back on the Basic plan.

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

Not found

Returned with status 404 when there’s no endpoint at this path.

{
  "error": {
    "code": "not_found",
    "message": "There's no endpoint at this path."
  }
}

Rate limited

Returned with status 429 when the key sent too many requests in a short time. Wait a moment, then retry.

{
  "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. Retry.

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

Products and collections

Invalid limit

Returned with status 400 when limit is below 1 or not a whole number.

{
  "error": {
    "code": "invalid_limit",
    "message": "limit must be a whole number from 1 to 100."
  }
}

Product not found

Returned with status 404 when there’s no product with this slug in the store, or it’s archived.

{
  "error": {
    "code": "product_not_found",
    "message": "No product with the slug \"mw6\"."
  }
}

Collection not found

Returned with status 404 when there’s no collection with this id in the store.

{
  "error": {
    "code": "collection_not_found",
    "message": "No collection with the id \"cm8x2k1qv0003l70f9h2d5abc\"."
  }
}

Checkout

Invalid request

Returned with status 400 when a field is missing or has a wrong value. The message names the field.

{
  "error": {
    "code": "invalid_request",
    "message": "successUrl: Invalid url"
  }
}

Variant not found

Returned with status 400 when the size and color don’t match a variant, or you sent them for a product that has none.

{
  "error": {
    "code": "variant_not_found",
    "message": "That size and color combination doesn't exist for this product. Check its variants."
  }
}

Secret key required

Returned with status 403 when you used your public key. Call this endpoint from your server with your secret key.

{
  "error": {
    "code": "secret_key_required",
    "message": "Use your secret key, from your server, to read a checkout session."
  }
}

Product not found

Returned with status 404 when there’s no product with this slug in the store, or it’s archived.

{
  "error": {
    "code": "product_not_found",
    "message": "No product with the slug \"mw6\"."
  }
}

Session not found

Returned with status 404 when there’s no checkout session with this id in the store.

{
  "error": {
    "code": "session_not_found",
    "message": "No checkout session with the id \"cs_q3Lw9vX2bTn8YkPz4RfA1sJd\"."
  }
}

Sold out

Returned with status 409 when the product, or the size and color picked, is sold out.

{
  "error": {
    "code": "sold_out",
    "message": "Red / M is sold out."
  }
}

Insufficient stock

Returned with status 409 when the buyer asked for more than what’s left. The message says how many are left.

{
  "error": {
    "code": "insufficient_stock",
    "message": "Only 1 left in stock."
  }
}

Get started

Store

Products

Collections

Checkout

Any endpoint

Products and collections

Checkout

​Any endpoint

​Products and collections

​Checkout

Any endpoint

Products and collections

Checkout