Criar produto

curl --request POST \
  --url https://api.speedsellx.io/v2/public/products \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "image": "<string>",
  "category_id": 2,
  "language_id": 2,
  "price": 1,
  "is_free": true,
  "convert_currency": true,
  "is_encapsulated": true,
  "has_speed_recovery": true,
  "attachment_url": "<string>",
  "landing_page": "<string>",
  "support_email": "jsmith@example.com",
  "author": "<string>",
  "shipping_cost": 1,
  "sku": "<string>",
  "deliverable_content": "<string>"
}
'

import requests

url = "https://api.speedsellx.io/v2/public/products"

payload = {
    "name": "<string>",
    "description": "<string>",
    "image": "<string>",
    "category_id": 2,
    "language_id": 2,
    "price": 1,
    "is_free": True,
    "convert_currency": True,
    "is_encapsulated": True,
    "has_speed_recovery": True,
    "attachment_url": "<string>",
    "landing_page": "<string>",
    "support_email": "jsmith@example.com",
    "author": "<string>",
    "shipping_cost": 1,
    "sku": "<string>",
    "deliverable_content": "<string>"
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    image: '<string>',
    category_id: 2,
    language_id: 2,
    price: 1,
    is_free: true,
    convert_currency: true,
    is_encapsulated: true,
    has_speed_recovery: true,
    attachment_url: '<string>',
    landing_page: '<string>',
    support_email: 'jsmith@example.com',
    author: '<string>',
    shipping_cost: 1,
    sku: '<string>',
    deliverable_content: '<string>'
  })
};

fetch('https://api.speedsellx.io/v2/public/products', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.speedsellx.io/v2/public/products",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'description' => '<string>',
    'image' => '<string>',
    'category_id' => 2,
    'language_id' => 2,
    'price' => 1,
    'is_free' => true,
    'convert_currency' => true,
    'is_encapsulated' => true,
    'has_speed_recovery' => true,
    'attachment_url' => '<string>',
    'landing_page' => '<string>',
    'support_email' => 'jsmith@example.com',
    'author' => '<string>',
    'shipping_cost' => 1,
    'sku' => '<string>',
    'deliverable_content' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.speedsellx.io/v2/public/products"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"image\": \"<string>\",\n  \"category_id\": 2,\n  \"language_id\": 2,\n  \"price\": 1,\n  \"is_free\": true,\n  \"convert_currency\": true,\n  \"is_encapsulated\": true,\n  \"has_speed_recovery\": true,\n  \"attachment_url\": \"<string>\",\n  \"landing_page\": \"<string>\",\n  \"support_email\": \"jsmith@example.com\",\n  \"author\": \"<string>\",\n  \"shipping_cost\": 1,\n  \"sku\": \"<string>\",\n  \"deliverable_content\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.speedsellx.io/v2/public/products")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"image\": \"<string>\",\n  \"category_id\": 2,\n  \"language_id\": 2,\n  \"price\": 1,\n  \"is_free\": true,\n  \"convert_currency\": true,\n  \"is_encapsulated\": true,\n  \"has_speed_recovery\": true,\n  \"attachment_url\": \"<string>\",\n  \"landing_page\": \"<string>\",\n  \"support_email\": \"jsmith@example.com\",\n  \"author\": \"<string>\",\n  \"shipping_cost\": 1,\n  \"sku\": \"<string>\",\n  \"deliverable_content\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.speedsellx.io/v2/public/products")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"image\": \"<string>\",\n  \"category_id\": 2,\n  \"language_id\": 2,\n  \"price\": 1,\n  \"is_free\": true,\n  \"convert_currency\": true,\n  \"is_encapsulated\": true,\n  \"has_speed_recovery\": true,\n  \"attachment_url\": \"<string>\",\n  \"landing_page\": \"<string>\",\n  \"support_email\": \"jsmith@example.com\",\n  \"author\": \"<string>\",\n  \"shipping_cost\": 1,\n  \"sku\": \"<string>\",\n  \"deliverable_content\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": 123,
    "seller_id": 123,
    "name": "<string>",
    "description": "<string>",
    "price": "<string>",
    "currency": "<string>",
    "type": "<string>",
    "payment_type": "<string>",
    "publish_status": "<string>",
    "is_free": true,
    "approved": true,
    "sku": "<string>",
    "recurrence_interval": "<string>",
    "recurrence_interval_count": 123,
    "trial_days": 123,
    "category_id": 123,
    "language_id": 123,
    "image": "<string>",
    "image_url": "<string>",
    "delivery": "<string>",
    "deliverable_content": "<string>",
    "attachment_url": "<string>",
    "landing_page": "<string>",
    "support_email": "<string>",
    "author": "<string>",
    "warranty_time": 123,
    "shipping_cost": "<string>",
    "is_encapsulated": true,
    "convert_currency": true,
    "has_speed_recovery": true
  }
}

