Saltar al contenido principal
API docs by Redocly

Documentación API Velocity

Download OpenAPI specification:Download

Introducción

El API de velocity te permite acceder a los datos de la plataforma de velocity.

Autenticación

Los endpoints de la API requieren autenticación. Para obtener un token de acceso, se debe de solicitar a velocity. El token de acceso se debe enviar en el header X-Velocity-Access-Token de la siguiente manera:

X-Velocity-Access-Token: <token>

Webhooks

creación de webhook

Se pueden configurar webhooks para recibir notificaciones de eventos en la plataforma de velocity. Para crear un webhook se debe de enviar un POST a la ruta /webhooks con el siguiente payload:

{
  "url": "https://mi-servidor.com/webhook",
  "topic": "order.created"
}

Revisa la sección de webhooks para ver las operaciones soportadas.

Tipos de eventos soportados (topics)

  • inventory.updated
  • order.status_updated
  • product.updated

Evento de actualización de inventario

Cuando se actualiza el inventario de un producto, se envía una petición POST al webhook configurado con el siguiente payload:

{
  "business_id": "id",  
  "product_id": "id",
  "sku": "sku",
  "quantity": 10,
  "warehouse_id": 1,
  "total_inventory": 100, // total de inventario en todas las bodegas
  "movement_id": 1, // id del movimiento
  "movement_order_id": "order_id", // id de la orden relacionada al movimiento si aplica
  "action": "in", // in | out
  "inventory_per_warehouse": [
    {
      "warehouse_id": 1,
      "quantity": 10
    }
  ]
}

Evento de actualización de estado de orden

Cuando se actualiza el estado de una orden, se envía una petición POST al webhook configurado con el payload de la orden. (se enviara el mismo objeto que se obtiene al consultar una orden)

Órdenes de Recibo

Obtener Órdenes de Recibo

Permite obtener órdenes de recibo filtradas por estado y rango de fechas.

query Parameters
status
Array of integers
Example: status=1&status=2&status=4

Estado de las órdenes de recibo (puede repetirse para múltiples estados)

start_date
string <date-time>
Example: start_date=2022-01-01T00:00:00Z

Fecha de inicio del rango (formato ISO 8601)

end_date
string <date-time>
Example: end_date=2022-12-01T00:00:00Z

Fecha de fin del rango (formato ISO 8601)

Responses

Request samples 

curl -G '$BASE_URL/purchase-external-orders/' --data-urlencode 'status=1' --data-urlencode 'status=2' --data-urlencode 'start_date=2022-01-01T00:00:00Z' --data-urlencode 'end_date=2022-12-01T00:00:00Z'

Response samples

Content type
application/json
[
  • {
    }
]

Estados Ordenes de Recibo

Permite obtener la lista de razones de retorno disponibles para órdenes externas.

Authorizations:
None

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Crear Órden de Recibo

Permite crear una orden de recibo.

Request Body schema: application/json
required
Array of objects

Lista de almacenes con los artículos

Array
warehouse_id
required
integer

ID del almacén

required
Array of objects

Lista de artículos en el almacén

Responses

Request samples

Content type
application/json
{
  • "warehouses": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Obtener Razones de Devolución en Ordenes

Permite obtener la lista de razones de devolución de órdenes de compra.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Obtener Órdenes en devolucion

Permite obtener la lista de órdenes externas que han sido devueltas.

Authorizations:
None
query Parameters
orderNumber
string

Número de la orden para obtener una orden específica en devolución

Responses

Request samples 

curl -G '$BASE_URL/purchase-external-order/return-order' --data-urlencode 'orderNumber=UTXKAF'

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Businesses

Lista sellers

Retorna la lista de sellers. (Solo aplicable para operadores)

query Parameters
page
integer

Page number

size
integer

Page size

filters
Array of any or null (FiltersRaw)

filter query

sort_by
string

sort by field

sort_dir
string
Enum: "ASC" "DESC"

sort direction

skip_total
boolean

skip total count, can be used for performance

Responses

Request samples 

curl -G '$BASE_URL/businesses' --data-urlencode 'page=1' --data-urlencode 'size=50'

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "page": 0,
  • "size": 0,
  • "total": 0,
  • "total_pages": 0
}

