SellAuth

Groups

Get Groups

Retrieves the groups.

GET
/v1/shops/{shopId}/groups

Authorization

AuthorizationRequiredBearer <token>

You can retrieve your API key by visiting your dashboard and clicking Account > API.

In: header

Path Parameters

shopIdRequiredinteger

The shop ID.

curl -X GET "https://api.sellauth.com/v1/shops/{shopId}/groups" \
  -H "Authorization: Bearer <token>"

{
  "current_page": 1,
  "data": [
    {
      "id": 23,
      "created_at": "2025-07-27T18:02:09.000000Z",
      "updated_at": "2025-07-27T18:02:09.000000Z",
      "name": "My Group",
      "shop_id": 38,
      "category_id": null,
      "image_id": 450,
      "sort_priority": 0,
      "visibility": "public",
      "deleted_at": null,
      "badge_color": null,
      "badge_text": null,
      "products": [
        {
          "id": 762,
          "group_id": 23,
          "name": "My Product",
          "stock_count": 0
        }
      ],
      "image": {
        "id": 450,
        "cloudflare_image_id": "34231df0-a3ba-4e4a-c440-85269a308700",
        "created_at": "2025-07-27T18:00:52.000000Z",
        "updated_at": "2025-07-27T18:00:52.000000Z",
        "deleted_at": null,
        "shop_id": 38,
        "url": "https://imagedelivery.net/HL_Fwm__tlvUGLZF2p74xw/34231df0-a3ba-4e4a-c440-85269a308700/public"
      },
      "category": null
    }
  ],
  "first_page_url": "https://api.sellauth.com/v1/shops/38/groups?page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "https://api.sellauth.com/v1/shops/38/groups?page=1",
  "links": [
    {
      "url": null,
      "label": "&laquo; Previous",
      "active": false
    },
    {
      "url": "https://api.sellauth.com/v1/shops/38/groups?page=1",
      "label": "1",
      "active": true
    },
    {
      "url": null,
      "label": "Next &raquo;",
      "active": false
    }
  ],
  "next_page_url": null,
  "path": "https://api.sellauth.com/v1/shops/38/groups",
  "per_page": 20,
  "prev_page_url": null,
  "to": 1,
  "total": 1
}

Create Group

Creates a new group.

POST
/v1/shops/{shopId}/groups

Authorization

AuthorizationRequiredBearer <token>

You can retrieve your API key by visiting your dashboard and clicking Account > API.

In: header

Request Body

application/jsonRequired
nameRequiredstring
category_idstring
image_idstring
visibilityRequiredstring
Value in: "public" | "unlisted" | "private"
productsRequiredarray<string>
badge_colorstring
badge_textstring

Path Parameters

shopIdRequiredinteger

The shop ID.

curl -X POST "https://api.sellauth.com/v1/shops/{shopId}/groups" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "culpa",
    "category_id": null,
    "image_id": null,
    "visibility": "unlisted",
    "products": [
      "culpa"
    ],
    "badge_color": null,
    "badge_text": null
  }'

Get Group

Retrieves a specific group.

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

Authorization

AuthorizationRequiredBearer <token>

You can retrieve your API key by visiting your dashboard and clicking Account > API.

In: header

Path Parameters

shopIdRequiredinteger

The shop ID.

groupIdRequiredinteger

The group ID.

curl -X GET "https://api.sellauth.com/v1/shops/{shopId}/groups/{groupId}" \
  -H "Authorization: Bearer <token>"

{
  "id": 23,
  "created_at": "2025-07-27T18:02:09.000000Z",
  "updated_at": "2025-07-27T18:02:09.000000Z",
  "name": "My Group",
  "shop_id": 38,
  "category_id": null,
  "image_id": 450,
  "sort_priority": 0,
  "visibility": "public",
  "deleted_at": null,
  "badge_color": null,
  "badge_text": null,
  "products": [
    {
      "id": 762,
      "group_id": 23,
      "group_sort_priority": 0,
      "stock_count": 0
    }
  ]
}

Delete Group

Deletes a specific group.

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

Authorization

AuthorizationRequiredBearer <token>

You can retrieve your API key by visiting your dashboard and clicking Account > API.

In: header

Path Parameters

shopIdRequiredinteger

The shop ID.

groupIdRequiredinteger

The group ID.

curl -X DELETE "https://api.sellauth.com/v1/shops/{shopId}/groups/{groupId}" \
  -H "Authorization: Bearer <token>"

Update Group

Updates a specific group.

PUT
/v1/shops/{shopId}/groups/{groupId}/update

Authorization

AuthorizationRequiredBearer <token>

You can retrieve your API key by visiting your dashboard and clicking Account > API.

In: header

Request Body

application/jsonRequired
nameRequiredstring
category_idstring
image_idstring
visibilityRequiredstring
Value in: "public" | "unlisted" | "private"
productsRequiredarray<string>
badge_colorstring
badge_textstring

Path Parameters

shopIdRequiredinteger

The shop ID.

groupIdRequiredinteger

The group ID.

curl -X PUT "https://api.sellauth.com/v1/shops/{shopId}/groups/{groupId}/update" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "culpa",
    "category_id": null,
    "image_id": null,
    "visibility": "unlisted",
    "products": [
      "culpa"
    ],
    "badge_color": null,
    "badge_text": null
  }'