Products

Get Products

Retreives the products.

Authorization

AuthorizationRequiredBearer <token>

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

In: header

Request Body

application/jsonOptional

pageinteger

perPageinteger

Must be at least 1. Must not be greater than 100.

orderColumnstring

Value in: "id" | "name" | "price" | "products_sold"

orderDirectionstring

Value in: "asc" | "desc"

typestring

Value in: "variant" | "addon"

idsarray<integer>

pathsarray<string>

namestring

variant_namestring

visibilitiesarray<string>

group_idsarray<integer>

group_nullboolean

badge_textstring

status_textstring

deliverablestring

deliverables_typestring

allstring

Path Parameters

shopIdRequiredinteger

curl -X GET "https://api.sellauth.com/v1/shops/{shopId}/products" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "page": 15,
    "perPage": 7,
    "orderColumn": "price",
    "orderDirection": "asc",
    "type": "addon",
    "ids": [
      1
    ],
    "paths": [
      "qui"
    ],
    "name": "necessitatibus",
    "variant_name": "recusandae",
    "visibilities": [
      "on_hold"
    ],
    "group_ids": [
      17
    ],
    "group_null": true,
    "badge_text": "qui",
    "status_text": "tempore",
    "deliverable": "voluptatem",
    "deliverables_type": "ea",
    "all": null
  }'

{
  "message": "No query results for model [App\\Models\\Shop] 1"
}

Create Product

Creates a new product.

Authorization

AuthorizationRequiredBearer <token>

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

In: header

Request Body

application/jsonRequired

typestring

Value in: "variant" | "addon"

nameRequiredstring

pathstring

Must match the regex /^[a-z0-9-]+$/.

descriptionstring

Must not be greater than 65535 characters.

meta_titlestring

Must not be greater than 255 characters.

meta_descriptionstring

Must not be greater than 65535 characters.

meta_image_idstring

The id of an existing record in the images table.

meta_twitter_cardstring

Value in: "summary" | "summary_large_image"

instructionsstring

Must not be greater than 65535 characters.

out_of_stock_messagestring

Must not be greater than 65535 characters.

currencyRequiredstring

tax_inclusiveboolean

deliverables_typestring

Value in: "serials" | "service" | "dynamic"

group_idstring

The id of an existing record in the groups table.

image_idsarray<string>

The id of an existing record in the images table.

visibilityRequiredstring

Value in: "public" | "unlisted" | "private" | "on_hold"

volume_discountsarray<object>

Must not have more than 10 items.

disable_volume_discounts_if_couponboolean

discord_requiredboolean

block_vpnboolean

hide_stock_countboolean

status_colorstring

status_textstring

show_views_countboolean

show_sales_countboolean

show_sales_notificationsboolean

sales_count_hoursnumber

feedback_coupon_idstring

The id of an existing record in the coupons table.

feedback_coupon_min_ratingnumber

Must be at least 1. Must not be greater than 5.

deliverables_labelstring

Must not be greater than 255 characters.

custom_field_idsarray<string>

The id of an existing record in the custom_fields table.

product_tabsarray<object>

Must not have more than 10 items.

product_badgesarray<object>

Must not have more than 10 items.

product_addonsRequiredarray<string>

product_upsellsRequiredarray<string>

variantsarray<object>

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

Path Parameters

shopIdRequiredinteger

curl -X POST "https://api.sellauth.com/v1/shops/{shopId}/products" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "variant",
    "name": "corporis",
    "path": "qh0f8",
    "description": "Rerum maiores qui dolores optio esse.",
    "meta_title": "nxiwxqmfghyadw",
    "meta_description": "qyqgnryrsstj",
    "meta_image_id": null,
    "meta_twitter_card": "summary_large_image",
    "instructions": "apyzgcrllkeiswes",
    "out_of_stock_message": "ynqjwbbpdtxzdwt",
    "currency": "consequatur",
    "tax_inclusive": false,
    "deliverables_type": "serials",
    "group_id": null,
    "image_ids": null,
    "visibility": "public",
    "volume_discounts": null,
    "disable_volume_discounts_if_coupon": true,
    "discord_required": true,
    "block_vpn": false,
    "hide_stock_count": true,
    "status_color": null,
    "status_text": null,
    "show_views_count": true,
    "show_sales_count": false,
    "show_sales_notifications": true,
    "sales_count_hours": 740432.249,
    "feedback_coupon_id": null,
    "feedback_coupon_min_rating": 1,
    "deliverables_label": "yqyoxhlosmztye",
    "custom_field_ids": null,
    "product_tabs": null,
    "product_badges": null,
    "product_addons": [
      "quibusdam"
    ],
    "product_upsells": [
      "id"
    ],
    "variants": null
  }'