{
  "status": "error",
  "error": "unauthenticated"
}

{
  "status": "error",
  "error": "insufficient_scope"
}

{
  "status": "error",
  "error": "idempotency_in_progress"
}

{
  "message": "<string>",
  "errors": {}
}

POST

public

products

Criar produto

curl --request POST \
  --url https://api.speedsellx.io/v2/public/products \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "image": "<string>",
  "category_id": 2,
  "language_id": 2,
  "price": 1,
  "is_free": true,
  "convert_currency": true,
  "is_encapsulated": true,
  "has_speed_recovery": true,
  "attachment_url": "<string>",
  "landing_page": "<string>",
  "support_email": "jsmith@example.com",
  "author": "<string>",
  "shipping_cost": 1,
  "sku": "<string>",
  "deliverable_content": "<string>"
}
'

import requests

url = "https://api.speedsellx.io/v2/public/products"

payload = {
    "name": "<string>",
    "description": "<string>",
    "image": "<string>",
    "category_id": 2,
    "language_id": 2,
    "price": 1,
    "is_free": True,
    "convert_currency": True,
    "is_encapsulated": True,
    "has_speed_recovery": True,
    "attachment_url": "<string>",
    "landing_page": "<string>",
    "support_email": "jsmith@example.com",
    "author": "<string>",
    "shipping_cost": 1,
    "sku": "<string>",
    "deliverable_content": "<string>"
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    image: '<string>',
    category_id: 2,
    language_id: 2,
    price: 1,
    is_free: true,
    convert_currency: true,
    is_encapsulated: true,
    has_speed_recovery: true,
    attachment_url: '<string>',
    landing_page: '<string>',
    support_email: 'jsmith@example.com',
    author: '<string>',
    shipping_cost: 1,
    sku: '<string>',
    deliverable_content: '<string>'
  })
};

fetch('https://api.speedsellx.io/v2/public/products', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.speedsellx.io/v2/public/products",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'description' => '<string>',
    'image' => '<string>',
    'category_id' => 2,
    'language_id' => 2,
    'price' => 1,
    'is_free' => true,
    'convert_currency' => true,
    'is_encapsulated' => true,
    'has_speed_recovery' => true,
    'attachment_url' => '<string>',
    'landing_page' => '<string>',
    'support_email' => 'jsmith@example.com',
    'author' => '<string>',
    'shipping_cost' => 1,
    'sku' => '<string>',
    'deliverable_content' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.speedsellx.io/v2/public/products"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"image\": \"<string>\",\n  \"category_id\": 2,\n  \"language_id\": 2,\n  \"price\": 1,\n  \"is_free\": true,\n  \"convert_currency\": true,\n  \"is_encapsulated\": true,\n  \"has_speed_recovery\": true,\n  \"attachment_url\": \"<string>\",\n  \"landing_page\": \"<string>\",\n  \"support_email\": \"jsmith@example.com\",\n  \"author\": \"<string>\",\n  \"shipping_cost\": 1,\n  \"sku\": \"<string>\",\n  \"deliverable_content\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.speedsellx.io/v2/public/products")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"image\": \"<string>\",\n  \"category_id\": 2,\n  \"language_id\": 2,\n  \"price\": 1,\n  \"is_free\": true,\n  \"convert_currency\": true,\n  \"is_encapsulated\": true,\n  \"has_speed_recovery\": true,\n  \"attachment_url\": \"<string>\",\n  \"landing_page\": \"<string>\",\n  \"support_email\": \"jsmith@example.com\",\n  \"author\": \"<string>\",\n  \"shipping_cost\": 1,\n  \"sku\": \"<string>\",\n  \"deliverable_content\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.speedsellx.io/v2/public/products")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"image\": \"<string>\",\n  \"category_id\": 2,\n  \"language_id\": 2,\n  \"price\": 1,\n  \"is_free\": true,\n  \"convert_currency\": true,\n  \"is_encapsulated\": true,\n  \"has_speed_recovery\": true,\n  \"attachment_url\": \"<string>\",\n  \"landing_page\": \"<string>\",\n  \"support_email\": \"jsmith@example.com\",\n  \"author\": \"<string>\",\n  \"shipping_cost\": 1,\n  \"sku\": \"<string>\",\n  \"deliverable_content\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": 123,
    "seller_id": 123,
    "name": "<string>",
    "description": "<string>",
    "price": "<string>",
    "currency": "<string>",
    "type": "<string>",
    "payment_type": "<string>",
    "publish_status": "<string>",
    "is_free": true,
    "approved": true,
    "sku": "<string>",
    "recurrence_interval": "<string>",
    "recurrence_interval_count": 123,
    "trial_days": 123,
    "category_id": 123,
    "language_id": 123,
    "image": "<string>",
    "image_url": "<string>",
    "delivery": "<string>",
    "deliverable_content": "<string>",
    "attachment_url": "<string>",
    "landing_page": "<string>",
    "support_email": "<string>",
    "author": "<string>",
    "warranty_time": 123,
    "shipping_cost": "<string>",
    "is_encapsulated": true,
    "convert_currency": true,
    "has_speed_recovery": true
  }
}