Obtener seller

Retorna un seller. (Solo aplicable para operadores)

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "a_threshold": null,
  • "active": true,
  • "assign_pickers": null,
  • "automatic_guide": 0,
  • "automatic_purchase_order": null,
  • "automatic_warehouse_assigment": null,
  • "b_threshold": null,
  • "c_threshold": null,
  • "calc_discount_after_tax": true,
  • "country_id": null,
  • "created_at": null,
  • "delivery_courier_margin": null,
  • "delivery_fee": null,
  • "document_type_id": null,
  • "documents": [
    ],
  • "driver_scan_packages": null,
  • "email": null,
  • "email_contact_accounting": null,
  • "external_id": null,
  • "external_id_help": null,
  • "external_integration_id": null,
  • "external_integrations": [
    ],
  • "id": null,
  • "invoice_status_id": null,
  • "invoicing": true,
  • "is_package_type_delivery": true,
  • "is_partner": null,
  • "is_picking_cases_enabled": null,
  • "is_saas": null,
  • "is_signed_commercial_agreement": null,
  • "kam_user_id": null,
  • "legal_id": "string",
  • "legal_name": null,
  • "name": "string",
  • "only_last_mile": true,
  • "own_inventory": null,
  • "parent_business_id": null,
  • "percentage_inventory_notice_variation": null,
  • "phone_number": null,
  • "prefix": null,
  • "project_channel": null,
  • "provider_service_id": null,
  • "route_validation": null,
  • "scan_products": null,
  • "sequence": null,
  • "shipment_included_total": null,
  • "shipping_best_price": null,
  • "show_basket": null,
  • "show_massive_quantity": null,
  • "show_note": null,
  • "show_note_app": null,
  • "show_note_ok": null,
  • "show_type_zone": true,
  • "sms_notification": null,
  • "super": null,
  • "take_manual_order": null,
  • "tax_before_total": null,
  • "telegram_chat": null,
  • "updated_at": null,
  • "variation_percentage": null,
  • "wallet_amount": 0,
  • "warehouses": [
    ]
}

Inventario

Crear movimiento de inventario

Crea un movimiento de inventario.

Request Body schema: application/json
business_id
string
product_id
string
quantity
integer
reason
null or string
warehouse_id
integer

Responses

Request samples

Content type
application/json
{
  • "business_id": "string",
  • "product_id": "string",
  • "quantity": 0,
  • "reason": null,
  • "warehouse_id": 0
}

Response samples

Content type
application/json
{
  • "code": "invalid_request",
  • "details": { },
  • "message": "invalid request"
}

Obtener stock de un producto

Retorna el stock de un producto.

query Parameters
product_id
string

ID del producto - Busca el producto específico y sus variaciones

external_id
string

ID externo del producto - Busca productos por su ID externo

ean
string

Código EAN o SKU del producto - Busca productos por EAN o SKU

is_full
integer
Enum: 0 1

Filtro de fulfillment - 0: Solo ubicaciones no fulfillment, 1: Solo ubicaciones fulfillment, sin especificar: todas las ubicaciones

Responses

Request samples 

curl -G '$BASE_URL/inventory/stock' --data-urlencode 'product_id=123' --data-urlencode 'is_full=1'

Response samples

Content type
application/json
{
  • "inventory": [
    ],
  • "variations": [
    ]
}

Órdenes

Listar órdenes

query Parameters
page
integer

Page number

size
integer

Page size

filters
Array of any or null (FiltersRaw)

filter query

sort_by
string

sort by field

sort_dir
string
Enum: "ASC" "DESC"

sort direction

skip_total
boolean

skip total count, can be used for performance

Responses

Request samples 

curl -G '$BASE_URL/orders' --data-urlencode 'page=1' --data-urlencode 'size=50' --data-urlencode 'sort_by=created_at' --data-urlencode 'sort_dir=DESC'

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "page": 0,
  • "size": 0,
  • "total": 0,
  • "total_pages": 0
}

