Groups

Retrieves a specific group.

get/v1/shops/{shopId}/groups/{groupId}

Request

Response

idinteger
metadatastring nullable
created_atstring
updated_atstring
namestring
shop_idinteger
category_idinteger
image_idstring nullable
sort_priorityinteger
visibilitystring
deleted_atstring nullable
badge_colorstring nullable
badge_textstring nullable

Example response

{
  "id": 1,
  "metadata": null,
  "created_at": "2026-11-01T20:00:51.000000Z",
  "updated_at": "2026-11-01T20:00:51.000000Z",
  "name": "Keys & Serials",
  "shop_id": 1,
  "category_id": 1,
  "image_id": null,
  "sort_priority": 0,
  "visibility": "public",
  "deleted_at": null,
  "badge_color": null,
  "badge_text": null,
  "products": [
    {
      "id": 1,
      "group_id": 1,
      "group_sort_priority": 0
    }
  ]
}

Changes

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • warning

      removed the optional property // from the response with the status