Update Product and Group Order

Updates the order of products and groups.

Authorization

AuthorizationRequiredBearer <token>

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

In: header

Request Body

application/jsonRequired

sortedIdsRequiredarray<object>

Path Parameters

shopIdRequiredinteger

curl -X PUT "https://api.sellauth.com/v1/shops/{shopId}/products/sort" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "sortedIds": [
      []
    ]
  }'

Get Product

Retrieves a product.

Authorization

AuthorizationRequiredBearer <token>

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

In: header

Path Parameters

shopIdRequiredinteger

productIdRequiredstring

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

{
  "message": "No query results for model [App\\Models\\Shop] 1"
}

Delete Product

Deletes a product.

Authorization

AuthorizationRequiredBearer <token>

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

In: header

Path Parameters

shopIdRequiredinteger

productIdRequiredstring

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

Update Product

Updates a product.

Authorization

AuthorizationRequiredBearer <token>

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

In: header

Request Body

application/jsonRequired

typestring

Value in: "variant" | "addon"

nameRequiredstring

pathstring

Must match the regex /^[a-z0-9-]+$/.

descriptionstring

Must not be greater than 65535 characters.

meta_titlestring

Must not be greater than 255 characters.

meta_descriptionstring

Must not be greater than 65535 characters.

meta_image_idstring

The id of an existing record in the images table.

meta_twitter_cardstring

Value in: "summary" | "summary_large_image"

instructionsstring

Must not be greater than 65535 characters.

out_of_stock_messagestring

Must not be greater than 65535 characters.

currencyRequiredstring

tax_inclusiveboolean

deliverables_typestring

Value in: "serials" | "service" | "dynamic"

group_idstring

The id of an existing record in the groups table.

image_idsarray<string>

The id of an existing record in the images table.

visibilityRequiredstring

Value in: "public" | "unlisted" | "private" | "on_hold"

volume_discountsarray<object>

Must not have more than 10 items.

disable_volume_discounts_if_couponboolean

discord_requiredboolean

block_vpnboolean

hide_stock_countboolean

status_colorstring

status_textstring

show_views_countboolean

show_sales_countboolean

show_sales_notificationsboolean

sales_count_hoursnumber

feedback_coupon_idstring

The id of an existing record in the coupons table.

feedback_coupon_min_ratingnumber

Must be at least 1. Must not be greater than 5.

deliverables_labelstring

Must not be greater than 255 characters.

custom_field_idsarray<string>

The id of an existing record in the custom_fields table.

product_tabsarray<object>

Must not have more than 10 items.

product_badgesarray<object>

Must not have more than 10 items.

product_addonsRequiredarray<string>

product_upsellsRequiredarray<string>

variantsarray<object>

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

Path Parameters

shopIdRequiredinteger

productIdRequiredstring

curl -X PUT "https://api.sellauth.com/v1/shops/{shopId}/products/aut/update" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "addon",
    "name": "non",
    "path": "b",
    "description": "Iste molestiae qui mollitia minima voluptatem impedit quod.",
    "meta_title": "natphqsphmpwbtxoli",
    "meta_description": "kytzmgpmoifhcxhmbn",
    "meta_image_id": null,
    "meta_twitter_card": "summary_large_image",
    "instructions": "kh",
    "out_of_stock_message": "dpbmszalkobngsx",
    "currency": "numquam",
    "tax_inclusive": true,
    "deliverables_type": "service",
    "group_id": null,
    "image_ids": null,
    "visibility": "private",
    "volume_discounts": null,
    "disable_volume_discounts_if_coupon": true,
    "discord_required": true,
    "block_vpn": true,
    "hide_stock_count": false,
    "status_color": null,
    "status_text": null,
    "show_views_count": true,
    "show_sales_count": false,
    "show_sales_notifications": false,
    "sales_count_hours": 1485868.6318894,
    "feedback_coupon_id": null,
    "feedback_coupon_min_rating": 3,
    "deliverables_label": "asikjqfgzmszryq",
    "custom_field_ids": null,
    "product_tabs": null,
    "product_badges": null,
    "product_addons": [
      "dignissimos"
    ],
    "product_upsells": [
      "ea"
    ],
    "variants": null
  }'