Crear orden

Create a new order

Request Body schema: application/json
business_id
null or string

Requerido si el usuario es operador

cod_total
null or number

Valor contra entrega

country_id
null or integer
object
delivery_date
null or string <date-time>

Fecha de entrega en caso de que el envío sea entregado

delivery_provider_id
null or integer

id de la transportadora

discount
null or number

Valor de descuento

external_order_id
null or string

Id externo si aplica

guide_id
null or string

Número de guía de la transportadora

guide_link
null or string

Link de la guía de la transportadora

integration_type_id
null or integer
invoiceable
null or boolean
is_last_mile
null or boolean

Si la orden es de last mile pasara directamente a el estado asignar piloto

Array of objects or null (ServiceProductOrderReq)

Productos de la orden

notes
string
order_type_id
null or integer
object (ServiceShippingInformation)

Información de origen del envío (si aplica)

payment_method_id
null or integer
payment_type_id
null or integer
object (ServiceShippingInformation)

destination shipping information

subtotal
null or number
total
null or number

Valor total de la orden

total_shipment
null or number

Valor del envío

tracking_link
null or string

Link de tracking de la transportadora

warehouse_id
null or integer

Responses

Request samples

Content type
application/json
{
  • "business_id": null,
  • "cod_total": null,
  • "country_id": null,
  • "customer": {
    },
  • "delivery_date": null,
  • "delivery_provider_id": null,
  • "discount": null,
  • "external_order_id": null,
  • "guide_id": null,
  • "guide_link": null,
  • "integration_type_id": null,
  • "invoiceable": null,
  • "is_last_mile": null,
  • "items": [
    ],
  • "notes": "string",
  • "order_type_id": null,
  • "origin_shipping_information": {
    },
  • "payment_method_id": null,
  • "payment_type_id": null,
  • "shipping_information": {
    },
  • "subtotal": null,
  • "total": null,
  • "total_shipment": null,
  • "tracking_link": null,
  • "warehouse_id": null
}

Response samples

Content type
application/json
{
  • "approved": true,
  • "boxes": null,
  • "business": {
    },
  • "business_id": null,
  • "cancel_order_reason": {
    },
  • "cancel_order_reason_id": null,
  • "city_dane_id": null,
  • "cod_total": null,
  • "country": {
    },
  • "country_id": null,
  • "coupon": null,
  • "created_at": null,
  • "customer": {
    },
  • "customer_id": null,
  • "delivery_date": null,
  • "delivery_fee": null,
  • "delivery_kms": null,
  • "delivery_provider": {
    },
  • "delivery_provider_id": null,
  • "delivery_provider_type_zone_id": null,
  • "discount": null,
  • "driver": {
    },
  • "driver_id": null,
  • "end_picking_date": null,
  • "external_order_id": null,
  • "extra_data": null,
  • "guide_id": null,
  • "guide_link": null,
  • "height": null,
  • "history": null,
  • "id": "string",
  • "integration_type": {
    },
  • "integration_type_id": null,
  • "invoiceable": null,
  • "invoices": null,
  • "is_delivery_default": true,
  • "is_last_mile": true,
  • "is_paid": true,
  • "items": [
    ],
  • "large": null,
  • "manifest_printed": true,
  • "next_status": null,
  • "notes": null,
  • "order_number": "string",
  • "order_return_reason": {
    },
  • "order_return_reason_id": null,
  • "order_status": {
    },
  • "order_status_id": null,
  • "order_sticker": null,
  • "order_type": {
    },
  • "order_type_id": null,
  • "origin_shipping_information": {
    },
  • "origin_shipping_information_id": null,
  • "packing_user_id": null,
  • "payment_method": {
    },
  • "payment_method_id": null,
  • "payment_type_id": null,
  • "picking_user_id": null,
  • "pictures": null,
  • "shipping_information": {
    },
  • "shipping_information_id": null,
  • "start_picking_date": null,
  • "subtotal": null,
  • "tags": null,
  • "tax": null,
  • "test": true,
  • "ticket_id": null,
  • "total": null,
  • "total_shipment": null,
  • "tracking_link": null,
  • "tracking_number": null,
  • "tries": null,
  • "updated_at": null,
  • "user_id": null,
  • "warehouse": {
    },
  • "warehouse_id": null,
  • "weight": null,
  • "width": null,
  • "zone_name": {
    },
  • "zone_name_id": null
}

