###################
List Shipments
###################

Listar Embarques
******************

Obtiene listado de embarques en base a los parámetros enviados.

.. include:: /peticion.rst

Resource URL
============

.. http:get:: HOST/v1/shipments/?created_at_after=(date:created_at_after)&created_at_before=(date:created_at_before)&status=(string:status)

	:param created_at_after: (opcional) Fecha inicial del rango de creación (formato YYYY-MM-DD).
	:type created_at_after: date

	:param created_at_before: (opcional) Fecha final del rango de creación (formato YYYY-MM-DD).
	:type created_at_before: date

	:param status: (opcional) Estado del envío a filtrar. Ej: `CF`.
	:type status: string

	:param page: (opcional) Identificador de la pagina consultada.
	:type page: int

	:param page_size: (opcional) Total de resultados por pagina (por defecto son 100).
	:type page_size: int

	:reqheader Authorization: Token del usuario.
	:reqheader Content-Type: Define el formato en el que se envian los datos por el body.

	:>json int count: Total de resultados obtenidos por la consulta.
	:>json string next: Página siguiente de resultados.
	:>json string previous: Página anterior de resultados.
	:>json obj result: Objeto con resultados de la consulta.

	:statuscode 200: Ningún error.
	:statuscode 400: Algún parámetro es incorrecto.
	:statuscode 401: Token no válido o no enviado.
	:statuscode 404: El recurso no existe.

	**result object**:

	:>json int folio: Folio del embarque.
	:>json string reference_document: Documento de referencia.
	:>json int reference_folio: Folio del documento de referencia.
	:>json string reference_serie: Serie del documento de referencia.
	:>json string status: Clave de estado del embarque.
	:>json date created_at: Fecha de emisión del embarque.


Example request
===============

.. sourcecode:: http

	GET /v1/shipments/?created_at_after=2025-01-01&created_at_before=2025-05-30&status=CF HTTP/1.1
	Host: api.next-cloud.mx
	Accept: application/json
	Content-Type: application/json
	Authorization: Token ( token del usuario )

Example Response
================

.. sourcecode:: http

	HTTP/1.1 200 OK
	Vary: Accept
	Content-Type: application/json
	Allow: GET

.. literalinclude:: example_shipments_01.json
	:language: json