Clone Product

Clones a product.

Authorization

AuthorizationRequiredBearer <token>

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

In: header

Path Parameters

shopIdRequiredinteger

productIdRequiredstring

curl -X POST "https://api.sellauth.com/v1/shops/{shopId}/products/aut/clone" \
  -H "Authorization: Bearer <token>"

Update Stock

Updates the stock count of a service or dynamic product variant.

Authorization

AuthorizationRequiredBearer <token>

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

In: header

Path Parameters

shopIdRequiredinteger

productIdRequiredstring

variantIdRequiredstring

curl -X PUT "https://api.sellauth.com/v1/shops/{shopId}/products/id/stock/eaque" \
  -H "Authorization: Bearer <token>"

Get Deliverables

Retrieves the deliverables for a product or variant.

Authorization

AuthorizationRequiredBearer <token>

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

In: header

Path Parameters

shopIdRequiredinteger

productIdRequiredstring

variantIdRequiredstring

Optional parameter.

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

{
  "message": "No query results for model [App\\Models\\Shop] 1"
}

Append Deliverables

Appends deliverables to a product or variant.

Authorization

AuthorizationRequiredBearer <token>

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

In: header

Path Parameters

shopIdRequiredinteger

productIdRequiredstring

variantIdRequiredstring

Optional parameter.

curl -X PUT "https://api.sellauth.com/v1/shops/{shopId}/products/illum/deliverables/append/string" \
  -H "Authorization: Bearer <token>"

Overwrite Deliverables

Overwrites deliverables for a product or variant.

Authorization

AuthorizationRequiredBearer <token>

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

In: header

Path Parameters

shopIdRequiredinteger

productIdRequiredstring

variantIdRequiredstring

Optional parameter.

curl -X PUT "https://api.sellauth.com/v1/shops/{shopId}/products/voluptatem/deliverables/overwrite/string" \
  -H "Authorization: Bearer <token>"

Bulk Update Disabled Payment Methods

Bulk updates disabled payment methods for products.

Authorization

AuthorizationRequiredBearer <token>

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

In: header

Request Body

application/jsonOptional

product_idsobject

disabled_payment_method_idsarray<string>

The id of an existing record in the payment_methods table.

Path Parameters

shopIdRequiredinteger

curl -X PUT "https://api.sellauth.com/v1/shops/{shopId}/products/bulk-update/disabled-payment-methods" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "product_ids": null,
    "disabled_payment_method_ids": null
  }'

{
  "success": true,
  "message": "Products updated successfully"
}

Bulk Update Custom Fields

Bulk updates custom fields for products.

Authorization

AuthorizationRequiredBearer <token>

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

In: header

Request Body

application/jsonOptional

product_idsobject

custom_field_idsarray<string>

The id of an existing record in the custom_fields table.

Path Parameters

shopIdRequiredinteger

curl -X PUT "https://api.sellauth.com/v1/shops/{shopId}/products/bulk-update/custom-fields" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "product_ids": null,
    "custom_field_ids": null
  }'

{
  "success": true,
  "message": "Products updated successfully"
}

Bulk Update Discord Integration

Bulk updates Discord integration for products.

Authorization

AuthorizationRequiredBearer <token>

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

In: header

Request Body

application/jsonOptional

product_idsobject

discord_requiredboolean

discord_rolesarray<object>

Must not have more than 10 items.

Path Parameters

shopIdRequiredinteger