Obtener orden

Retorna una orden.

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "approved": true,
  • "boxes": null,
  • "business": {
    },
  • "business_id": null,
  • "cancel_order_reason": {
    },
  • "cancel_order_reason_id": null,
  • "city_dane_id": null,
  • "cod_total": null,
  • "country": {
    },
  • "country_id": null,
  • "coupon": null,
  • "created_at": null,
  • "customer": {
    },
  • "customer_id": null,
  • "delivery_date": null,
  • "delivery_fee": null,
  • "delivery_kms": null,
  • "delivery_provider": {
    },
  • "delivery_provider_id": null,
  • "delivery_provider_type_zone_id": null,
  • "discount": null,
  • "driver": {
    },
  • "driver_id": null,
  • "end_picking_date": null,
  • "external_order_id": null,
  • "extra_data": null,
  • "guide_id": null,
  • "guide_link": null,
  • "height": null,
  • "history": null,
  • "id": "string",
  • "integration_type": {
    },
  • "integration_type_id": null,
  • "invoiceable": null,
  • "invoices": null,
  • "is_delivery_default": true,
  • "is_last_mile": true,
  • "is_paid": true,
  • "items": [
    ],
  • "large": null,
  • "manifest_printed": true,
  • "next_status": null,
  • "notes": null,
  • "order_number": "string",
  • "order_return_reason": {
    },
  • "order_return_reason_id": null,
  • "order_status": {
    },
  • "order_status_id": null,
  • "order_sticker": null,
  • "order_type": {
    },
  • "order_type_id": null,
  • "origin_shipping_information": {
    },
  • "origin_shipping_information_id": null,
  • "packing_user_id": null,
  • "payment_method": {
    },
  • "payment_method_id": null,
  • "payment_type_id": null,
  • "picking_user_id": null,
  • "pictures": null,
  • "shipping_information": {
    },
  • "shipping_information_id": null,
  • "start_picking_date": null,
  • "subtotal": null,
  • "tags": null,
  • "tax": null,
  • "test": true,
  • "ticket_id": null,
  • "total": null,
  • "total_shipment": null,
  • "tracking_link": null,
  • "tracking_number": null,
  • "tries": null,
  • "updated_at": null,
  • "user_id": null,
  • "warehouse": {
    },
  • "warehouse_id": null,
  • "weight": null,
  • "width": null,
  • "zone_name": {
    },
  • "zone_name_id": null
}

Actualizar orden

Update an order

path Parameters
id
required
string
Request Body schema: application/json
business_id
null or string

Requerido si el usuario es operador

cod_total
null or number

Valor contra entrega

country_id
null or integer
object
delivery_date
null or string <date-time>

Fecha de entrega en caso de que el envío sea entregado

delivery_provider_id
null or integer

id de la transportadora

discount
null or number

Valor de descuento

external_order_id
null or string

Id externo si aplica

guide_id
null or string

Número de guía de la transportadora

guide_link
null or string

Link de la guía de la transportadora

integration_type_id
null or integer
invoiceable
null or boolean
is_last_mile
null or boolean

Si la orden es de last mile pasara directamente a el estado asignar piloto

Array of objects or null (ServiceProductOrderReq)

Productos de la orden

notes
string
order_type_id
null or integer
object (ServiceShippingInformation)

Información de origen del envío (si aplica)

payment_method_id
null or integer
payment_type_id
null or integer
object (ServiceShippingInformation)

destination shipping information

subtotal
null or number
total
null or number

Valor total de la orden

total_shipment
null or number

Valor del envío

tracking_link
null or string

Link de tracking de la transportadora

warehouse_id
null or integer

