orders

Route:

Method	Path
DELETE	/orders

Elimina una orden

Authentication

Requiere token de autenticación

Route Parameters:

Name	Type	Description
:orderId	String	id del producto

Response:

Name	Type	Attributes	Description
order	Object
order._id	String		Id
order.userId	String		Id usuaria que creó la orden
order.client	String		Clienta para quien se creó la orden
order.products	Array		Productos
order.products[	Object		Producto
order.products[].qty	Number		Cantidad
order.products[].product	Object		Producto
order.status	String		Estado: `pending`, `canceled`, `delivering` o `delivered`
order.dateEntry	Date		Fecha de creación
order.dateProcessed	Date	optional	Fecha de cambio de `status` a `delivered`

Response Code:

Type	Description
200	si la autenticación es correcta
401	si no hay cabecera de autenticación
404	si el producto con `orderId` indicado no existe

Route:

Method	Path
GET	/orders

Lista órdenes

Authentication

Requiere token de autenticación

Header Parameters:

Name	Type	Description
link	Object	Parámetros de paginación
link.first	String	Link a la primera página
link.prev	String	Link a la página anterior
link.next	String	Link a la página siguiente
link.last	String	Link a la última página

Query Parameters:

Name	Type	Attributes	Default	Description
page	String	optional	1	Página del listado a consultar
limit	String	optional	10	Cantitad de elementos por página

Response:

Name	Type	Attributes	Description
orders	Array
orders[]._id	String		Id
orders[].userId	String		Id usuaria que creó la orden
orders[].client	String		Clienta para quien se creó la orden
orders[].products	Array		Productos
orders[].products[	Object		Producto
orders[].products[].qty	Number		Cantidad
orders[].products[].product	Object		Producto
orders[].status	String		Estado: `pending`, `canceled`, `delivering` o `delivered`
orders[].dateEntry	Date		Fecha de creación
orders[].dateProcessed	Date	optional	Fecha de cambio de `status` a `delivered`

Response Code:

Type	Description
200	si la autenticación es correcta
401	si no hay cabecera de autenticación

Route:

Method	Path
GET	/orders/:orderId

Obtiene los datos de una orden especifico

Authentication

Requiere token de autenticación

Route Parameters:

Name	Type	Description
:orderId	String	id de la orden a consultar

Response:

Name	Type	Attributes	Description
order	Object
order._id	String		Id
order.userId	String		Id usuaria que creó la orden
order.client	String		Clienta para quien se creó la orden
order.products	Array		Productos
order.products[	Object		Producto
order.products[].qty	Number		Cantidad
order.products[].product	Object		Producto
order.status	String		Estado: `pending`, `canceled`, `delivering` o `delivered`
order.dateEntry	Date		Fecha de creación
order.dateProcessed	Date	optional	Fecha de cambio de `status` a `delivered`

Response Code:

Type	Description
200	si la autenticación es correcta
401	si no hay cabecera de autenticación
404	si la orden con `orderId` indicado no existe

Route:

Method	Path
POST	/orders

Crea una nueva orden

Authentication

Requiere token de autenticación

Body Parameters:

Name	Type	Description
userId	String	Id usuaria que creó la orden
client	String	Clienta para quien se creó la orden
products	Array	Productos
products[	Object	Producto
products[].productId	String	Id de un producto
products[].qty	Number	Cantidad de ese producto en la orden

Response:

Name	Type	Attributes	Description
order	Object
order._id	String		Id
order.userId	String		Id usuaria que creó la orden
order.client	String		Clienta para quien se creó la orden
order.products	Array		Productos
order.products[	Object		Producto
order.products[].qty	Number		Cantidad
order.products[].product	Object		Producto
order.status	String		Estado: `pending`, `canceled`, `delivering` o `delivered`
order.dateEntry	Date		Fecha de creación
order.dateProcessed	Date	optional	Fecha de cambio de `status` a `delivered`

Response Code:

Type	Description
200	si la autenticación es correcta
400	no se indica `userId` o se intenta crear una orden sin productos
401	si no hay cabecera de autenticación

Route:

Method	Path
PUT	/products

Modifica una orden

Authentication

Requiere token de autenticación

Body Parameters:

Name	Type	Attributes	Description
userId	String	optional	Id usuaria que creó la orden
client	String	optional	Clienta para quien se creó la orden
products	Array	optional	Productos
products[	Object		Producto
products[].productId	String		Id de un producto
products[].qty	Number		Cantidad de ese producto en la orden
status	String	optional	Estado: `pending`, `canceled`, `delivering` o `delivered`

Route Parameters:

Name	Type	Description
:orderId	String	id de la orden

Response:

Name	Type	Attributes	Description
order	Object
order._id	String		Id
order.userId	String		Id usuaria que creó la orden
order.products	Array		Productos
order.products[	Object		Producto
order.products[].qty	Number		Cantidad
order.products[].product	Object		Producto
order.status	String		Estado: `pending`, `canceled`, `delivering` o `delivered`
order.dateEntry	Date		Fecha de creación
order.dateProcessed	Date	optional	Fecha de cambio de `status` a `delivered`

Response Code:

Type	Description
200	si la autenticación es correcta
400	si no se indican ninguna propiedad a modificar o la propiedad `status` no es valida
401	si no hay cabecera de autenticación
404	si la orderId con `orderId` indicado no existe