GET Single Product

Production

https://{{subdomain}}.daftra.com/api2

GET

/products/{id}{format}

Returns a single product by its ID.

The product is returned inside the data object, wrapped in a Product object together with its related collections (images, categories). Requires a permission that grants access to viewing products.

Products are scoped to the current branch: a product that exists but belongs to another branch (and is not shared) is reported as not found.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Header Params

Responses

🟢200OK

application/json

The requested product.

Bodyapplication/json

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https://.daftra.com/api2/products/101.json' \
--header 'Accept: application/json' \
--header 'apikey: ' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json'

Response Example

200 - Example 1

{
    "result": "successful",
    "code": 200,
    "data": {
        "Product": {
            "id": 101,
            "staff_id": 0,
            "name": "Wireless Mouse",
            "description": "string",
            "unit_price": 25,
            "buy_price": 15,
            "average_price": 0,
            "minimum_price": 0,
            "tax1": 0,
            "tax2": 0,
            "supplier_id": 0,
            "brand": "string",
            "category": "string",
            "tags": "string",
            "product_code": "WM-001",
            "barcode": "6291041500213",
            "track_stock": 0,
            "stock_balance": 42,
            "low_stock_thershold": 0,
            "notes": "string",
            "status": 0,
            "type": 1,
            "discount": 0,
            "discount_type": 1,
            "profit_margin": 0,
            "duration_minutes": 0,
            "availabe_online": 0,
            "branch_id": 0,
            "created": "2018-05-10 00:42:00",
            "modified": "2018-05-12 13:05:06"
        },
        "ProductImage": [
            {}
        ],
        "ProductCategory": [
            {}
        ]
    }
}

GET All Products

Add New Product