Responses

Request samples

Content type
application/json
{
  • "business_id": null,
  • "cod_total": null,
  • "country_id": null,
  • "customer": {
    },
  • "delivery_date": null,
  • "delivery_provider_id": null,
  • "discount": null,
  • "external_order_id": null,
  • "guide_id": null,
  • "guide_link": null,
  • "integration_type_id": null,
  • "invoiceable": null,
  • "is_last_mile": null,
  • "items": [
    ],
  • "notes": "string",
  • "order_type_id": null,
  • "origin_shipping_information": {
    },
  • "payment_method_id": null,
  • "payment_type_id": null,
  • "shipping_information": {
    },
  • "subtotal": null,
  • "total": null,
  • "total_shipment": null,
  • "tracking_link": null,
  • "warehouse_id": null
}

Response samples

Content type
application/json
{
  • "approved": true,
  • "boxes": null,
  • "business": {
    },
  • "business_id": null,
  • "cancel_order_reason": {
    },
  • "cancel_order_reason_id": null,
  • "city_dane_id": null,
  • "cod_total": null,
  • "country": {
    },
  • "country_id": null,
  • "coupon": null,
  • "created_at": null,
  • "customer": {
    },
  • "customer_id": null,
  • "delivery_date": null,
  • "delivery_fee": null,
  • "delivery_kms": null,
  • "delivery_provider": {
    },
  • "delivery_provider_id": null,
  • "delivery_provider_type_zone_id": null,
  • "discount": null,
  • "driver": {
    },
  • "driver_id": null,
  • "end_picking_date": null,
  • "external_order_id": null,
  • "extra_data": null,
  • "guide_id": null,
  • "guide_link": null,
  • "height": null,
  • "history": null,
  • "id": "string",
  • "integration_type": {
    },
  • "integration_type_id": null,
  • "invoiceable": null,
  • "invoices": null,
  • "is_delivery_default": true,
  • "is_last_mile": true,
  • "is_paid": true,
  • "items": [
    ],
  • "large": null,
  • "manifest_printed": true,
  • "next_status": null,
  • "notes": null,
  • "order_number": "string",
  • "order_return_reason": {
    },
  • "order_return_reason_id": null,
  • "order_status": {
    },
  • "order_status_id": null,
  • "order_sticker": null,
  • "order_type": {
    },
  • "order_type_id": null,
  • "origin_shipping_information": {
    },
  • "origin_shipping_information_id": null,
  • "packing_user_id": null,
  • "payment_method": {
    },
  • "payment_method_id": null,
  • "payment_type_id": null,
  • "picking_user_id": null,
  • "pictures": null,
  • "shipping_information": {
    },
  • "shipping_information_id": null,
  • "start_picking_date": null,
  • "subtotal": null,
  • "tags": null,
  • "tax": null,
  • "test": true,
  • "ticket_id": null,
  • "total": null,
  • "total_shipment": null,
  • "tracking_link": null,
  • "tracking_number": null,
  • "tries": null,
  • "updated_at": null,
  • "user_id": null,
  • "warehouse": {
    },
  • "warehouse_id": null,
  • "weight": null,
  • "width": null,
  • "zone_name": {
    },
  • "zone_name_id": null
}

Subir guia PDF y numero de guia a una orden

Upload shipping label file to the order

path Parameters
id
required
string
Request Body schema: multipart/form-data
file
Array of strings <binary> (MultipartFileHeader) [ items <binary > ]
guide_id
string

Responses

Response samples

Content type
application/json
{
  • "code": "invalid_request",
  • "details": { },
  • "message": "invalid request"
}

Actualizar estado de orden

Update the order status and validates if the movement is valid

path Parameters
id
required
string
Request Body schema: application/json
driver_id
null or integer
note
null or string
order_return_reason_id
null or integer
order_status_id
integer

Responses

Request samples

Content type
application/json
{
  • "driver_id": null,
  • "note": null,
  • "order_return_reason_id": null,
  • "order_status_id": 0
}

Response samples

