Para poder crear una compra en Avify el objeto Order es necesario, es el encargado de generar reducciones en el inventario y también el objeto encargado de permitir un pago.
Haciendo uso del API de ordenes se puede hacer un listado de las órdenes del sistema. Las órdenes se encuentran indentificadas por un id de orden.
id string
Indentificador único de la orden. Este puede ser autogenerado, de nuestro sistema o proveniente de algún canal.
status string
Estado de la orden. Este valor puede encontrarse en posibles valores, pero también podrían existir otros valores dependiendo de las integraciones conectadas.
| Posibles valores | Descripción |
|---|---|
| complete | Cuando la orden ha sido marcada como completada |
| pending | Cuando en la orden no se ha confirmado el pago |
| processing | Cuando la orden tiene pendiente el shipping action o envío. En este estado el pago ya se encuentra confirmado |
| canceled | Cuando la orden no ha sido pagada y es cancelada |
| closed | Cuando la orden ha sido pagada, se hizo el refund y cancelación |
channel string
Canal de ventas utilzado para la orden. Algunos de estos pueden ser:
| avify | Orden originada en el sistema de Avify |
|---|---|
| wordpress | Orden originada en la integración de Wordpress |
| Orden originada en el sistema de Avify con selección de canal Facebook | |
| Orden originada en el sistema de Avify con selección de canal Instagram | |
| Orden originada en el sistema de Avify con selección de canal WhatsApp |
channelPublicId string
Id de la orden proveniente del canal de ventas o de Avify
created Date
Fecha de creación de la orden en formato ISO-8601 String
createdTimestamp string
Fecha de creación de la orden en formato Unix Epoch Timestamp
updated Date
Fecha de actualización de la orden en formato ISO-8601 String
updatedTimestamp string
Fecha de actualización de la orden en formato Unix Epoch Timestamp
details object
Detalle de la orden
avify object
Contiene información relacionada con el sistema de Avify
customer CustomerV1
Cliente asignado a la orden
Ir al CustomerV1
shipping object
Detalle de dirección y entrega asignado a la orden y al customer
billing object
Detalle de facturación asignado a la orden y al customer
discount object
costs object
payment object
notes object
posMode string
Indica si es una orden de tipo POS puede venir vacío o con la palabra “pos” “posOnline”
isPOS boolean
Indica si fué una orden realizada desde el módulo de pos
products object array []
Todos los productos que incluye la orden por el momento este objecto no se encuentra documentado pero pronto estará en su propia hoja de documentación
ProductV1
metadata object| null
Un objeto enviado por el comercio este atributo se mostraría cuando la orden fué realizada por medio del API y se agregaron atributos al objeto puede ser de máximo 100kb.
Los atributos hijos solo pueden ser de los tipos de datos string boolean float o int por ejemplo:
{
...,
"metadata":{
"id":123,
"ticketReference":"4GBSDFG13",
"oldPrice":"300.50",
"wasUpdated":"true"
}
}