Groups

GEThttps://api.sellauth.com/v1/shops/{shopId}/groups

Path parameters

shopId*string

Example: "nam"

Response

200

Groups retrieved.

Body

application/json

idinteger

Example: 1

namestring

Example: "A Group"

image_idstring

image_urlstring

sort_priorityinteger

Example: 0

visibilitystring

Example: "public"

shop_idinteger

Example: 1

created_atstring (date-time)

Example: "2024-01-01T00:00:00.000000Z"

updated_atstring (date-time)

Example: "2024-01-01T00:00:00.000000Z"

deleted_atnullable string

products_countinteger

Example: 1

productsarray of object

Request

JavaScriptCurlPython

const response = await fetch('https://api.sellauth.com/v1/shops/{shopId}/groups', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "id": 1,
    "name": "A Group",
    "image_id": null,
    "image_url": null,
    "sort_priority": 0,
    "visibility": "public",
    "shop_id": 1,
    "created_at": "2024-01-01T00:00:00.000000Z",
    "updated_at": "2024-01-01T00:00:00.000000Z",
    "deleted_at": null,
    "products_count": 1,
    "products": [
      {
        "id": 1,
        "salt": "98fcb984b3e22",
        "created_at": "2024-01-01T00:00:00.000000Z",
        "updated_at": "2024-01-01T00:00:00.000000Z",
        "name": "A Product",
        "path": "a-product",
        "description": "<p class=\"e-paragraph\">Lorem ipsum odor amet, consectetuer adipiscing elit...</p>",
        "price": "10.00",
        "currency": "USD",
        "payment_methods": [
          "BTC"
        ],
        "deliverables": "Key 1\nKey 2\nKey 3",
        "deliverables_type": "serials",
        "stock": null,
        "image_url": null,
        "group_id": 1,
        "shop_id": 1,
        "volume_discounts": [],
        "type": "single",
        "instructions": "<p class=\"e-paragraph\"></p>",
        "out_of_stock_message": null,
        "sort_priority": 0,
        "group_sort_priority": 0,
        "visibility": "public",
        "on_hold": 0,
        "cloudflare_image_id": null,
        "deleted_at": null,
        "quantity_min": null,
        "quantity_max": null,
        "discord_guild_id": null,
        "discord_role_id": null,
        "block_vpn": 0,
        "stock_count": 0,
        "images": [
          {
            "id": 1,
            "cloudflare_image_id": "69xdd69x-420x-69r8-2ree-000r0e0e0e00",
            "created_at": "2024-01-01T00:00:00.000000Z",
            "updated_at": "2024-01-01T00:00:00.000000Z",
            "deleted_at": null,
            "shop_id": 1,
            "pivot": {
              "product_id": 1,
              "image_id": 1
            }
          }
        ],
        "variants": [],
        "custom_fields": [
          {
            "id": 1,
            "shop_id": 1,
            "name": "Your Name",
            "hint": null,
            "type": "text",
            "options": null,
            "is_required": true,
            "created_at": "2024-01-01T00:00:00.000000Z",
            "updated_at": "2024-01-01T00:00:00.000000Z",
            "pivot": {
              "morphable_id": 1,
              "custom_field_id": 1
            }
          }
        ]
      }
    ]
  }
]

POSThttps://api.sellauth.com/v1/shops/{shopId}/groups

Path parameters

shopId*string

Example: "nam"

Body

application/json

name*string

Example: "aut"

image_idstring

visibility*enum

Example: "private"

publicunlistedprivate

productsobject

Response

200422

Group created.

Body

application/json

idinteger

Example: 1

namestring

Example: "A Group"

image_idstring

image_urlstring

sort_priorityinteger

Example: 0

visibilitystring

Example: "public"

shop_idinteger

Example: 1

created_atstring (date-time)

Example: "2024-01-01T00:00:00.000000Z"

updated_atstring (date-time)

Example: "2024-01-01T00:00:00.000000Z"

deleted_atnullable string

Request

JavaScriptCurlPython

const response = await fetch('https://api.sellauth.com/v1/shops/{shopId}/groups', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "aut",
      "visibility": "private"
    }),
});
const data = await response.json();

Response

200422

{
  "id": 1,
  "name": "A Group",
  "image_id": null,
  "image_url": null,
  "sort_priority": 0,
  "visibility": "public",
  "shop_id": 1,
  "created_at": "2024-01-01T00:00:00.000000Z",
  "updated_at": "2024-01-01T00:00:00.000000Z",
  "deleted_at": null
}

GEThttps://api.sellauth.com/v1/shops/{shopId}/groups/{groupId}

Path parameters

shopId*string

Example: "enim"

groupId*string

Example: "my-group"

Response

200

Group retrieved.

Body

application/json

idinteger

Example: 1

namestring

Example: "A Group"

image_idstring

image_urlstring

sort_priorityinteger

Example: 0

visibilitystring

Example: "public"

shop_idinteger

Example: 1

created_atstring (date-time)

Example: "2024-01-01T00:00:00.000000Z"

updated_atstring (date-time)

Example: "2024-01-01T00:00:00.000000Z"

deleted_atnullable string

productsarray of Product (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.sellauth.com/v1/shops/{shopId}/groups/{groupId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": 1,
  "name": "A Group",
  "image_id": null,
  "image_url": null,
  "sort_priority": 0,
  "visibility": "public",
  "shop_id": 1,
  "created_at": "2024-01-01T00:00:00.000000Z",
  "updated_at": "2024-01-01T00:00:00.000000Z",
  "deleted_at": null,
  "products": [
    {
      "id": 1,
      "salt": "98fcb984b3e22",
      "created_at": "2024-01-01T00:00:00.000000Z",
      "updated_at": "2024-01-01T00:00:00.000000Z",
      "name": "A Product",
      "path": "a-product",
      "description": "<p class=\"e-paragraph\">Lorem ipsum odor amet, consectetuer adipiscing elit...</p>",
      "price": "10.00",
      "currency": "USD",
      "payment_methods": [
        "BTC"
      ],
      "deliverables": "Key 1\nKey 2\nKey 3",
      "deliverables_type": "serials",
      "stock": null,
      "image_url": null,
      "group_id": 1,
      "shop_id": 1,
      "volume_discounts": [],
      "type": "single",
      "instructions": "<p class=\"e-paragraph\"></p>",
      "out_of_stock_message": null,
      "sort_priority": 0,
      "group_sort_priority": 0,
      "visibility": "public",
      "on_hold": 0,
      "cloudflare_image_id": null,
      "deleted_at": null,
      "quantity_min": null,
      "quantity_max": null,
      "discord_guild_id": null,
      "discord_role_id": null,
      "block_vpn": 0,
      "stock_count": 0
    }
  ]
}

DELETEhttps://api.sellauth.com/v1/shops/{shopId}/groups/{groupId}

Path parameters

shopId*string

Example: "enim"

groupId*string

Example: "my-group"

Response

200

Group deleted.

Body

application/json

messagestring

Example: "Group deleted successfully"

Request

JavaScriptCurlPython

const response = await fetch('https://api.sellauth.com/v1/shops/{shopId}/groups/{groupId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200

{
  "message": "Group deleted successfully"
}