Content type
application/json
{
  • "approved": true,
  • "boxes": null,
  • "business": {
    },
  • "business_id": null,
  • "cancel_order_reason": {
    },
  • "cancel_order_reason_id": null,
  • "city_dane_id": null,
  • "cod_total": null,
  • "country": {
    },
  • "country_id": null,
  • "coupon": null,
  • "created_at": null,
  • "customer": {
    },
  • "customer_id": null,
  • "delivery_date": null,
  • "delivery_fee": null,
  • "delivery_kms": null,
  • "delivery_provider": {
    },
  • "delivery_provider_id": null,
  • "delivery_provider_type_zone_id": null,
  • "discount": null,
  • "driver": {
    },
  • "driver_id": null,
  • "end_picking_date": null,
  • "external_order_id": null,
  • "extra_data": null,
  • "guide_id": null,
  • "guide_link": null,
  • "height": null,
  • "history": null,
  • "id": "string",
  • "integration_type": {
    },
  • "integration_type_id": null,
  • "invoiceable": null,
  • "invoices": null,
  • "is_delivery_default": true,
  • "is_last_mile": true,
  • "is_paid": true,
  • "items": [
    ],
  • "large": null,
  • "manifest_printed": true,
  • "next_status": null,
  • "notes": null,
  • "order_number": "string",
  • "order_return_reason": {
    },
  • "order_return_reason_id": null,
  • "order_status": {
    },
  • "order_status_id": null,
  • "order_sticker": null,
  • "order_type": {
    },
  • "order_type_id": null,
  • "origin_shipping_information": {
    },
  • "origin_shipping_information_id": null,
  • "packing_user_id": null,
  • "payment_method": {
    },
  • "payment_method_id": null,
  • "payment_type_id": null,
  • "picking_user_id": null,
  • "pictures": null,
  • "shipping_information": {
    },
  • "shipping_information_id": null,
  • "start_picking_date": null,
  • "subtotal": null,
  • "tags": null,
  • "tax": null,
  • "test": true,
  • "ticket_id": null,
  • "total": null,
  • "total_shipment": null,
  • "tracking_link": null,
  • "tracking_number": null,
  • "tries": null,
  • "updated_at": null,
  • "user_id": null,
  • "warehouse": {
    },
  • "warehouse_id": null,
  • "weight": null,
  • "width": null,
  • "zone_name": {
    },
  • "zone_name_id": null
}

Parametros

Listar razones de cancelación

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Listar zonas de proveedores de entrega

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Listar proveedores de entrega

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Listar tipos de entrega

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Listar métodos de pago

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Listar tipos de pago

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Listar razones de devolución

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Listar estados de orden

Allowed filters:

  • active
  • color
  • final
  • in_progress
  • in_route
  • name
query Parameters
filters
Array of any or null (FiltersRaw)

Responses

Request samples 

curl -G '$BASE_URL/orders/lists/statuses' --data-urlencode 'filters[name]=Entregado'

Response samples

Content type
application/json
[
  • {
    }
]

Productos

Listar productos

Retorna una lista de productos.

query Parameters
page
integer

Page number

size
integer

Page size

sku
string

SKU del producto

ean
string

Código EAN del producto

business_id
string

ID del negocio

created_at_from
string <date>

Fecha de creación desde (YYYY-MM-DD)

created_at_to
string <date>

Fecha de creación hasta (YYYY-MM-DD)

product_id
string

ID del producto

external_id
string

ID externo del producto

sort_by
string

sort by field

sort_dir
string
Enum: "ASC" "DESC"

sort direction

skip_total
boolean

skip total count, can be used for performance

active
string
Enum: "TRUE" "FALSE"
Examples:
  • active=TRUE -
  • active=FALSE -

Producto activo. Valores permitidos: TRUE, FALSE

Responses

Request samples 

curl -G '$BASE_URL/products' --data-urlencode 'active=TRUE' --data-urlencode 'page=1' --data-urlencode 'size=50'

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "page": 0,
  • "size": 0,
  • "total": 0,
  • "total_pages": 0
}

Crear producto

Crea un producto.

