Sube la boleta o factura del pedido

POST

/orders/{ref}/document

Sube (o reemplaza) el documento tributario del pedido: archivo, folio y fecha de
emisión. Vale para cualquier pedido de la florería (también los del marketplace,
que lo necesitan para liquidarse), no solo los creados por API. El tipo de documento
es el document_type del pedido, salvo que mandes document_type para corregirlo.

Body multipart/form-data (no JSON). El folio no puede repetirse en otro pedido de
la florería con el mismo tipo de documento (409 duplicate_document, con order_id
del pedido que ya lo tiene). Redfloral revisa el documento con IA en segundo plano:
la respuesta trae document.validation = pending y el resultado aparece después en
GET /orders/{ref}. El cliente recibe el documento por email si mandas
notify_customer=true, o si no lo mandas y la key tiene las notificaciones activadas. No exige la venta local habilitada (orders_write_disabled
no aplica).

Autorizaciones

bearerAuth

API key de la florería, con formato rf_live_<prefix>_<secreto>. Se entrega una sola
vez; se envía en cada solicitud como Authorization: Bearer <key>.

Tipo

HTTP (bearer)

Parámetros

Path Parameters

ref*

Id numérico del pedido, o ext:<external_id> (solo pedidos creados por API).

Tipo

string

Requerido

Ejemplos

"70123"

Cuerpo de la petición

multipart/form-data

PDF, JPG o PNG, hasta 10 MB.

Formato"binary"

Folio del documento.

Longitud máx.64

Fecha de emisión.

Formato"date"

Opcional. Cambia el document_type del pedido al del documento que subes; sin él, no cambia.

Valores válidos"boleta""factura"

Opcional. true envía el documento por email al cliente y false no, solo en esta subida. Sin él rige la configuración de la key.

Respuestas

Documento guardado; pedido actualizado.

Content-Type

application/json

{

  

"error": false,

  

"order": {

  

  

"id": 0,

  

  

"external_id": "string",

  

  

"external_url": "string",

  

  

"status": {

  

  

  

"slug": "string",

  

  

  

"name": "string"

  

  

},

  

  

"is_internal": true,

  

  

"created_by_api": true,

  

  

"secure_key": "string",

  

  

"status_url": "string",

  

  

"shipping_date": "string",

  

  

"schedule_id": 0,

  

  

"schedule_text": "string",

  

  

"zone_id": 0,

  

  

"zone_text": "string",

  

  

"customer": {

  

  

  

"name": "string",

  

  

  

"email": "string",

  

  

  

"phone_code": "string",

  

  

  

"phone": "string"

  

  

},

  

  

"address": {

  

  

  

"type": "string",

  

  

  

"name": "string",

  

  

  

"street": "string",

  

  

  

"street_number": "string",

  

  

  

"more_info": "string",

  

  

  

"phone": "string",

  

  

  

"latitude": 0,

  

  

  

"longitude": 0

  

  

},

  

  

"card_message": "string",

  

  

"anonymous": true,

  

  

"total_products": 0,

  

  

"total_shipping": 0,

  

  

"total_discount": 0,

  

  

"total": 0,

  

  

"delivered_at": "string",

  

  

"created_at": "string",

  

  

"updated_at": "string",

  

  

"warnings": [

  

  

  

{

  

  

  

  

"code": "string",

  

  

  

  

"message": "string",

  

  

  

  

"reason": "string"

  

  

  

}

  

  

],

  

  

"url_photo": "string",

  

  

"photos": {

  

  

  

"xs": "string",

  

  

  

"md": "string",

  

  

  

"lg": "string"

  

  

},

  

  

"products": [

  

  

  

{

  

  

  

  

"id": 0,

  

  

  

  

"product_id": 0,

  

  

  

  

"variant_id": 0,

  

  

  

  

"shared": true,

  

  

  

  

"name": "string",

  

  

  

  

"quantity": 0,

  

  

  

  

"price": 0,

  

  

  

  

"note": "string",

  

  

  

  

"options": [

  

  

  

  

  

{

  

  

  

  

  

  

"id": 0,

  

  

  

  

  

  

"name": "string",

  

  

  

  

  

  

"quantity": 0,

  

  

  

  

  

  

"price": 0

  

  

  

  

  

}

  

  

  

  

]

  

  

  

}

  

  

],

  

  

"history": [

  

  

  

{

  

  

  

  

"status": "string",

  

  

  

  

"status_name": "string",

  

  

  

  

"message": "string",

  

  

  

  

"created_at": "string"

  

  

  

}

  

  

],

  

  

"document_type": "string",

  

  

"document": {

  

  

  

"number": "string",

  

  

  

"date": "string",

  

  

  

"file_url": "string",

  

  

  

"page_url": "string",

  

  

  

"validation": "string"

  

  

}

  

}

}

POST

/orders/{ref}/document

Ejemplos