Skip to main content
GET
/
product
/
id
/
{id}
Get product of a company by id
curl --request GET \
  --url https://api.rivoopay.com/product/id/{id} \
  --header 'X-API-KEY: <api-key>'
{
  "id": "prod_01F4Z8Z5Y6X7W8V9U0T1S2R3Q4",
  "name": "Produto Bola",
  "description": "Produto muito bom para uso diário",
  "price": 1990,
  "needShipping": false,
  "companyId": "f96a489c-8a4d-4c7b-a1f6-347acbd832df",
  "status": "ACTIVE",
  "sku": "SKU-ABCD-123",
  "imageUrl": "https://example.com/image.png",
  "categories": [
    "Eletronicos e Tecnologia",
    "Celulares e Smartphones"
  ],
  "marketplaceStatus": "INACTIVE",
  "dayDue": 4,
  "dayGenerateCharge": 14.5
}

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
id
string
required

The ID of the product

Response

200 - application/json

Product of a company by id in App

​
id
string
required

Product identifier

Maximum string length: 255
Example:

"prod_01F4Z8Z5Y6X7W8V9U0T1S2R3Q4"

​
name
string
required

Product name

Maximum string length: 255
Example:

"Produto Bola"

​
description
string
required

Product description

Example:

"Produto muito bom para uso diário"

​
price
number
required

Product price in cents (centavos)

Required range: x >= 0
Example:

1990

​
needShipping
boolean
default:false
required

Indicates if the product requires shipping

Example:

false

​
companyId
string<uuid>
required

Company ID that owns this product

Example:

"f96a489c-8a4d-4c7b-a1f6-347acbd832df"

​
status
enum<string>
default:ACTIVE
required

Product status

Available options:
ACTIVE,
INACTIVE
Example:

"ACTIVE"

​
sku
string | null

Stock Keeping Unit - unique identifier for inventory management

Example:

"SKU-ABCD-123"

​
imageUrl
string<uri> | null

URL of the product image

Example:

"https://example.com/image.png"

​
categories
enum<string>[]

Product categories

Available options:
Jogos,
Eletrônicos,
Roupas,
Acessórios,
Casa e Decoração,
Esportes,
Brinquedos,
UGC,
Cursos,
Serviços,
Livros,
E-books,
Música,
Filmes e Séries,
Alimentos e Bebidas,
SaaS,
Outros
Example:
[
  "Eletronicos e Tecnologia",
  "Celulares e Smartphones"
]
​
marketplaceStatus
enum<string>
default:INACTIVE

Marketplace status

Available options:
APPROVED,
ANALYSIS,
DECLINED,
INACTIVE
Example:

"INACTIVE"

​
type
enum<string>
Available options:
ONE_TIME,
RECURRING
​
frequency
enum<string>

Obrigatório quando type=RECURRING

Available options:
WEEKLY,
MONTHLY,
SEMIANNUAL,
ANNUAL
​
dayDue
number

Prazo de pagamento em dias após a geração (1-7)

Required range: 1 <= x <= 7
​
dayGenerateCharge
number

Dia de geração da cobr (1-28)

Required range: 1 <= x <= 28