Request Body schema: application/json
active
null or boolean
business_id
null or string
cost
null or number
ean
null or string
external_id
null or string
height
null or number
large
null or number
name
null or string
notes
null or string
parent_product_id
null or string
picture_url
null or string
price
null or number
sku
null or string
tax
null or number
warehouses
Array of integers or null
weight
null or number
width
null or number

Responses

Request samples

Content type
application/json
{
  • "active": null,
  • "business_id": null,
  • "cost": null,
  • "ean": null,
  • "external_id": null,
  • "height": null,
  • "large": null,
  • "name": null,
  • "notes": null,
  • "parent_product_id": null,
  • "picture_url": null,
  • "price": null,
  • "sku": null,
  • "tax": null,
  • "warehouses": [
    ],
  • "weight": null,
  • "width": null
}

Response samples

Content type
application/json
{
  • "active": true,
  • "business_id": "string",
  • "cost": null,
  • "created_at": null,
  • "deleted_at": null,
  • "ean": null,
  • "external_id": null,
  • "height": null,
  • "id": "string",
  • "kit": true,
  • "kit_items": [
    ],
  • "large": null,
  • "name": null,
  • "notes": null,
  • "parent_product_id": null,
  • "picture_url": null,
  • "price": null,
  • "sku": null,
  • "tax": null,
  • "updated_at": null,
  • "variations": [
    ],
  • "warehouses": [
    ],
  • "weight": null,
  • "width": null
}

Obtener producto

Retorna un producto.

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "active": true,
  • "business_id": "string",
  • "cost": null,
  • "created_at": null,
  • "deleted_at": null,
  • "ean": null,
  • "external_id": null,
  • "height": null,
  • "id": "string",
  • "kit": true,
  • "kit_items": [
    ],
  • "large": null,
  • "name": null,
  • "notes": null,
  • "parent_product_id": null,
  • "picture_url": null,
  • "price": null,
  • "sku": null,
  • "tax": null,
  • "updated_at": null,
  • "variations": [
    ],
  • "warehouses": [
    ],
  • "weight": null,
  • "width": null
}

Actualizar producto

Actualiza un producto.

path Parameters
id
required
string
Request Body schema: application/json
active
null or boolean
business_id
null or string
cost
null or number
ean
null or string
external_id
null or string
height
null or number
large
null or number
name
null or string
notes
null or string
parent_product_id
null or string
picture_url
null or string
price
null or number
sku
null or string
tax
null or number
warehouses
Array of integers or null
weight
null or number
width
null or number

Responses

Request samples

Content type
application/json
{
  • "active": null,
  • "business_id": null,
  • "cost": null,
  • "ean": null,
  • "external_id": null,
  • "height": null,
  • "large": null,
  • "name": null,
  • "notes": null,
  • "parent_product_id": null,
  • "picture_url": null,
  • "price": null,
  • "sku": null,
  • "tax": null,
  • "warehouses": [
    ],
  • "weight": null,
  • "width": null
}

Response samples

Content type
application/json
{
  • "active": true,
  • "business_id": "string",
  • "cost": null,
  • "created_at": null,
  • "deleted_at": null,
  • "ean": null,
  • "external_id": null,
  • "height": null,
  • "id": "string",
  • "kit": true,
  • "kit_items": [
    ],
  • "large": null,
  • "name": null,
  • "notes": null,
  • "parent_product_id": null,
  • "picture_url": null,
  • "price": null,
  • "sku": null,
  • "tax": null,
  • "updated_at": null,
  • "variations": [
    ],
  • "warehouses": [
    ],
  • "weight": null,
  • "width": null
}

Bodegas

Listar Bodegas

Retorna una lista de bodegas.

query Parameters
page
integer

Page number

size
integer

Page size

filters
Array of any or null (FiltersRaw)

filter query

sort_by
string

sort by field

sort_dir
string
Enum: "ASC" "DESC"

sort direction

skip_total
boolean

skip total count, can be used for performance

Responses

Request samples 