curl -X PUT "https://api.sellauth.com/v1/shops/{shopId}/products/bulk-update/discord-integration" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "product_ids": null,
    "discord_required": true,
    "discord_roles": null
  }'

{
  "success": true,
  "message": "Products updated successfully"
}

Bulk Update Description

Bulk updates product descriptions.

Authorization

AuthorizationRequiredBearer <token>

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

In: header

Request Body

application/jsonRequired

product_idsobject

typeRequiredstring

Value in: "overwrite" | "append" | "prepend"

descriptionstring

Path Parameters

shopIdRequiredinteger

curl -X PUT "https://api.sellauth.com/v1/shops/{shopId}/products/bulk-update/description" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "product_ids": null,
    "type": "prepend",
    "description": null
  }'

{
  "success": true,
  "message": "Products updated successfully"
}

Bulk Update Instructions

Bulk updates product instructions.

Authorization

AuthorizationRequiredBearer <token>

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

In: header

Request Body

application/jsonOptional

product_idsobject

instructionsstring

Must not be greater than 65535 characters.

Path Parameters

shopIdRequiredinteger

curl -X PUT "https://api.sellauth.com/v1/shops/{shopId}/products/bulk-update/instructions" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "product_ids": null,
    "instructions": "jpymdjutjhctruuhenyoslbs"
  }'

{
  "success": true,
  "message": "Products updated successfully"
}

Bulk Update Out of Stock Message

Bulk updates product out of stock message.

Authorization

AuthorizationRequiredBearer <token>

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

In: header

Request Body

application/jsonOptional

product_idsobject

out_of_stock_messagestring

Must not be greater than 65535 characters.

Path Parameters

shopIdRequiredinteger

curl -X PUT "https://api.sellauth.com/v1/shops/{shopId}/products/bulk-update/out-of-stock-message" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "product_ids": null,
    "out_of_stock_message": "vhnauzjmmohtqhkrdy"
  }'

{
  "success": true,
  "message": "Products updated successfully"
}

Bulk Update Security

Bulk updates product security settings.

Authorization

AuthorizationRequiredBearer <token>

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

In: header

Request Body

application/jsonOptional

product_idsobject

block_vpnboolean

Path Parameters

shopIdRequiredinteger

curl -X PUT "https://api.sellauth.com/v1/shops/{shopId}/products/bulk-update/security" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "product_ids": null,
    "block_vpn": false
  }'

{
  "success": true,
  "message": "Products updated successfully"
}

Bulk Update Badges

Bulk updates product badges.

Authorization

AuthorizationRequiredBearer <token>

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

In: header

Request Body

application/jsonRequired

product_idsobject

typeRequiredstring

Value in: "overwrite" | "append" | "prepend"

product_badgesarray<object>

Must not have more than 10 items.

Path Parameters

shopIdRequiredinteger

curl -X PUT "https://api.sellauth.com/v1/shops/{shopId}/products/bulk-update/badges" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "product_ids": null,
    "type": "overwrite",
    "product_badges": null
  }'

{
  "success": true,
  "message": "Products updated successfully"
}

Bulk Update Status

Bulk updates product status.

Authorization

AuthorizationRequiredBearer <token>

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

In: header

Request Body

application/jsonOptional

product_idsobject

status_colorstring

status_textstring

Path Parameters

shopIdRequiredinteger

curl -X PUT "https://api.sellauth.com/v1/shops/{shopId}/products/bulk-update/status" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "product_ids": null,
    "status_color": null,
    "status_text": null
  }'

{
  "success": true,
  "message": "Products updated successfully"
}

Bulk Update Visibility

Bulk updates product visibility.

Authorization

AuthorizationRequiredBearer <token>

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

In: header

Request Body

application/jsonRequired

product_idsobject

visibilityRequiredstring

Value in: "public" | "unlisted" | "private" | "on_hold"

Path Parameters

shopIdRequiredinteger

curl -X PUT "https://api.sellauth.com/v1/shops/{shopId}/products/bulk-update/visibility" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "product_ids": null,
    "visibility": "on_hold"
  }'

{
  "success": true,
  "message": "Products updated successfully"
}

Bulk Update Live Stats

Bulk updates product live stats.

Authorization

