OBAPI OBAPI

Products

Product and service catalog.

List products

  • Method: GET /obapi/v1/products
  • Headers: Authorization: Bearer {apikey}
Parameter Type Required Description
page integer no Page number (default: 1)
per_page integer no Items per page (default: 50, max: 200)
type string no product or service
for_sale boolean no Filter products for sale
for_purchase boolean no Filter products for purchase
search string no Search in ref, label, description

Get a single product

  • Method: GET /obapi/v1/products/{id}

Response (single)

{
    "product": {
        "id": "101",
        "ref": "CONSULTING-01",
        "label": "Consulting service",
        "description": "Hourly consulting service",
        "type": "service",
        "price_excl_tax": "100.00",
        "price_incl_tax": "120.00",
        "price_min_excl_tax": "80.00",
        "price_min_incl_tax": "96.00",
        "price_base_type": "HT",
        "vat_rate": "20.000",
        "barcode": "",
        "weight": "",
        "weight_unit": "",
        "length": "",
        "width": "",
        "height": "",
        "stock": "",
        "stock_alert_threshold": "",
        "for_sale": true,
        "for_purchase": false,
        "created_at": "2023-01-15T10:30:00Z",
        "public_note": ""
    }
}

Response (list)

{
    "items": [
        {
            "id": "101",
            "ref": "CONSULTING-01",
            "label": "Consulting service",
            "type": "service",
            "price_excl_tax": "100.00",
            "price_incl_tax": "120.00",
            "for_sale": true,
            "for_purchase": false
        }
    ],
    "pagination": { "..." }
}