Agregar o modificar Pedidos
Endpoint
Método: POST
URL: http://api.datacrush.la/ecommerce/v1/order/add
Parámetros de consulta
| Parámetro |
Tipo |
Descripción |
| portal_id |
integer |
Identificador único del portal. Requerido. |
| api_key |
string |
Clave de autenticación de la API. Requerido. |
Cuerpo de la solicitud
La solicitud debe enviarse en formato JSON y debe contener un array de objetos de pedido.
Estructura del JSON (ejemplo)
[
{
"id": 1,
"order_number": 987,
"status": "processed",
"currency_code": "ars",
"gateway": "mercadopago",
"total": 999,
"discount_total": 0,
"shipping_total": 10,
"tax_total": 10,
"admin_url": null,
"financial_status": "paid",
"source": "",
"created_at": "2025-01-01",
"items": [
{
"id": 1,
"product_id": 10,
"variant_id": 10,
"quantity": 1,
"name": "Bolígrafo",
"price": 10
}
],
"customer": {
"id": 1,
"email": "user@mail.com",
"first_name": "Juan",
"last_name": "Martinez",
"source": ""
}
}
]
Campos del cuerpo de la solicitud
| Campo |
Tipo |
Descripción |
| id |
integer |
Identificador único del pedido. |
| order_number |
integer |
Número de orden asignado al pedido. |
| status |
string |
Estado del pedido (pending, processed, shipped, etc.). |
| currency_code |
string |
Código de moneda en formato ISO 4217 (Ej: ars, usd). |
| gateway |
string |
Método de pago utilizado (Ej: mercadopago, paypal). |
| total |
float |
Monto total del pedido. |
| discount_total |
float |
Total de descuentos aplicados. |
| shipping_total |
float |
Costo del envío. |
| tax_total |
float |
Total de impuestos aplicados. |
| admin_url |
string |
URL de administración del pedido (puede ser null). |
| financial_status |
string |
Estado financiero del pedido (paid, pending, etc.). |
| source |
string |
Fuente de origen del pedido (Ej: online_store, mobile_app). |
| created_at |
string |
Fecha de creación del pedido en formato YYYY-MM-DD. |
Campos dentro de items
| Campo |
Tipo |
Descripción |
| id |
integer |
Identificador único del ítem en la orden. |
| product_id |
integer |
Identificador del producto comprado. |
| variant_id |
integer |
Identificador de la variante del producto. |
| quantity |
integer |
Cantidad de unidades compradas. |
| name |
string |
Nombre del producto. |
| price |
float |
Precio unitario del producto. |
Campos dentro de customer
| Campo |
Tipo |
Descripción |
| id |
integer |
Identificador único del cliente. |
| email |
string |
Correo electrónico del cliente. |
| first_name |
string |
Nombre del cliente. |
| last_name |
string |
Apellido del cliente. |
| source |
string |
Fuente de origen del cliente (Ej: website, facebook). |
Respuesta
Respuesta exitosa
{
"result": "success"
}
Respuestas de error
Los errores se devuelven en el siguiente formato:
{
"result": "fail",
"error": {
"code": 210,
"message": "Error al decodificar JSON"
},
"error_list": []
}
| Código interno |
Mensaje de error |
Descripción |
| 210 |
"Error al decodificar JSON" |
El formato del JSON enviado es inválido. |
| 401 |
"No autorizado" |
Falta la clave de la API o es incorrecta. |
| 403 |
"Acceso denegado" |
El usuario no tiene permisos para esta operación. |
| 500 |
"Error interno del servidor" |
Ocurrió un error inesperado en el servidor. |
Notas
- La clave api_key es obligatoria para la autenticación.
- Si el id del pedido ya existe, se actualizarán sus datos.
- Cada pedido debe contener al menos un item.
- Para evitar errores de código 210, asegúrate de enviar el JSON con la estructura correcta.
Comentarios
0 comentarios
El artículo está cerrado para comentarios.