Skip to content

Retrieve the list of products

GET
/api/productos/
curl --request GET \
--url https://api.koibox.cloud/api/productos/ \
--header 'X-Koibox-Key: <X-Koibox-Key>'
id__in
Array<integer>
categoria__in
Array<integer>
categoria
integer
nombre__icontains
string
precio__lt
integer
precio__gt
integer
precio__gte
integer
precio__lte
integer
precio_online__lt
integer
precio_online__gt
integer
precio_online__gte
integer
precio_online__lte
integer
pedido_minimo__lt
integer
pedido_minimo__gt
integer
pedido_minimo__gte
integer
pedido_minimo__lte
integer
is_uso_interno
boolean
is_disponible_ecommerce
boolean
limit
integer
offset
integer

List of requested products

Media typeapplication/json
object
count
integer
next
One of:
string format: uri
previous
One of:
string format: uri
results
Array
<= 50 items
object
id

Read-only

integer
categoria
required
One of:

Read-only

object
value
integer
text
string
nombre
string
id
integer
orden
One of:
integer
is_active
boolean
proveedor
One of:

Read-only

object
servicios_escandallo
Array<object>

Read-only

object
id

Read-only

integer
created

Read-only

string format: date-time
updated

Read-only

string format: date-time
referencia
required
string
nombre
required
string
detalle
string
precio
string format: double
is_tarifas
boolean
precio_tarifa1
string format: double
precio_tarifa2
string format: double
precio_tarifa3
string format: double
precio_tarifa4
string format: double
duracion
required
string format: time
categoria
One of:

Read-only

object
value
integer
text
string
nombre
string
id
integer
orden
One of:
integer
is_active
boolean
is_active
boolean
users
required
One of:

Read-only

Array<object>
object
value

Identifier of the user

integer
text

Name of the user

string
color
string format: hex
username
string format: email
foto_url_absolute_path
string format: uri
is_disponible_online
boolean
descuento_online
integer
secure_payment_amount
double
productos_escandallo
One of:

Read-only

Array<object>
object
id

Read-only

integer
categoria
required
One of:

Read-only

object
value
integer
text
string
nombre
string
id
integer
orden
One of:
integer
is_active
boolean
proveedor
One of:

Read-only

object
servicios_escandallo
Array<object> recursive
stock
object
existencias
integer
stock_minimo
integer
created
string format: date-time
updated
string format: date-time
barcode
string
<= 30 characters
referencia
string
<= 20 characters
nombre
required
string
<= 100 characters
detalle
string
precio
number
precio_online
number
precio_coste
number
pedido_minimo
integer
is_active
boolean
default: true
is_uso_interno
boolean
is_disponible_ecommerce
boolean
default: true
imagenes
Array<object>
object
name

Name of the file

string
size

File size (in bytes)

integer
type

MIME type of the file

string
opts
object
principal

Indicates if it is the main image of the product

boolean
impuesto
integer
recursos

Read-only

Array<object>
object
value
integer
text
string
impuesto
integer
orden
One of:
integer
tbai_vat_exemption_cause
One of:

Only returned when TicketBAI is active

integer
stock
object
existencias
integer
stock_minimo
integer
created
string format: date-time
updated
string format: date-time
barcode
string
<= 30 characters
referencia
string
<= 20 characters
nombre
required
string
<= 100 characters
detalle
string
precio
number
precio_online
number
precio_coste
number
pedido_minimo
integer
is_active
boolean
default: true
is_uso_interno
boolean
is_disponible_ecommerce
boolean
default: true
imagenes
Array<object>
object
name

Name of the file

string
size

File size (in bytes)

integer
type

MIME type of the file

string
opts
object
principal

Indicates if it is the main image of the product

boolean
impuesto
integer

The access key has not been provided in the X-Koibox-Key header

WWW-Authenticate
string
default: X-Koibox-Key

Indicates the required header for authentication

No valid access key has been provided