AuthorizationRequiredBearer <token>

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

In: header

Request Body

application/jsonOptional

product_idsobject

show_views_countboolean

show_sales_countboolean

show_sales_notificationsboolean

sales_count_hoursnumber

Path Parameters

shopIdRequiredinteger

curl -X PUT "https://api.sellauth.com/v1/shops/{shopId}/products/bulk-update/live-stats" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "product_ids": null,
    "show_views_count": true,
    "show_sales_count": true,
    "show_sales_notifications": true,
    "sales_count_hours": 5654.3
  }'

{
  "success": true,
  "message": "Products updated successfully"
}

Bulk Update Feedback Coupon

Bulk updates product feedback coupon.

Authorization

AuthorizationRequiredBearer <token>

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

In: header

Request Body

application/jsonOptional

product_idsobject

feedback_coupon_idstring

The id of an existing record in the coupons table.

feedback_coupon_min_ratingnumber

Must be at least 1. Must not be greater than 5.

Path Parameters

shopIdRequiredinteger

curl -X PUT "https://api.sellauth.com/v1/shops/{shopId}/products/bulk-update/feedback-coupon" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "product_ids": null,
    "feedback_coupon_id": null,
    "feedback_coupon_min_rating": 5
  }'

{
  "success": true,
  "message": "Products updated successfully"
}

Bulk Update Volume Discounts

Bulk updates product volume discounts.

Authorization

AuthorizationRequiredBearer <token>

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

In: header

Request Body

application/jsonOptional

product_idsobject

volume_discountsarray<object>

disable_volume_discounts_if_couponboolean

Path Parameters

shopIdRequiredinteger

curl -X PUT "https://api.sellauth.com/v1/shops/{shopId}/products/bulk-update/volume-discounts" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "product_ids": null,
    "volume_discounts": null,
    "disable_volume_discounts_if_coupon": false
  }'

{
  "success": true,
  "message": "Products updated successfully"
}

Bulk Update Redirect URL

Bulk updates product redirect URL.

Authorization

AuthorizationRequiredBearer <token>

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

In: header

Request Body

application/jsonOptional

product_idsobject

redirect_urlstring

Must start with one of https Must not be greater than 2048 characters.

Path Parameters

shopIdRequiredinteger

curl -X PUT "https://api.sellauth.com/v1/shops/{shopId}/products/bulk-update/redirect-url" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "product_ids": null,
    "redirect_url": "http://upton.com/modi-ad-nulla-totam-dolorem-nihil-sit-enim-id"
  }'

{
  "success": true,
  "message": "Products updated successfully"
}

Bulk Update Deliverables Type

Bulk updates product deliverables label.

Authorization

AuthorizationRequiredBearer <token>

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

In: header

Request Body

application/jsonOptional

product_idsobject

deliverables_typestring

Value in: "serials" | "service" | "dynamic"

Path Parameters

shopIdRequiredinteger

curl -X PUT "https://api.sellauth.com/v1/shops/{shopId}/products/bulk-update/deliverables-type" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "product_ids": null,
    "deliverables_type": "service"
  }'

{
  "success": true,
  "message": "Products updated successfully"
}

Bulk Update Deliverables Label

Bulk updates product deliverables label.

Authorization

AuthorizationRequiredBearer <token>

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

In: header

Request Body

application/jsonRequired

product_idsobject

deliverables_labelRequiredstring

Must not be greater than 255 characters.

Path Parameters

shopIdRequiredinteger

curl -X PUT "https://api.sellauth.com/v1/shops/{shopId}/products/bulk-update/deliverables-label" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "product_ids": null,
    "deliverables_label": "aktb"
  }'

{
  "success": true,
  "message": "Products updated successfully"
}

Products

Response

TypeScript

Response

TypeScript

Response

TypeScript

Response

TypeScript

Response

TypeScript

Response

TypeScript

Response

TypeScript

Response

TypeScript

Response

TypeScript

Response

TypeScript

Response

TypeScript

Response

TypeScript

Response

TypeScript

Response

TypeScript

Response

TypeScript

Response

TypeScript

Response

TypeScript

Response

TypeScript

Response

TypeScript