Daftra API

GET All Products

Production

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

GET

/products{format}

Products

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https://.daftra.com/api2/products' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer ' \
--header 'apikey: ' \
--header 'Content-Type: application/json'

Response Example

200 - Example 1

{
  "code": 200,
  "result": "successful",
  "data": [
    {
      "Product": {
        "id": 0,
        "staff_id": 0,
        "name": "string",
        "description": "string",
        "unit_price": 0,
        "tax1": 0,
        "tax2": 0,
        "supplier_id": 0,
        "brand": "string",
        "category": "string",
        "tags": "string",
        "buy_price": 0,
        "product_code": "string",
        "track_stock": true,
        "stock_balance": 0,
        "low_stock_thershold": 0,
        "barcode": "string",
        "notes": "string",
        "status": 0,
        "created": "2018-05-10 00:42:00",
        "modified": "2018-05-12 13:05:06",
        "follow_up_status": null,
        "updated_price": true,
        "average_price": 0,
        "type": null,
        "minimum_price": null,
        "profit_margin": null,
        "discount": null,
        "discount_type": null,
        "duration_minutes": 0,
        "availabe_online": 0,
        "raw_store_id": null,
        "ProductImage": [
          {
            "id": 0,
            "product_id": 0,
            "default": true,
            "file": "string",
            "created": "2018-05-10 00:42:00",
            "modified": "2018-05-12 13:05:06",
            "file_full_path": "string"
          }
        ],
        "ProductCategory": [
          {
            "id": 0,
            "name": "string",
            "description": "string",
            "category_type": "1=> Products' Category",
            "parent_id": 0,
            "image": "string",
            "created": "2018-05-10 00:42:00",
            "modified": "2018-05-12 13:05:06",
            "image_full_path": "string"
          }
        ]
      }
    }
  ],
  "pagination": {
    "prev": "/api2/clients/?page=1",
    "next": "/api2/clients/?page=3",
    "page": 2,
    "page_count": 5,
    "total_results": 98
  }
}

Request

Path Params

format

string

required

Query Params

limit

integer

optional

The collection items limit

>= 1<= 1000

Default:

page

integer

optional

The collection items page

>= 1

Default:

Header Params

string

optional

Default:

application/json

Content-Type

string

optional

Default:

application/json

Authorization

string

optional

You can generate the bearer token using the the authorization endpoint then use it here to be able to operate over your account's data

Default:

Bearer {{access_token}}

apikey

string

deprecated

You can find/generate your apikey(s) from inside your Daftra Account

Default:

Responses

🟢200OK

application/json

Body

code

integer

optional

Example:

200

result

string

optional

Example:

successful

data

array [object {1}]

optional

Product

object

optional

pagination

object (Pagination)

optional

string | null

optional

Example:

/api2/clients/?page=1

string | null

optional

Example:

/api2/clients/?page=3

page

integer

optional

Example:

page_count

integer

optional

Example:

total_results

integer

optional

Example:

🟠401Unauthorized

🟠403Forbidden

Delete Products

Add New Product