Reference Data

The reference data endpoints let you retrieve configuration data like payment methods, suppliers, time slots, categories, allergens, and groupings.

These endpoints are read-only and require the reference:read scope.


GET/api/v1/reference/payment-methods

List payment methods

Retrieve enabled payment methods that can be used when creating orders or expenses.

Request

GET
/api/v1/reference/payment-methods
curl https://api.ibakepro.com/api/v1/reference/payment-methods \
  -H "Authorization: Bearer {api_key}"

Response

{
  "success": true,
  "data": {
    "payment_methods": [
      { "id": "cash", "name": "Cash" },
      { "id": "card", "name": "Card" },
      { "id": "bank_transfer", "name": "Bank Transfer" }
    ]
  }
}

GET/api/v1/reference/suppliers

List suppliers

Retrieve active suppliers that can be used when creating expenses.

Request

GET
/api/v1/reference/suppliers
curl https://api.ibakepro.com/api/v1/reference/suppliers \
  -H "Authorization: Bearer {api_key}"

Response

{
  "success": true,
  "data": {
    "suppliers": [
      {
        "id": "sup_abc123",
        "name": "Flour Mill Co",
        "email": "orders@flourmill.com",
        "phone": "+61 2 1234 5678"
      },
      {
        "id": "sup_def456",
        "name": "Dairy Direct",
        "email": "sales@dairydirect.com",
        "phone": null
      }
    ]
  }
}

GET/api/v1/reference/time-slots

List time slots

Retrieve delivery and pickup time slots that can be used when creating orders.

Query parameters

  • Name
    type
    Type
    string
    Description

    Filter by type: pickup or delivery.

Request

GET
/api/v1/reference/time-slots
curl https://api.ibakepro.com/api/v1/reference/time-slots \
  -H "Authorization: Bearer {api_key}"

Response

{
  "success": true,
  "data": {
    "time_slots": [
      { "id": "ps_morning", "label": "9:00 AM - 12:00 PM", "type": "pickup" },
      { "id": "ps_afternoon", "label": "1:00 PM - 5:00 PM", "type": "pickup" },
      { "id": "ds_morning", "label": "8:00 AM - 11:00 AM", "type": "delivery" },
      { "id": "ds_evening", "label": "5:00 PM - 8:00 PM", "type": "delivery" }
    ]
  }
}

GET/api/v1/reference/categories

List categories

Retrieve categories for expenses and pantry items.

Query parameters

  • Name
    type
    Type
    string
    Description

    Filter by type: expense, ingredient, or supply.

Request

GET
/api/v1/reference/categories
curl https://api.ibakepro.com/api/v1/reference/categories \
  -H "Authorization: Bearer {api_key}"

Response

{
  "success": true,
  "data": {
    "expense_categories": [
      "Ingredients", "Supplies", "Utilities", "Rent",
      "Equipment", "Marketing", "Insurance", "Licenses",
      "Professional Services", "Maintenance", "Transportation", "Other"
    ],
    "ingredient_categories": [
      "Dry Goods", "Dairy", "Eggs", "Fats & Oils",
      "Flavorings", "Fruits", "Sweeteners", "Nuts",
      "Chocolate", "Decorations", "Other"
    ],
    "supply_categories": [
      "Packaging", "Cake Boxes", "Cupcake Boxes",
      "Boards & Drums", "Tools", "Cleaning",
      "Disposables", "Office", "Other"
    ]
  }
}

GET/api/v1/reference/allergens

List allergens

Retrieve allergens configured for pantry items. Returns both configured allergens and any allergens currently in use on ingredients.

Request

GET
/api/v1/reference/allergens
curl https://api.ibakepro.com/api/v1/reference/allergens \
  -H "Authorization: Bearer {api_key}"

Response

{
  "success": true,
  "data": {
    "allergens": [
      "Dairy", "Eggs", "Gluten", "Nuts",
      "Peanuts", "Sesame", "Soy", "Tree Nuts"
    ]
  }
}

GET/api/v1/reference/groupings

List groupings

Retrieve groupings (tags) used on pantry items. Returns unique groupings from ingredients and supplies.

Query parameters

  • Name
    type
    Type
    string
    Description

    Filter by type: ingredient or supply.

Request

GET
/api/v1/reference/groupings
curl https://api.ibakepro.com/api/v1/reference/groupings \
  -H "Authorization: Bearer {api_key}"

Response

{
  "success": true,
  "data": {
    "groupings": [
      "Baking Basics", "Chocolate", "Decorations",
      "Frostings", "Refrigerated", "Seasonal"
    ]
  }
}

Was this page helpful?