Products

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

Path parameters

shopId*string

Example: 1

Response

200500

Products retrieved.

Body

application/json

current_pageinteger

Example: 1

dataarray of object

first_page_urlstring

Example: "https://api.sellauth.com/v1/shops/1/products?page=1"

frominteger

Example: 1

last_pageinteger

Example: 1

last_page_urlstring

Example: "https://api.sellauth.com/v1/shops/1/products?page=1"

linksarray of object

next_page_urlnullable string

pathstring

Example: "https://api.sellauth.com/v1/shops/1/products"

per_pageinteger

Example: 20

prev_page_urlnullable string

tointeger

Example: 1

totalinteger

Example: 1

Request

JavaScriptCurlPython

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

Response

200500

{
  "current_page": 1,
  "data": [
    {
      "id": 0,
      "salt": "98fcb984b3e22",
      "path": "a-product",
      "name": "A Product",
      "price": "10.00",
      "currency": "USD",
      "deliverables_type": "serials",
      "stock": null,
      "group_id": 1,
      "type": "single",
      "visibility": "public",
      "stock_count": 0,
      "group": {
        "id": 1,
        "name": "Group 1"
      }
    }
  ],
  "first_page_url": "https://api.sellauth.com/v1/shops/1/products?page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "https://api.sellauth.com/v1/shops/1/products?page=1",
  "links": [
    {
      "url": null,
      "label": "« Previous",
      "active": false
    }
  ],
  "next_page_url": null,
  "path": "https://api.sellauth.com/v1/shops/1/products",
  "per_page": 20,
  "prev_page_url": null,
  "to": 1,
  "total": 1
}

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

Path parameters

shopId*string

Example: 1

Body

application/json

name*string

Example: "deleniti"

pathstring

description*string

Example: "labore"

instructionsstring

out_of_stock_messagestring

currency*string

Example: "molestiae"

deliverablesstring

deliverables_typeenum

Example: "service"

serialsservicedynamic

stocknumber

Must be at least -1.

Example: 18

group_idstring

image_idsarray of string

type*enum

Example: "single"

singlevariant

visibility*enum

Example: "public"

publicunlistedprivateon_hold

payment_methodsobject

pricestring

This field is required when type is single.

quantity_minnumber

Must be at least 1.

Example: 79

quantity_maxnumber

Must be at least 0.

Example: 68

volume_discountsarray of string

discord_guild_idstring

discord_role_idstring

block_vpnboolean

Example: false

custom_field_idsarray of string

variantsobject

This field is required when type is variant. This field is required when type is variant. This field is required when type is variant. Must have at least 1 items.

Response

200422

Product created.

Body

application/json

idinteger

Example: 1

saltstring

Example: "98fcb984b3e22"

created_atstring (date-time)

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

updated_atstring (date-time)

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

namestring

Example: "A Product"

pathstring

Example: "a-product"

descriptionstring

Example: "<p class=\"e-paragraph\">Lorem ipsum odor amet, consectetuer adipiscing elit...</p>"

pricestring

Example: "10.00"

currencystring

Example: "USD"

payment_methodsarray of string

deliverablesnullable string

Example: "Key 1\nKey 2\nKey 3"

deliverables_typestring

Example: "serials"

stockinteger

image_urlnullable string

group_idinteger

Example: 1

shop_idinteger

Example: 1

volume_discountsarray of any

typestring

Example: "single"

instructionsstring

Example: "<p class=\"e-paragraph\"></p>"

out_of_stock_messagenullable string

sort_priorityinteger

Example: 0

group_sort_priorityinteger

Example: 0

visibilitystring

Example: "public"

on_holdinteger

Example: 0

cloudflare_image_idnullable string

deleted_atnullable string

quantity_minnullable integer

quantity_maxnullable integer

discord_guild_idnullable integer

discord_role_idnullable integer

block_vpninteger

Example: 0

stock_countinteger

Example: 0

imagesarray of object

variantsarray of object

custom_fieldsarray of object

Request

JavaScriptCurlPython

const response = await fetch('https://api.sellauth.com/v1/shops/{shopId}/products', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "deleniti",
      "description": "labore",
      "currency": "molestiae",
      "type": "single",
      "visibility": "public"
    }),
});
const data = await response.json();

Response

200422

{
  "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
      }
    }
  ]
}

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

Path parameters

shopId*string

Example: "laborum"

productId*string

Example: "dolorem"

Response

200

Product retrieved.

Body

application/json

idinteger

Example: 1

saltstring

Example: "98fcb984b3e22"

created_atstring (date-time)

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

updated_atstring (date-time)

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

namestring

Example: "A Product"

pathstring

Example: "a-product"

descriptionstring

Example: "<p class=\"e-paragraph\">Lorem ipsum odor amet, consectetuer adipiscing elit...</p>"

pricestring

Example: "10.00"

currencystring

Example: "USD"

payment_methodsarray of string

deliverablesnullable string

Example: "Key 1\nKey 2\nKey 3"

deliverables_typestring

Example: "serials"

stockinteger

image_urlnullable string

group_idinteger

Example: 1

shop_idinteger

Example: 1

volume_discountsarray of any

typestring

Example: "single"

instructionsstring

Example: "<p class=\"e-paragraph\"></p>"

out_of_stock_messagenullable string

sort_priorityinteger

Example: 0

group_sort_priorityinteger

Example: 0

visibilitystring

Example: "public"

on_holdinteger

Example: 0

cloudflare_image_idnullable string

deleted_atnullable string

quantity_minnullable integer

quantity_maxnullable integer

discord_guild_idnullable integer

discord_role_idnullable integer

block_vpninteger

Example: 0

stock_countinteger

Example: 0

imagesarray of object

variantsarray of object

custom_fieldsarray of object

Request

JavaScriptCurlPython

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

Response

200

{
  "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
      }
    }
  ]
}

DELETEhttps://api.sellauth.com/v1/shops/{shopId}/products/{productId}

Path parameters

shopId*string

Example: "laborum"

productId*string

Example: "dolorem"

Response

200

Product deleted.

Body

application/json

messagestring

Example: "Product deleted successfully"

Request

JavaScriptCurlPython

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

Response

200

{
  "message": "Product deleted successfully"
}