Skip to main content

List goods

Method GET​

https://my.easyweek.io/api/public/v2/goods

Description: This endpoint returns the goods (retail products) of the workspace, paginated. Internal fields such as cost price, brand, tax and per-branch storage internals are not exposed; only an aggregate stock quantity is returned.

Example Request​

curl -i -X GET \
  https://my.easyweek.io/api/public/v2/goods?per_page={per_page}&search={search}&is_payable={is_payable} \
  -H 'Authorization: Bearer <YOUR_SECRET>' \
  -H 'Workspace: <YOUR_WORKSPACE>'

Query Parameters​

  • per_page (integer, optional): Number of items per page (alias of limit), maximum 100. Defaults to 15.
  • search (string, optional): Filter goods by name or article.
  • is_payable (boolean, optional): Filter by whether the good is sellable.

Example Response​

{
  "data": [
    {
      "uuid": "9c2f1b7e-2f8a-4a1e-bd2c-6b3a1f9e0d11",
      "name": "Shampoo",
      "article": "SKU-123",
      "category": {
        "uuid": "1a2b3c4d-5e6f-4a1b-8c9d-0e1f2a3b4c5d",
        "name": "Cosmetics",
        "class": "blue"
      },
      "description": null,
      "is_payable": true,
      "price": 1500,
      "unit": "pcs",
      "is_consumable": false,
      "consumable_unit": "pcs",
      "quantity_in_unit": null,
      "stock": 10,
      "can_be_set_up_as_consumable": true,
      "images": [],
      "image": null,
      "live": true,
      "live_in_widget": false,
      "public_name_translatable": {},
      "public_description_translatable": {}
    }
  ],
  "links": {
    "first": "https://my.easyweek.io/api/public/v2/goods?page=1",
    "last": "https://my.easyweek.io/api/public/v2/goods?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://my.easyweek.io/api/public/v2/goods",
    "per_page": 15,
    "to": 1,
    "total": 1
  }
}