{
  "status": "error",
  "error": "unauthenticated"
}

{
  "status": "error",
  "error": "insufficient_scope"
}

{
  "status": "error",
  "error": "idempotency_in_progress"
}

{
  "message": "<string>",
  "errors": {}
}

Requer o escopo products:write e o header HTTP Idempotency-Key (veja Idempotência). Responde 201. O produto nasce com approved: false e um pedido de moderação pendente, exatamente como um produto criado pelo painel. Um checkout inicial é criado logo em seguida, em segundo plano.

image aceita um data URI base64 (data:image/png;base64,...) ou um caminho já gravado no storage, devolvido como veio. Uma URL externa não é baixada.

sku, trial_days e deliverable_content podem ser definidos aqui. A API antiga não aceitava nenhum dos três, embora respondesse os três na leitura.Flags de meio de pagamento no corpo do produto não são aceitas e derrubam a requisição com 422. Os meios de pagamento são configuração do checkout.

Authorizations

Authorization

string

header

required

A chave de API da conta, no formato sk_{modo}_{prefixo}.{segredo}.

Headers

Idempotency-Key

string

required

Chave única da operação. Obrigatória em toda requisição que altera dados; sem ela a resposta é 422 idempotency_key_required. Um reenvio com a mesma chave e o mesmo corpo repete a resposta guardada.

Maximum string length: 255

Body

application/json

Body of POST /v2/public/products. The rules and the extraction are the shared ones; creation adds nothing of its own, which is why this class is empty.

name

string

required

Maximum string length: 255

description

string

required

Maximum string length: 255

image

string

required

Either a base64 data URI (uploaded to storage) or an already stored path echoed back. Which one it is, is Catalog's decision.

category_id

integer

required

Required range: x >= 1

language_id

integer

required

Required range: x >= 1

payment_type

enum<string>

required

Available options:

unique,

recurring

price

number

required

Required range: x >= 0

currency

enum<string>

required

Available options:

brl,

usd,

eur

type

enum<string>

required

Available options:

physical,

digital

publish_status

enum<string>

required

Available options:

draft,

published

delivery

enum<string>

required

Available options:

nothing,

memberkit,

cademi,

rocketmember,

astronmembers,

download,

external

warranty_time

enum<integer>

required

Available options:

7,

14,

21,

30

recurrence_interval

enum<string> | null

Available options:

daily,

weekly,

fortnightly,

monthly,

twomonthly,

quarterly,

semiannual,

yearly,

null

is_free

boolean

convert_currency

boolean

is_encapsulated

boolean

has_speed_recovery

boolean

attachment_url

string<uri> | null

Maximum string length: 255

landing_page

string<uri> | null

Maximum string length: 255

support_email

string<email> | null

Maximum string length: 255

author

string | null

Maximum string length: 255

shipping_cost

number | null

Required range: x >= 0

sku

string | null

Three fields the source api never accepted, added because the read answers them: a product created here would otherwise come back with a sku, a trial and a deliverable the caller had no way to set.

Maximum string length: 255

trial_days

enum<integer> | null

Available options:

3,

7,

14,

30,

null

deliverable_content

string | null

Response

ApiProductResource

data

ApiProductResource · object

required

Show child attributes

Introdução

Quickstart

Guias

Receitas

Produtos

Pedidos

Reembolsos

Chargebacks

Checkouts

Upsells

Métricas

Vendas

Assinaturas

Webhooks

Outros

Chargebacks

Checkouts

Métricas

Pedidos

Ping

Produtos

Reembolsos

Vendas

Assinaturas

Upsells

Webhooks

Criar produto

Authorizations

Headers

Body

Response