curl -G '$BASE_URL/warehouses' --data-urlencode 'page=1' --data-urlencode 'size=50'

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "page": 0,
  • "size": 0,
  • "total": 0,
  • "total_pages": 0
}

Crear Bodega

Crea una bodega.

Request Body schema: application/json
address
string
address_line
string
allow_orders
boolean
city_dane_id
null or integer
lat
number
lng
number
name
string
zip
null or string

Responses

Request samples

Content type
application/json
{
  • "address": "string",
  • "address_line": "string",
  • "allow_orders": true,
  • "city_dane_id": null,
  • "lat": 0,
  • "lng": 0,
  • "name": "string",
  • "zip": null
}

Response samples

Content type
application/json
{
  • "address": "string",
  • "address_line": "string",
  • "allow_orders": true,
  • "business_id": "string",
  • "city_dane": {
    },
  • "city_dane_id": null,
  • "code_branch": null,
  • "created_at": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "lat": 0,
  • "lng": 0,
  • "name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "zip": null
}

Obtener Bodega

Retorna una bodega.

path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "address": "string",
  • "address_line": "string",
  • "allow_orders": true,
  • "business_id": "string",
  • "city_dane": {
    },
  • "city_dane_id": null,
  • "code_branch": null,
  • "created_at": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "lat": 0,
  • "lng": 0,
  • "name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "zip": null
}

Actualizar Bodega

Actualiza una bodega.

path Parameters
id
required
integer
Request Body schema: application/json
address
string
address_line
string
allow_orders
boolean
city_dane_id
null or integer
lat
number
lng
number
name
string
zip
null or string

Responses

Request samples

Content type
application/json
{
  • "address": "string",
  • "address_line": "string",
  • "allow_orders": true,
  • "city_dane_id": null,
  • "lat": 0,
  • "lng": 0,
  • "name": "string",
  • "zip": null
}

Response samples

Content type
application/json
{
  • "address": "string",
  • "address_line": "string",
  • "allow_orders": true,
  • "business_id": "string",
  • "city_dane": {
    },
  • "city_dane_id": null,
  • "code_branch": null,
  • "created_at": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "lat": 0,
  • "lng": 0,
  • "name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "zip": null
}

Webhooks

Listar webhooks

Retorna una lista de webhooks.

query Parameters
id
integer

ID del webhook

url
string

URL del webhook

topic
string
Enum: "inventory.updated" "order.status_updated" "product.updated"

Tópico/tema del webhook. Valores permitidos: inventory.updated, order.status_updated, product.updated

created_at_from
string
Example: created_at_from=2024-01-01

Fecha de creación desde (formato: YYYY-MM-DD)

created_at_to
string
Example: created_at_to=2024-12-31

Fecha de creación hasta (formato: YYYY-MM-DD)

page
integer

Page number

size
integer

Page size

filters
Array of any or null (FiltersRaw)

filter query

sort_by
string

sort by field

sort_dir
string
Enum: "ASC" "DESC"

sort direction

skip_total
boolean

skip total count, can be used for performance

Responses

Request samples 

curl -G '$BASE_URL/webhooks' --data-urlencode 'topic=inventory.updated' --data-urlencode 'page=1' --data-urlencode 'size=50'

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "page": 0,
  • "size": 0,
  • "total": 0,
  • "total_pages": 0
}

Crear webhook

Crea un webhook.

Request Body schema: application/json
business_id
string

Required in case of operator

topic
string
Enum: "inventory.updated" "order.status_updated" "product.updated"

Tópico/tema del webhook. Valores permitidos: inventory.updated, order.status_updated, product.updated

url
string

Responses

Request samples

Content type
application/json
{
  • "business_id": "string",
  • "topic": "inventory.updated",
  • "url": "string"
}

Response samples

Content type
application/json
{
  • "business_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "secret": "string",
  • "topic": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "url": "string"
}

Obtener webhook

Retorna un webhook.

path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "business_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "secret": "string",
  • "topic": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "url": "string"
}

Eliminar webhook

Elimina un webhook.

path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "code": "invalid_request",
  • "details": { },
  • "message": "invalid request"
}