Introducción

La API de Acelérala está construida bajo los estándares de REST. Es decir, nuestra API posee URLs orientada a recursos, y hace uso de los códigos de respuesta HTTP para indicar los posibles errores en el API. Es importante indicar que se encuentra implementada una autenticación HTTP (Bearer Token), solicitada en cada petición. Además, soportamos las solicitudes HTTP de origen cruzado (CORS), permitiendo que tu sitio y Acelérala puedan interactuar de manera segura mediante nuestra API desde una aplicación cliente. Por otro lado, un objeto JSON es retornado en cada una las peticiones hacia el API, incluyendo los errores. Adicionalmente nuestras bibliotecas convierten las respuestas en objetos específicos para cada lenguaje soportado.

Autenticación

Para poder acceder y utilizar la API de Acelérala necesitas previamente registrar un cliente y asignarle los permisos que tendrá. Una vez que esté registrado, obtendrás tus Llaves de Autenticación. Con las llaves podrás solicitar un Token que luego tendrás que incluir en cada petición que hagas al API.

El Token se solicita enviando un POST request al endpoint https://api.acelerala.com/v1/token. Este endpoint recibe autenticación tipo Basic Authenticate. Deberás enviar en el header dos parámetros: Content-Type con el valor application/x-www-form-urlencoded y Authorization con el valor Basic < credenciales > donde las credenciales son el identificador del cliente y la llave privada del cliente cifradas con Base64 de la forma client_id:client_secret. Adicionalmente, en el cuerpo de la petición se debe enviar el parámetro grant_type con el valor client_credentials.

Recuerda enviar los parámetros por HTTPS ya que Basic Authenticate puede ser descifrado para obtener tus credenciales.

Errores

Por medio de nuestra API, podrás ser notificado con toda la información en caso presentes un error al momento de hacer una petición a cualquier operación del API. La API de Acelérala utiliza el estándar de Códigos de Estado HTTP (HTTP Status Codes) en todas sus respuestas para indicar si las solicitudes se pudieron procesar con éxito o fallaron.

Paginación

Todos los recursos principales de Acelérala soportan operaciones de listado, entre ellos ordenes, Productos y Clientes. Adicionalmente, todos los métodos de listado del API comparten una estructura similar tomando en cuenta estos tres parámetros: limit, after y before.

Acelérala utiliza una paginación en tiempo real basada en cursor a través de los parámetros after y before. Un cursor se refiere a un string de caracteres random que marca un ítem específico en una lista de datos. A menos que el ítem sea borrado, el cursor siempre estará punteando la misma parte de la lista, pero será invalidado si el ítem es removido.

En Acelérala, los parámetros after y before toman el valor ID y el valor por el que esté siendo ordenado (por defecto created) retornan los objetos en un orden cronológico reverso. El parámetro before devuelve los objetos creados antes del objeto en cuestión. El parámetro after devuelve los objetos creados después del objeto en cuestión. Si ambos parámetros son provistos sólo after es utilizado.

Adicionalmente, algunos recursos permiten retornar los objetos en otro órden si es que se solicita en la petición. Para esto se debe enviar el parámetro sort e indicar por qué campo se quiere ordenar y en qué dirección serparados por :, por ejemplo sort=created:desc. Los posibles valores para la dirección son asc (ascendientemente) y desc (descendientemente). Los posibles campos para ordenar dependerán de cada recurso y se detallarán en el recurso.

Al listar varios resultados de un recurso, se puede filtrar los resultados para obtener una lista de resultados específicos enviando los campos por los que desea filtrar como parámetros. Se puede filtrar utilizando equivalencias: gt (mayor), lt (menor), gte (mayor o igual), lte (menor o igual), o simplemente colocando el valor buscado (igual), o una serie de valores buscados separados por coma.

Por ejemplo, si quisieramos buscar todos las ordenes con un total entre 1 y 500, y que estén pagadas:

https://api.acelerala.com/v1/orders?total=gt:1,lt:500&payment_status=paid

Webhooks

Utiliza webhooks para recibir notificaciones de eventos que suceden en tu cuenta de Acelérala.

Los webhooks te permiten registrar una URL https:// a donde se enviará data en formato JSON. Algunos casos de uso comunes son

Integrar tu software contable.
Actualizar precios en algún otro sistema.
Recolectar data en un data warehouse.
La orden ha sido pagada en su totalidad.
Los pagos de la orden han sido devueltos parcialmente.
Los pagos de la orden han sido devueltos completamente.

En Acelérala, los eventos son nombrados en base a la familia del recurso, la acción, y en algunos casos, el nombre del cambio que se le dio al recurso. Los nombres están separados por un punto. Al crear un Webhook, puedes suscribirte a más de un evento a la vez con un endpoint. Esta es la lista actual de eventos a los que te puedes suscribir:

orders.created: La orden fue creada con éxito, pero aún no ha sido puesta. Esto significa básicamente que es un "carrito".
orders.created.placed:La orden fue creada y puesta.
orders.updated: La orden ha sido actualizada.
orders.updated.placed: La orden ha sido actualizada y puesta.
orders.updated.canceled: El pago ha sido autorizado por el procesador.
receipts.created: Los pagos de la orden han sido devueltos parcialmente.
receipts.created.accepted: Los pagos de la orden han sido devueltos parcialmente.
receipts.created.rejected: Los pagos de la orden han sido devueltos parcialmente.

Objeto Producto

Atributos

---

id integer

Identificador único del objeto.

---

object string, valor es "product"

Nombre del objeto.

---

store_id integer

Identificador de objeto "store", el proyecto de acelérala al cual le pertenece el comprobante.

---

name string, obligatorio, máximo 100 caracteres

Nombre del producto

---

slug string, obligatorio, autogenerado

Nombre único del producto adaptado para la URL de la tienda

---

description string

Descripción en html del producto. Se utiliza para mostrar en el frontend de la web

---

total_reviews integer, autogenerado

Cantidad de reseñas que tiene el producto

---

average_rating decimal, autogenerado

Promedio de calificación del producto. Las calificaciones pueden tener un valor entre 0 y 100

---

agreements.sale flag

Si el producto se puede comprar.

---

agreements.rent decimal

Si el producto se puede alquilar.

---

bundle flag

Define si un producto es un combo de varios productos o no. Si un producto es un combo, no puede pertenecer a otro combo

---

bundle_min_quantity int

El mínimo de unidades que debe agregarse con el combo de productos

---

bundle_max_quantity int

El máximo de unidades que debe agregarse con el combo de productos. No puede ser menor que el bundle_min_quantity

---

alternatives

Las opciones que tiene el cliente para elegir del producto. Siempre un producto debe de tener al menos una alternativa.

---

bundled_items

Una lista de items que pertenecen al combo en caso el producto sea un combo. Si bundle es falso, estará vacío

---

categories

Arreglo que contiene las categorías a las que el producto está asociado.

---

media

Arreglo que contiene la información de las imágenes o video del producto.

---

created timestamp

La fecha y hora en la que se creo la orden (Formato ISO 8601).

---

modified timestamp

La última fecha y hora en la que se modificó la orden (Formato ISO 8601).

	
{
	"id": 123,
	"object": "product",
	"store_id": 4,
	"name": "Producto de prueba",	
	"slug": "producto-de-prueba",
	"description": "Este es un producto muy bonito que hemos creado para explicar el objeto producto",
	"optn1": "Color",
	"optn2": "Talla",
	"optn3": "",
	"total_reviews": 15,
	"average_rating": 60,
	"agrements": {
		"sale": true,
		"rent": false
	},
	"bundle": true,
	"bundle_min_quantity": 2,
	"bundle_max_quantity": 4,
	"active": true,
	"alternatives": [
		{
			"id": 47691,
			"object": "alternative",
			"product_id": 123,
			"optn1": "Rojo",
			"optn2": "L",
			"optn3": "",
			"sunat_product_code": "LPX123123",			
			"weight": "100",		
			"dimensions": {
				"height": 100,
				"width": 100,
				"length": 100
			},
			"sku": "TESTAPI",
			"availability": [
				""

			],
			"stock": "2",
			"price": "100.00"
		}
	],	
	"bundled_items": [
		{
			"id": 1,	
			"object": "bundled_item",
			"product_id": "123",
			"min_quantity": 0,		
			"max_quantity": 2,			
			"pricing_strategy": "current_price",
			"pricing_strategy_value": null,		
			"product": {
				...
				"alternatives": [ 
					{
						...
					}
				]
			}
			
		},
		{
			"id": 2,	
			"object": "bundled_item",
			"product_id": "123",
			"min_quantity": 1,		
			"max_quantity": 2,			
			"pricing_strategy":  "discount_percentage",
			"pricing_strategy_value": "10",	 
			"product": {
				...
				"alternatives": [ 
					{
						...
					}
				]
			}
		}
	
	],
	"categories": [
		{
			"id": 1,	
			"object": "category",			
			"name": "Polos",		
			"slug": "polos"			
		},
		{
			"id": 2,	
			"object": "category",
			"name": "Promoción verano",	
			"slug": "promocion-verano"
		}
	
	],
	"media": [
		{
			"id": 1,	
			"product_id": "123",
			"url": "https://cdn.acelerala.com/img/123123.jpg",		
			"extension": "jpg",
			"optn1": "Rojo",
			"optn2": "L",
			"optn3": ""			
		},
		{
			"id": 2,	
			"product_id": "123",
			"url": "https://cdn.acelerala.com/img/123123.jpg",		
			"extension": "mp4",
			"optn1": "Azul",
			"optn2": "L",
			"optn3": ""	
		}
	
	],
	"created": "2021-03-29T14:39:08.000Z",
	"modified": "2021-03-29T14:39:35.000Z"	
}
				

---

Listar Productos

GET https://api.acelerala.com/v1/products

---

Permisos:

Requiere el siguiente permiso:
No requiere permisos. El API de productos es público.

Ordenar:

Puedes elegir cualquiera de estos campos para ordenar los pedidos: id,lowest_alternative_price,highest_alternative_price,average_rating,total_sales,max_discount_percentage,max_discount,created,modified.

Ejemplos

Listar productos
GET https://api.acelerala.com/v1/products

Listar 20 productos de una categoría específica
GET https://api.acelerala.com/v1/products?limit=20&category_id=123

Listar productos más vendidos
GET https://api.acelerala.com/v1/products?sort=total_sales:desc

Listar productos disponibles en una tienda específica
GET https://api.acelerala.com/v1/products?location_id=123

Listar productos disponibles entre ciertas fechas y horas
GET https://api.acelerala.com/v1/products?availability=gt:2023-01-10T14:58:14.000Z,lt:2023-01-10T16:58:14.000Z

---

Objeto Orden

Atributos

---

id integer

Identificador único del objeto.

---

object string, valor es "order"

Nombre del objeto.

---

currency_code currency

Código de la moneda en tres letras (Formato ISO 4217).

---

payment_status string

El estado de los pagos asociados a la orden. Solo puede colocarse cuando la orden es creada. Valores válidos:

pending: Pago pendiente. El pago aún puede fallar en este estado. Las ordenes se crean en este estado si es que no se define ningún estado.
authorized: El pago ha sido autorizado por el procesador.
partially_paid: La orden ha sido pagada parcialmente.
paid: La orden ha sido pagada en su totalidad.
partially_refunded: Los pagos de la orden han sido devueltos parcialmente.
refunded: Los pagos de la orden han sido devueltos completamente.
voided: El pago ha sido anulado antes de completarse.

---

payment_terms string

La información acerca del compromiso de pago del cliente al hacer la orden.

---

billing_details string

La información de facturación de la Orden.

---

shipping_address string

La dirección de entrega de la Orden.

---

lines

Los ítems que componen la Orden. Contienen información del Producto como estaba definido al momento en que se creo la Orden. Mostrar atributos

---

discount_applications

Una lista de descuentos aplicados a la Orden.

---

taxes_included boolean

Si es que los precios de los ítems y los totales de la Orden incluyen impuestos o no.

---

lines_total decimal

La sumatoria de todos los lines.total de la orden.

---

global_discounts_total decimal

La suma de los descuentos globales aplicados a la orden. No se consideran descuentos aplicados a las líneas.

---

shipping_discounts_total decimal

La suma de los descuentos aplicados al costo de envío de la orden.

---

subtotal decimal

El total antes de considerar el costo de envío. Se calcula restando global_discounts_total a lines_total.

---

shipping_total decimal

El costo de envío asociado al pedido. Se calcula en base a la configuración de la tienda.

---

total decimal

El total de la orden que pagará el cliente. Se calcula sumando el subtotal y el costo de delivery.

---

note string opcional

Nota opcional que se utiliza para que el cliente o el dueño de la tienda agreguen información al pedido.

---

created timestamp

La fecha y hora en la que se creo la orden (Formato ISO 8601).

---

modified timestamp

La última fecha y hora en la que se modificó la orden (Formato ISO 8601).

---

placed timestamp

La fecha y hora en la que se realizó el pedido (Formato ISO 8601). Una vez que se realiza, se requieren permisos adicionales para modificar la orden.

---

fulfilled timestamp

La fecha y hora en la que se atendió el pedido (Formato ISO 8601). Una vez que se realiza, se requieren permisos adicionales para modificar la orden.

---

canceled timestamp

La fecha y hora en la que se anuló el pedido (Formato ISO 8601). Una vez que se realiza, se requieren permisos adicionales para modificar la orden.

---

fulfillment_details string

Los datos generales de la atención de la Orden.

	
{
	"id": 32203,
	"object": "order",
	"currency_code": "PEN",
	"payment_status": "paid",
	"billing_details": {
		"first_name": "Manuel",
		"last_name": "Cornejo",
		"company": "",
		"email": "manuelcornejo@testmail.com",
		"document_type": "dni",
		"document_number": "48765432",
		"phone": "991231231",
		"address1": "Av Aviación 2405, San Borja",
		"city": "Lima",
		"province": "Lima",
		"district": "San Borja",
		"country": "Perú",
		"country_code": "PE",
		"zip_code": 15035
	},
	"shipping_address": {
		"first_name": "Manuel",
		"last_name": "Cornejo",
		"phone": 991231231,
		"address1": "Calle Mi Casa 123, San Borja",
		"address2": "Al frente de la Rambla",
		"city": "Lima",
		"province": "Lima",
		"district": "San Borja",
		"country": "Perú",
		"country_code": "PE",
		"longitude": null,
		"latitude": null,	
		"zip_code": 15035
	},
	"lines": [
		{
			"id": 47691,
			"object": "line",
			"product_id": 2233,
			"alternative_id": 2254,
			"image_url": "https://cdn.acelerala.com/img/123123.jpg",
			"sunat_product_code": "LPX123123",
			"quantity": 3,
			"weight": null,		
			"dimensions": {
				"height": 100,
				"width": 100,
				"length": 100
			},
			"name": "Grips",
			"sku": "TESTAPI",
			"price": "100.00",
			"discounts_total": "120.00",
			"discount_allocations": [
				{
					"discount_id": 1337,
					"amount": "120.00"
				}
			],
			"fulfillment_details": {
				"requires_shipping": true,
				"fulfillable_quantity": "4",
				"preferred_date_start": null
			}
		
		}
	],
	"discount_applications": [
		{
			"id": 1337,	
			"discount_id": "21",
			"name": "Promo cyber Wow",			
			"label": "CYBERWOW",
			"desctiption": "Compra 3, recibe  1 con S/ 120 descuento para todos los productos de la categoría cyber wow",
			"value":  120.00,
			"value_type": "fixed_amount",
			"buys": "categories",
			"buys_quantity": 3,
			"target": "categories",
			"target_quantity": 1,
			"allocation_trigger": "automatic",
			"allocation_order": "1",
			"total_allocated": "10"			
		},
		{
			"id": 2000,	
			"discount_id": "23",
			"name": "Recibe 100 soles por más de 300 en tu compra",							
			"label": "100PORMASDE300",
			"desctiption": "Por la compra de más de S/ 300 en tu carrito, ecibe 100 soles",
			"value":  100.00,
			"value_type": "fixed_amount",
			"buys": "anything",
			"buys_quantity": 1,
			"target": "subtotal",			
			"allocation_trigger": "manual",
			"allocation_order": "2",
			"total_allocated": "100",
		}
	
	],
	"discounts_total": 100.00,
	"taxes_included": true,
	"lines_total": 300,	
	"subtotal": 30,
	"shipping_total": 0,
	"total": 30,
	"created": "2021-03-29T14:39:08.000Z",
	"modified": "2021-03-29T14:39:35.000Z",
	"placed": "2021-03-29T14:39:35.000Z",
	"fulfillment_details": {
		"preferred_date_start": "2021-03-31T14:39:35.000Z",
		"preferred_date_end": "2021-03-31T14:39:35.000Z",
		"scheduled_date_start": "2021-03-31T14:39:35.000Z",
		"scheduled_date_end": "2021-03-31T18:39:35.000Z",
		"status": "fulfilled"
		"fulfilled_datetime":  "2021-03-31T14:39:35.000Z",
		"tracking_company": "DHL"
		"tracking_number": "123ADSXR567ND", 
		"tracking_url": "https://www.dhl.com/pe-es/home/rastreo.html"
	}
	
}
				

---

Listar Ordenes

GET https://api.acelerala.com/v1/orders

---

Permisos:

Requiere el siguiente permiso:
read:orders para ver todos los pedidos de una tienda. Si se lista ordenes sin el permiso, sólo encontrará las ordenes que le pertenecen al usuario específico.

Ordenar:

Puedes elegir cualquiera de estos campos para ordenar los pedidos: id,total,created,modified,placed.

Ejemplos

Listar ordenes
GET https://api.acelerala.com/v1/orders

Listar las últimas 20 ordenes en las que el pedido se haya realizado despues de una fecha específica
GET https://api.acelerala.com/v1/orders?limit=20&sort=placed:desc&placed=gt:2019-01-10T16:58:14.000Z

Listar ordenes con solo ciertas propiedades GET https://api.acelerala.com/v1/orders?fields=id,payment_status,items

Listar ordenes con total entre 1000 y 5000, y mostrar solo 10 resultados GET https://api.acelerala.com/v1/orders?total=gt:1000,lt=5000&limit=10

Listar ordenes que hayan sido pagadas GET https://api.acelerala.com/v1/orders

---

Objeto Comprobante

Atributos

---

id integer

Identificador único del objeto.

---

object string, valor es "receipt"

Nombre del objeto.

---

order_id integer

Identificador de objeto "orden" en caso el comprobante pertenezca a una orden específica.

---

store_id integer

Identificador de objeto "store", el proyecto de acelérala al cual le pertenece el comprobante.

---

revoke_id integer

Identificador de objeto "revoke", en caso el comprobante haya sido revocado. Se guarda

---

document_type_code string

El código de tipo de documento autorizado para efectos tributarios según el Catálogo 01 especificado en SUNAT. Algunos son:
01: Factura.
03: Boleta de venta.
07: Nota de crédito.
08: Nota de débito.

---

series string

Empieza con "F" para FACTURAS y NOTAS ASOCIADAS. Empieza con "B" para BOLETAS DE VENTA y NOTAS ASOCIADAS. Si está comunicando un comprobante emitido en contingencia, la serie debe empezar NO debe empezar con "F" ni con "B". Debería empezar con "0", ejemplo: "0001"

---

correlative integer, autogenerado

Número correlativo del documento, sin ceros a la izquierda. Si estás creando un documento nuevo, se calcula automáticamente en base al último documento generado con la misma serie.

---

document_number string, autogenerado

Valor concatenado con un guión (-) de la serie y el correlativo.

---

currency_code currency, por defecto 'PEN'

Código de la moneda en tres letras (Formato ISO 4217).

---

affected_document_type_code string, obligatorio si se está generando una Nota de crédito o débito

El código de tipo de documento afectado por la nota de crédito o débito según el Catálogo 01 especificado en SUNAT.

---

affected_document_number string, obligatorio si se está generando una Nota de crédito o débito

La serie y número del documento que una nota de crédito o débito modifica. Obligatorio si es que se está eimitiendo Notas de crédito o débito.

---

note_motive_code string, obligatorio si se está generando una Nota de crédito o débito

El código de tipo de nota. En el caso de nota de crédito electrónica, los códigos están en el Catálogo 09 especificado en SUNAT. En el caso de nota de débito electrónica, los códigos están en el Catálogo 10 especificado en SUNAT. Obligatorio si es que se está eimitiendo Notas de crédito o débito.

---

note_motive_description string, obligatorio si se está generando una Nota de crédito o débito

La descripción del código de tipo de nota. En el caso de nota de crédito electrónica, las descripciones de los códigos están en el Catálogo 09 especificado en SUNAT. En el caso de nota de débito electrónica, las descripciones de los códigos están en el Catálogo 10 especificado en SUNAT.

---

operation_code string, por defecto '0101' (Venta interna)

El código de tipo de operación según el Catálogo 51 especificado en SUNAT.

---

advances_total autogenerado decimal

La suma de los anticipos.

---

global_discounts_net_total autogenerado decimal

La suma de los descuentos globales antes de impuestos.

---

global_discounts_gross_total autogenerado decimal

La suma de los descuentos globales después de impuestos.

---

other_charges_total opcional decimal autogenerado

La suma de las percepciones u otros cargos adicionales.

---

items_net_total decimal autogenerado

La suma de los precios finales de los ítems antes de impuestos. Se calcula multiplicando el precio unitario (items.net_unit_price) por la cantidad de ítems (items.quantity) y luego restando el descuento total (items.discounts_total).

---

taxable_total decimal autogenerado

El total sobre el cual se calculará el pago de impuestos. No se consideran operaciones inafectas. Este elemento es usado solo si al menos una línea de ítem está gravada con el IGV. Contiene a la sumatoria de los valores de venta gravados por ítem y la deducción de descuentos globales si lo hubiere. El total valor de venta no incluye IGV, ISC, cargos y otros Tributos si los hubiera. La sumatoria tampoco debe contener el valor de venta de las transferencias de bienes o servicios prestados a título gratuito comprendidos en la factura y que estuviesen gravados con el IGV.

---

exempt_total decimal autogenerado

El total exonerado de impuestos. Este elemento es usado solo si al menos una línea de ítem se encuentra exonerada al IGV. Contiene a la sumatoria de valor de venta por ítem exonerados por item y la deducción de descuentos globales si lo hubiere. El valor de venta no incluye ISC, cargos u otros Tributos si los hubiera. La sumatoria tampoco debe contener el valor de venta de las transferencias de bienes o servicios prestados a título gratuito comprendidos en la factura y que estuviesen exonerados del IGV.

---

sales_tax_total decimal autogenerado

El total de impuesto general de venta a pagar.

---

free_sales_tax_total decimal autogenerado

El total de IGV de los ítems entregados gratuitamente.

---

net_total decimal autogenerado

El total antes de considerar impuestos. Se calcula restando total_advancements a items_net_total.

---

taxes_total decimal autogenerado

El total de impuestos a pagar.

---

gross_total decimal autogenerado

El total del pedido que pagará el cliente. Se calcula sumando el total antes de impuestos (net_total) y los impuestos (taxes_total).

---

free_total decimal autogenerado

El total de bienes o servicios prestados gratuitamente. Este elemento, se utilizará cuando exista transferencia de bienes o de servicios que se realice gratuitamente. Representa la sumatoria de los ítems, que correspondan a operaciones gratuitas.

---

unaffected_total decimal autogenerado

El total inafecto de impuestos. Este elemento es usado solo si al menos una línea de ítem se encuentra inafecta al IGV. Contiene a la sumatoria de valor de venta por item inafectos, y la deducción de descuentos globales si los hubiere. El valor de venta no incluye ISC, cargos u otros tributos si los hubiera. La sumatoria tampoco debe contener el valor de venta de las transferencias de bienes o servicios prestados a título gratuito comprendidos en la factura y que estuviesen inafectos al IGV.

---

sunat_acknowledged flag

Indica si la SUNAT recibió y respondió el request, sin importar si el comprobante es aceptado o no.

---

sunat_updated flag

Casos en los que la SUNAT responde sin CDR. Existe un proceso que cada minuto consulta los pendientes de CDR y en caso encuentre el CDR, actualiza el comprobante y este flag cambia automaticamente a 1

---

sunat_acepted flag

Indica si el comprobante fue aceptado o no por SUNAT. Los comprobantes rechazados muestran losmotivos de rechazo en el mensaje de error.

---

sunat_code string

Código de rechazo SUNAT.

---

sunat_message string

Mensaje de respuesa de SUNAT.

---

pdf_url string

URL en donde se cargó el comprobante en formato PDF.

---

mobile_pdf_url string

URL en donde se cargó el comprobante en formato PDF versión ticket para impresoras especializadas.

---

cdr_url string

URL en donde se cargó el comprobante en formato ZIP con el comprobante de recepción SUNAT.

---

xml_url string

URL en donde se cargó el comprobante en formato XML.

---

created timestamp

La fecha y hora en la que se creo el comprobante (Formato ISO 8601).

---

modified timestamp

La última fecha y hora en la que se modificó el comprobante (Formato ISO 8601).

---

claimed_total decimal autogenerado

El total de transacciones atribuidas a este comprobante. Se calcula con la sumatoria de claims.amount.

---

unclaimed_total decimal autogenerado

El monto de la factura que aún no tiene transacciones asociadas. Se calcula restando claimed_total de gross_total. En base a esto, se puede obtener facturas pendientes de pago.

---

customer_information string

La información del cliente al que se le está generando el documento.

---

vendor_information string

La información de la empresa que genera el documento.

---

items

Los ítems que componen el Comprobante. Contienen información de los ítems. Mostrar atributos

---

detraction

En caso el código de tipo de operación sea igual a 1001, es obligatorio.

---

advances opcional

En caso hayan anticipos en algún documeto anterior, se pueden agregar. Por cada anticipo, automáticamente se crea un descuento a nivel global que reduce el costo final de la factura.

---

hold opcional

El Régimen de Percepciones constituye un sistema de pago adelantado del Impuesto General a las Ventas, mediante el cual el agente de percepción (vendedor o Administración Tributaria) percibe del importe de una venta o importación, un porcentaje adicional que tendrá que ser cancelado por el cliente o importador quien no podrá oponerse a dicho cobro.

---

global_discounts opcional

Los descuentos globales son descuentos que se han aplicado al comprobante calculando diréctamente sobre el total de los ítems. Al agregar un descuento Global, se restará ese monto al total neto de los ítems, y sobre ese monto se calcularán los impuestos.

	
{
	"id": 67348,
	"object": "receipt",
	"order_id": null,
	"store_id": 511,
	"document_type_code": "01",
	"series": "F777",
	"correlative": 36862,
	"document_number": "F777-36862",
	"currency_code": "PEN",
	"affected_document_type_code": null,
	"affected_document_number": null,
	"note_motive_code": null,
	"note_motive_description": null,
	"operation_code": "0101",
	"advances_total": 0,
	"global_discounts_net_total": 0,
	"global_discounts_gross_total": 0,
	"other_charges_total": 0,
	"items_net_total": 33.9,
	"taxable_total": 33.9,
	"exempt_total": 0,
	"sales_tax_total": 6.1,
	"free_sales_tax_total": 0,
	"net_total": 33.9,
	"taxes_total": 6.1,
	"gross_total": 40,
	"free_total": 0,
	"unaffected_total": 0,
	"sunat_acknowledged": 1,
	"sunat_updated": 0,
	"sunat_accepted": 1,
	"sunat_revoked": 0,
	"revoke_motive_description": null,
	"sunat_code": "0",
	"sunat_message": "La Factura numero F777-36862, ha sido aceptada",
	"pdf_url": "https://efact.nyc3.cdn.digitaloceanspaces.com/receipts/20601009171/F777-36862-59eba84f-7596-4166-8211-f8b5311acad3.pdf",
	"mobile_pdf_url": "https://efact.nyc3.cdn.digitaloceanspaces.com/receipts/20601009171/F777-36862-59eba84f-7596-4166-8211-f8b5311acad3-mobile.pdf",
	"cdr_url": "https://efact.nyc3.cdn.digitaloceanspaces.com/receipts/20601009171/F777-36862-59eba84f-7596-4166-8211-f8b5311acad3.zip",
	"xml_url": "https://efact.nyc3.cdn.digitaloceanspaces.com/receipts/20601009171/F777-36862-59eba84f-7596-4166-8211-f8b5311acad3.xml",
	"emited": "2022-03-27T12:30:18.000-0500",
	"created": "2022-03-27T12:30:18.000-0500",
	"modified": "2022-03-27T12:30:21.000-0500",
	"claimed_total": 40,
	"unclaimed_total": 0,
	"claims": [
		{
			"id": 1238,
			"object": "claim",
			"store_id": 511,
			"receipt_id": 67348,
			"transaction_id": 1288,
			"amount": 40,
			"currency_code": "PEN",
			"created": "2022-03-27T12:30:25.000-0500",
			"modified": "2022-03-27T12:30:25.000-0500"
		}
	],
	"legends": [
		{
			"code": 1000,
			"value": "SON CUARENTA CON 00/100 SOLES"
		}
	],
	"revokes": [],
	"vendor_information": {
		"name": "YUCA E.I.R.L.",
		"brand": null,
		"document_number": "20601009171",
		"email_recipients": null,
		"address1": "Calle 13 Nro 285, interior 7",
		"address2": null,
		"region": "Lima",
		"province": "Lima",
		"district": "La Molina",
		"country": "Perú",
		"country_code": "PE",
		"ubigeo": null
	},
	"global_discounts": [],
	"items": [
		{
			"name": "Plan Crece Mensual - Costo fijo (Del 27/03/22 al 27/04/22)",
			"sunat_product_code": 7123123,
			"unit": "ZZ",
			"quantity": 1,
			"sales_tax_rate": 18,
			"sales_tax_code": "10",
			"net_unit_price": 33.9,
			"net_subtotal": 33.9,
			"net_discounts_total": 0,
			"net_total": 33.9,
			"taxable_total": 33.9,
			"sales_tax_total": 6.1,
			"gross_unit_price": 40,
			"gross_subtotal": 40,
			"gross_discounts_total": 0,
			"gross_total": 40,
			"free_unit_price": 0,
			"free_total": 0,
			"plastic_tax_factor": null,
			"plastic_tax_total": null,
			"sku": null,
			"discounts": []
		}
	],
	"advances": [],
	"detraction": null,
	"customer_information": {
		"name": "Kalagreen Sac",
		"email": "ventasperu@instagreenlatam.com",
		"document_type": "ruc",
		"document_type_code": "6",
		"document_number": "20601373034",
		"phone": "990056284",
		"address1": null,
		"address2": null,
		"region": null,
		"province": null,
		"district": null,
		"country": null,
		"country_code": null,
		"zip_code": null
	},
	"_metadata": {
		"customfield1": "796",
		"customfield2": "41",
		"customfield3": "553"
	}
}
				

---

Listar Comprobantes

GET https://api.acelerala.com/v1/receipts

---

Permisos:

Requiere el siguiente permiso:
read:receipts para ver todos los comprobantes de una tienda.

Ordenar:

Puedes elegir cualquiera de estos campos para ordenar los pedidos: id,total,created,modified,claimed_total y unclaimed_total.

Ejemplos

Listar comprobantes
GET https://api.acelerala.com/v1/receipts

Listar las últimas 20 comprobantes ordenados por monto por pagar
GET https://api.acelerala.com/v1/receipts?limit=20&sort=unclaimed_total:desc

Listar comprobantes con total entre 1000 y 5000, y mostrar solo 10 resultados GET https://api.acelerala.com/v1/receipts?gross_total=gt:1000,lt=5000&limit=10

Listar comprobantes que hayan sido pagadas GET https://api.acelerala.com/v1/receipts?unclaimed_total=0

---

Objeto Transacción

Atributos

---

id integer

Identificador único del objeto.

---

object string, valor es "transaction"

Nombre del objeto.

---

store_id integer

Identificador del comercio al que pertenece la transacción.

---

order_id integer, opcional

Identificador de la orden a la que pertenece la transacción.

---

parent_id integer, opcional

Identificador de la transacción asociada. Obligatorio cuando es una captura de una autorización previa. Opcional cuando se hace una devolución, en ese caso se puede enviar este campo para asociar la devolución a una compra previa.

---

method string

El medio de pago utilizado para completar esta transacción:
cash: Efectivo.
transfer: Transferencia bancaria.
card: Tarjeta de crédito o débito.

---

type string

El tipo de transacción:
authorization: Se autorizó una tarjeta de débito o crédito, pero aún no se captura el monto.
capture: Se capturó el monto autorizado de una tarjeta de débito o crédito.
sale: Para tarjetas, se autorizó y captura el monto en una misma transacción. Para otros medios de pago, se hace una venta. Por ejemplo, un cobro con transferencia bancaria siempre será sale
void: Se dio de baja una autorización a una tarjeta de crédito o débito.
refund: Devolución de dinero al cliente.

---

amount decimal

El monto total de la transacción

---

currency_code currency, por defecto 'PEN'

Código de la moneda en tres letras (Formato ISO 4217).

---

user_message string, opcional

Mensaje mostrado al usuario. Algunos procesadores de pago devuelven este campo.

---

merchant_message string, opcional

Mensaje para el comercio. Algunos procesadores de pago devuelven este campo.

---

reference_code string

ID de referencia de la marca procesadora. Se utiliza para tarjetas de crédito o débito.

---

card_brand string

Marca de la tarjeta:
visa: Visa.
mastercard: Mastercard.
american_express: American Express
diners_club: Diners Club.

---

card_type string

Tipo de tarjeta:
credit: Crédito.
debit: Débito.
prepaid: Prepago

---

gateway string, opcional

Nombre de la empresa procesadora de pago:
culqi: Culqi.
payu: PayU.
mercadopago: MercadoPago
niubiz: Niubiz
acelerala: Acelérala

---

gateway_id string, opcional

ID de referencia de la procesadora de pago.

---

claims

Arreglo de objetos de acreditaciones de las transacciones a distintos comprobantes. Una transacción puede ser acreditada a uno o más comprobantes.

---

claimed_total opcional decimal

La suma de los anticipos.

---

unclaimed_total opcional decimal

La suma de los anticipos.

---

created timestamp

La fecha y hora en la que se creo la orden (Formato ISO 8601).

---

modified timestamp

La última fecha y hora en la que se modificó la orden (Formato ISO 8601).

	
{
	"id": 13,
	"store_id": 4,
	"order_id": null,
	"parent_id": null,
	"method": "cash",
	"type": "sale",
	"amount": 200,
	"currency_code": "PEN",
	"user_message": null,
	"merchant_message": null,
	"reference_code": null,
	"card_brand": null,
	"card_type": null,
	"gateway": "test",
	"gateway_id": "123",
	"created": "2020-04-15T15:51:16.000Z",
	"modified": "2020-04-15T15:51:16.000Z",
	"claims": [
		{
			"id": 14,
			"store_id": 4,
			"receipt_id": 71,
			"transaction_id": 13,
			"amount": 100,
			"currency_code": "PEN",
			"created": "2020-04-15T15:51:17.000Z",
			"modified": "2020-04-15T15:51:17.000Z"
		}
	],
	"claimed_total": 100,
	"unclaimed_total": 100
}
				

---

Listar Transacciones

GET https://api.acelerala.com/v1/transactions

---

Permisos:

Requiere el siguiente permiso:
read:transactions para ver todos los comprobantes de una tienda.

Ordenar:

Puedes elegir cualquiera de estos campos para ordenar los pedidos: id,amount,created,modified,claimed_total y unclaimed_total.

Ejemplos

Listar transacciones
GET https://api.acelerala.com/v1/transactions

Listar las últimas 20 transacciones ordenados por monto por pagar
GET https://api.acelerala.com/v1/transactions?limit=20&sort=unclaimed_total:desc

Listar transacciones con total entre 1000 y 5000, y mostrar solo 10 resultados GET https://api.acelerala.com/v1/transactions?gross_total=gt:1000,lt=5000&limit=10

Listar transacciones que hayan sido facturadas GET https://api.acelerala.com/v1/transactions?unclaimed_total=0

---

Objeto Acreditación

Atributos

---

id integer

Identificador único del objeto.

---

object string, valor es "webhook"

Nombre del objeto.

---

store_id integer

Identificador del comercio al que pertenece el webhook.

---

receipt_id integer, opcional

Identificador del comprobante al cual está siendo acreditada el webhook.

---

transaction_id integer, opcional

Identificador de el webhook que está siendo acreditada al comprobante.

---

amount decimal

El monto acreditado. la suma de montos acreditados de una transacción o de un comprobante no puede ser mayor al total de el webhook o al total del comprobante.

---

currency_code currency, por defecto 'PEN'

Código de la moneda en tres letras (Formato ISO 4217). El código de moneda debe ser el mismo que el código del comprobante y de el webhook.

---

created timestamp

La fecha y hora en la que se creo la orden (Formato ISO 8601).

---

modified timestamp

La última fecha y hora en la que se modificó la orden (Formato ISO 8601).

	

{
	"id": 14,
	"object": "claim",
	"store_id": 4,
	"receipt_id": 71,
	"transaction_id": 13,
	"amount": 100,
	"currency_code": "PEN",
	"created": "2020-04-15T15:51:17.000Z",
	"modified": "2020-04-15T15:51:17.000Z"
}

---

Listar Acreditaciones

GET https://api.acelerala.com/v1/claims

---

Permisos:

Requiere cualquiera de los siguientes permisos:
read:receipts o read:transactions para ver todas las acreditaciones de una tienda.

Ordenar:

Puedes elegir cualquiera de estos campos para ordenar los pedidos: id,total,created,modified,claimed_total y unclaimed_total.

Ejemplos

Listar comprobantes
GET https://api.acelerala.com/v1/claims

Listar las acreditaciones de una transacción específica
GET https://api.acelerala.com/v1/claims?transaction_id=1

---

Objeto Guía de remisión

Atributos

---

id integer

Identificador único del objeto.

---

object string, valor es "guide"

Nombre del objeto.

---

order_id integer

Identificador de objeto "orden" en caso el comprobante pertenezca a una orden específica.

---

store_id integer

Identificador de objeto "store", el proyecto de acelérala al cual le pertenece el comprobante.

---

document_type_code string

El código de tipo de documento autorizado para efectos tributarios según el Catálogo 01 especificado en SUNAT. Algunos son:
09: Guía de remisión remitente.
31: Guía de remisión transportista.

---

series string

Empieza con "T".

---

correlative integer, autogenerado

Número correlativo del documento, sin ceros a la izquierda. Se genera automáticamente en base al último documento generado con la misma serie.

---

document_number string, autogenerado

Valor concatenado con un guión (-) de la serie y el correlativo.

---

motive_code string, obligatorio

El código de motivo de traslado. Los códigos están en el Catálogo 20 especificado en SUNAT.
01: Venta
02: Compra
03: Venta con entrega a terceros
04: Traslado entre establecimientos de la misma empresa
05: Consignación
06: Devolución
07: Recojo de bienes transformados
08: Importación
09: Exportación
13: Otros
14: Venta sujeta a confirmación del comprador
17: Traslado de bienes para transformación
18: Traslado emisor itinerante CP

---

motive_description string, 100 char max, obligatorio si el código de motivo es 13 (Otros)

La descripción del motivo de traslado. En el caso de nota de crédito electrónica, las descripciones de los códigos están en el Catálogo 09 especificado en SUNAT. En el caso de nota de débito electrónica, las descripciones de los códigos están en el Catálogo 10 especificado en SUNAT.

---

mode_code string, obligatorio

El código de modalidad de traslado. Los códigos están en el Catálogo 18 especificado en SUNAT.
01: Transporte público
02: Transporte privado

---

shipment_port_code string, obligatorio

El código de puerto o aeropuerto de traslado. Los códigos están en el Catálogo 63 y 64 especificado en SUNAT.
Catálogo 63, En caso sea puerto
PUB: Bayóvar, ubigeo 200801
CLL: Callao, ubigeo 070101
CON: Conchán, ubigeo 150119
CHY: Chancay, ubigeo 150605
CHM: Chimbote, ubigeo 021801
EEN: Eten, ubigeo 140113
HCO: Huacho, ubigeo 150801
HUY: Huarmey, ubigeo 021101
ILQ: Ilo, ubigeo 180301
IQT: Iquitos, ubigeo 160101
MRI: Matarani, ubigeo 040701
PAI: Paita, ubigeo 200501
PIO: Pisco, ubigeo 110505
PCL: Pucallpa, ubigeo 250101
PUN: Puno, ubigeo 210101
SVY: Salaverry, ubigeo 130109
SNX: San Nicolas, ubigeo 110304
SUP: Supe, ubigeo 150204
TYL: Talara, ubigeo 200701
YMS: Yurimaguas, ubigeo 160201
ZOR: Zorritos, ubigeo 240103

Catálogo 63, En caso sea aeropuerto
AQP: Rodríguez Ballón, ubigeo 040104
ANS: Andahuaylas, ubigeo 030201
ATA: Comandante FAP Germán Arias Graciani, ubigeo 020604
AYP: Coronel FAP Alfredo Mendívil Duarte, ubigeo 050113
CJA: Mayor Gral. FAP Armando Revoredo Iglesias, ubigeo 060108
CHM: Tnte. FAP Jaime De Montruil M., ubigeo 021809
CUZ: Alejandro Velazco Astete, ubigeo 080108
CHH: Chachapoyas, ubigeo 010101
CIX: Capitán FAP José Quiñones G., ubigeo 140101
HUU: Alférez FAP David Figueroa Fernandini, ubigeo 100101
ILO: Ilo, ubigeo 180301
IQT: Coronel FAP Francisco Secada Vignetta, ubigeo 160101
JAE: Jaén - Shumba, ubigeo 060802
JJI: Juanjuí, ubigeo 220601
JUL: Manco Cápac, ubigeo 211101
JAU: Francisco Carlé, ubigeo 120430
LIM: Internacional Jorge Chávez, ubigeo 070101
MBP: Moyobamba, ubigeo 220101
PIO: Capitán FAP Renán Elías Olivera, ubigeo 110506
PIU: Capitán FAP Carlos Concha Iberico, ubigeo 200104
PCL: Capitán FAP David Abensur Rengifo, ubigeo 250105
PEM: Padre Aldamiz, ubigeo 170101
RIJ: Juan Simons Vela - Rioja, ubigeo 220801
TCQ: Coronel FAP Carlos Ciriani Santa Rosa, ubigeo 230101
TYL: Capitán FAP Montes Arias, ubigeo 200701
TPP: Cadete FAP Guillermo del Castillo Paredes, ubigeo 220901
TIG: Tingo María, ubigeo 100601
TRU: Capitán FAP Carlos Martínez Pinillos, ubigeo 130104
TBP: Capitán FAP Pedro Canga Rodríguez, ubigeo 240101
ATG: Atalaya - Tnte. Gral. Gerardo Pérez Pinedo, ubigeo 250201
YMS: Moisés Benzaquen Rengifo, ubigeo 160201

---

operation_code string, por defecto '0101' (Venta interna)

El código de tipo de operación según el Catálogo 51 especificado en SUNAT.

---

transit_date timestamp

La fecha y hora en la que se trasladará la mercadería en (Formato ISO 8601).

---

weight_total decimal (12,3), obligatorio, autogenerado en base al peso de los ítems si es que tienen peso,

La suma del peso de los ítems en la unidad de medida elegida.

---

weight_unit obligatorio, por default "KGM" (Kilogramo)

El código de unidad de medida. Están en el Catálogo 03 especificado en SUNAT. KGM: Kilogramo
TNE: Tonelada

---

sunat_acknowledged flag

Indica si la SUNAT recibió y respondió el request, sin importar si el comprobante es aceptado o no.

---

sunat_updated flag

Casos en los que la SUNAT responde sin CDR. Existe un proceso que cada minuto consulta los pendientes de CDR y en caso encuentre el CDR, actualiza el comprobante y este flag cambia automaticamente a 1

---

sunat_acepted flag

Indica si el comprobante fue aceptado o no por SUNAT. Los comprobantes rechazados muestran losmotivos de rechazo en el mensaje de error.

---

sunat_code string

Código de rechazo SUNAT.

---

sunat_message string

Mensaje de respuesa de SUNAT.

---

pdf_url string

URL en donde se cargó el comprobante en formato PDF.

---

mobile_pdf_url string

URL en donde se cargó el comprobante en formato PDF versión ticket para impresoras especializadas.

---

cdr_url string

URL en donde se cargó el comprobante en formato ZIP con el comprobante de recepción SUNAT.

---

xml_url string

URL en donde se cargó el comprobante en formato XML.

---

emited datetime

La fecha y hora de emisión del comprobante (Formato ISO 8601). La SUNAT permite enviar hasta dos días menos a la fecha actual en la emisión de comprobantes.

---

created timestamp

La fecha y hora en la que se creó el comprobante (Formato ISO 8601).

---

modified timestamp

La última fecha y hora en la que se modificó el comprobante (Formato ISO 8601).

---

claimed_total decimal autogenerado

El total de transacciones atribuidas a este comprobante. Se calcula con la sumatoria de claims.amount.

---

unclaimed_total decimal autogenerado

El monto de la factura que aún no tiene transacciones asociadas. Se calcula restando claimed_total de gross_total. En base a esto, se puede obtener facturas pendientes de pago.

---

goods

La mercaderíá que componen se trasladará en esta guíá de remisión.

---

vendor_information string

La información de la empresa que genera el documento.

---

buyer_information objeto, obligatorio si el motive_code es 03

La información del comprador donde se está recogiendo mercadería comprada o bienes transformados.

---

supplier_information objeto, obligatorio si el motive_code es 02, 07 o 13

La información del proveedor donde se está recogiendo mercadería comprada o bienes transformados.

---

recipient_information string

La información del cliente al que se le está generando el documento. Obligatorio si el motivo del despacho es 03 (Venta con entrega a terceros) o 13 (Otros)

---

related_documents opcional

Documentos relacionados a la guía de remisión.

---

drivers opcional, obligatorio en caso sea transporte Privado.

Cuando se utiliza transporte privado se pueden enviar hasta 3 conductores. El primero se tomará como conductor principal, los otros dos como secundarios.

---

vehicles opcional, obligatorio en caso sea transporte Privado y el tipo de vehículo no sea M1 (8 asientos o menos, sin contar el asiento del conductor) o L (3 ruedas o menos)

Cuando se utiliza transporte privado se pueden enviar hasta 3 vehículos. El primero se tomará como principal, los otros dos como secundarios.

	

{
	"id": 65,
	"store_id": 4,
	"document_type_code": "09",
	"series": "T800",
	"correlative": 62,
	"document_number": "T800-62",
	"motive_code": "01",
	"motive_description": "VENTA",
	"mode_code": "02",
	"transit_date": "2023-12-20T10:33:30.000-0500",
	"port_code": null,
	"weight_total": 10,
	"weight_unit": "KGM",
	"packages_total": null,
	"note": null,
	"vendor_id": 262,
	"supplier_id": null,
	"customer_id": 263,
	"carrier_id": null,
	"origin_id": 138,
	"destination_id": 139,
	"sunat_acknowledged": 0,
	"sunat_updated": 0,
	"sunat_accepted": 0,
	"sunat_revoked": 0,
	"sunat_code": null,
	"sunat_message": null,
	"pdf_url": null,
	"cdr_url": null,
	"xml_url": null,
	"created": "2023-11-28T16:29:42.000-0500",
	"modified": "2023-11-28T16:29:42.000-0500",
	"goods": [
		{
			"id": 9,
			"guide_id": 97,
			"name": "Chocolate dark",
			"sunat_product_code": "81112215",
			"sku": "123",
			"unit": "ZZ",
			"quantity": 1,
			"weight": null
		},
		{
			"id": 10,
			"guide_id": 97,
			"name": "Chocolate dark con almendra",
			"sunat_product_code": null,
			"sku": "124",
			"unit": "ZZ",
			"quantity": 4,
			"weight": null
		}
	],
	"vehicles": [
		{
			"id": 73,
			"guide_id": 65,
			"plate": "ABC123"
		},
		{
			"id": 74,
			"guide_id": 65,
			"plate": "ABC124"
		},
		{
			"id": 75,
			"guide_id": 65,
			"plate": "ABC125"
		}
	],
	"drivers": [
		{
			"id": 264,
			"name": "Manuel Cornejo",
			"first_name": "Manuel",
			"last_name": "Cornejo",
			"email": null,
			"document_type": "dni",
			"document_type_code": "1",
			"document_number": "40003344",
			"license": "DQG123123",
			"phone": null,
			"address1": null,
			"address2": null,
			"region": null,
			"province": null,
			"district": null,
			"country": null,
			"country_code": null,
			"zip_code": null
		},
		{
			"id": 265,
			"name": "Andre Fort",
			"first_name": "Andre",
			"last_name": "Fort",
			"email": null,
			"document_type": "dni",
			"document_type_code": "1",
			"document_number": "40003366",
			"license": "DQG123124",
			"phone": null,
			"address1": null,
			"address2": null,
			"region": null,
			"province": null,
			"district": null,
			"country": null,
			"country_code": null,
			"zip_code": null
		},
		{
			"id": 266,
			"name": "Gonzalo Velasco",
			"first_name": "Gonzalo",
			"last_name": "Velasco",
			"email": null,
			"document_type": "dni",
			"document_type_code": "1",
			"document_number": "40003355",
			"license": "DQG123125",
			"phone": null,
			"address1": null,
			"address2": null,
			"region": null,
			"province": null,
			"district": null,
			"country": null,
			"country_code": null,
			"zip_code": null
		}
	],
	"related_documents": [
		{
			"document_type_code": "1",
			"document_number": "B777-6",
			"issuer_document_number": 20601009171
		}
	],
	"destination": {
		"id": 139,
		"label": null,
		"first_name": null,
		"last_name": null,
		"phone": null,
		"address1": "Av. Destino 445",
		"address2": null,
		"street": null,
		"street_num": null,
		"house_num": null,
		"region": "Lima",
		"province": "Lima",
		"district": "La Molina",
		"urbanization": null,
		"ubigeo": 150203,
		"zip_code": null,
		"country": "Perú",
		"country_code": "PE",
		"latitude": null,
		"longitude": null,
		"created": "2023-11-28T16:29:42.000-0500",
		"modified": "2023-11-28T16:29:42.000-0500"
	},
	"origin": {
		"id": 138,
		"label": null,
		"first_name": null,
		"last_name": null,
		"phone": null,
		"address1": "Av. OPrigen 1234",
		"address2": null,
		"street": null,
		"street_num": null,
		"house_num": null,
		"region": "Lima",
		"province": "Lima",
		"district": "La Molina",
		"urbanization": null,
		"ubigeo": 150101,
		"zip_code": null,
		"country": "Perú",
		"country_code": "PE",
		"latitude": null,
		"longitude": null,
		"created": "2023-11-28T16:29:42.000-0500",
		"modified": "2023-11-28T16:29:42.000-0500"
	},
	"customer_information": {
		"id": 263,
		"name": "TDP CORP S.A.",
		"first_name": null,
		"last_name": null,
		"email": "jmcornejo00@gmail.com",
		"document_type": "ruc",
		"document_type_code": "6",
		"document_number": "20100286476",
		"license": null,
		"phone": null,
		"address1": null,
		"address2": null,
		"region": null,
		"province": null,
		"district": null,
		"country": null,
		"country_code": null,
		"zip_code": null
	},
	"supplier_information": null,
	"vendor_information": {
		"id": 262,
		"name": "GREENTER S.A.C.",
		"first_name": null,
		"last_name": null,
		"email": null,
		"document_type": "ruc",
		"document_type_code": "6",
		"document_number": "20161515648",
		"license": null,
		"phone": null,
		"address1": "Calle 13 Nro 285, interior 7",
		"address2": null,
		"region": "Lima",
		"province": "Lima",
		"district": "La Molina",
		"country": "Perú",
		"country_code": "PE",
		"zip_code": null
	},
	"carrier_information": null,	
	"_metadata": {
		"customfield1": "796",
		"customfield2": "41",
		"customfield3": "553"
	}
}
				

---

Listar Guías

GET https://api.acelerala.com/v1/guides

---

Permisos:

Requiere el siguiente permiso:
read:receipts para ver todos los guías de una tienda.

Ordenar:

Puedes elegir cualquiera de estos campos para ordenar los pedidos: id,created,modified.

Ejemplos

Listar guías
GET https://api.acelerala.com/v1/guides

Listar guíás y mostrar solo 10 resultados GET https://api.acelerala.com/v1/guides?limit=10

---

Objeto Webhook

Atributos

---

id integer

Identificador único del objeto.

---

object string, valor es "claim"

Nombre del objeto.

---

store_id integer

Identificador del comercio al que pertenece la acreditación.

---

description string, opcional

Descripción del webhook. Se usa para que otros usuarios que pertenezcan al comercio entiendan para qué se creó el webhook.

---

url string

El endpoint a donde se te enviará la notificación con la data del evento.

---

enabled_events array

Arreglo de los nombres de los eventos a los cuales está suscrito este webhook.

---

active decimal, por defecto 1

Flag para activar o desactivar el webhook.

---

created timestamp

La fecha y hora en la que se creo la orden (Formato ISO 8601).

---

modified timestamp

La última fecha y hora en la que se modificó la orden (Formato ISO 8601).

	

{
	"id": 13,
	"store_id": 4,
	"description": "Pedidos puestos",
	"url": "https://www.taund.com/test",
	"created": "2020-07-21T20:31:56.000-05",
	"modified": "2020-07-21T20:58:49.000-05",
	"active": 1,
	"enabled_events": [
		"orders.created.placed", "orders.updated.placed"
	]
}

	

---

Listar Webhooks

GET https://api.acelerala.com/v1/webhooks

---

Permisos:

Requiere cualquiera de los siguientes permisos:
read:webhooks para ver todos los webhooks de una tienda.

Ordenar:

Puedes elegir cualquiera de estos campos para ordenar los pedidos: id,created,modified.

Ejemplos

Listar webhooks
GET https://api.acelerala.com/v1/webhooks

Listar webhooks activos
GET https://api.acelerala.com/v1/webhooks?active=1

---

Objeto Local

Atributos

---

id integer

Identificador único del objeto.

---

object string, valor es "location"

Nombre del objeto.

---

store_id integer

Identificador de objeto "store", el proyecto de acelérala al cual le pertenece el comprobante.

---

name string, obligatorio, máximo 100 caracteres

Nombre del local

---

slug string, obligatorio, autogenerado

Nombre único del producto adaptado para la URL de la tienda

---

description string

Descripción en html del producto. Se utiliza para mostrar en el frontend de la web

---

total_reviews integer, autogenerado

Cantidad de reseñas que tiene el producto

---

average_rating decimal, autogenerado

Promedio de calificación del producto. Las calificaciones pueden tener un valor entre 0 y 100

---

agreements.sale flag

Si el producto se puede comprar.

---

agreements.rent decimal

Si el producto se puede alquilar.

---

bundle flag

Define si un producto es un combo de varios productos o no. Si un producto es un combo, no puede pertenecer a otro combo

---

bundle_min_quantity int

El mínimo de unidades que debe agregarse con el combo de productos

---

bundle_max_quantity int

El máximo de unidades que debe agregarse con el combo de productos. No puede ser menor que el bundle_min_quantity

---

alternatives

Las opciones que tiene el cliente para elegir del producto. Siempre un producto debe de tener al menos una alternativa.

---

categories

Arreglo que contiene las categorías a las que el producto está asociado.

---

created timestamp

La fecha y hora en la que se creo la orden (Formato ISO 8601).

---

modified timestamp

La última fecha y hora en la que se modificó la orden (Formato ISO 8601).

	
{
	"id": 123,
	"object": "location",
	"store_id": 4,
	"name": "Tienda San Isidro",	
	"description": "Este es un producto muy bonito que hemos creado para explicar el objeto producto",
	"warehouse": true,
	"active": true,
	"address_details": {
		"first_name": "Manuel",
		"last_name": "Cornejo",
		"company": "",
		"email": "manuelcornejo@testmail.com",
		"document_type": "dni",
		"document_number": "48765432",
		"phone": "991231231",
		"address1": "Av Aviación 2405, San Borja",
		"city": "Lima",
		"province": "Lima",
		"district": "San Borja",
		"country": "Perú",
		"country_code": "PE",
		"zip_code": 15035
	},
	"resources": [
		{
			"id": 1,
			"object": "resource",			
			"location_id": 123,
			"name": "Camión",
			"capacities": [
				{
					"type": "volume",
					"type": "concurrent",
					"min_capacity": "0",
					"max_capacity": "1000"
				},
				{
					"type": "weight",
					"type": "concurrent",
					"min_capacity": "0",
					"max_capacity": "1000000"
				},
				{
					"type": "stops",
					"type": "daily",
					"min_capacity": "0",
					"max_capacity": "20"
				},
			]

			"dimensions": {
				"height": 100,
				"width": 100,
				"length": 100
			},
			"min_seats": "8",
			"max_seats": "10"			
		},
		{
			"id": 2,
			"object": "resource",
			"location_id": 123,
			"name": "Mesa 2",
			"description": "Esta mesa puede recibir grupos entre 8 y 10 personas. Máximo 1 orden, ya que no puedes mezclar dos órdenes de 4 personas."
			"min_seats": "8",
			"max_seats": "10",
			"capacities": [
				{
					"type": "seats",
					"type": "concurrent",
					"min_capacity": "8",
					"max_capacity": "10"
				},
				{
					"type": "orders",
					"type": "concurrent",
					"min_capacity": "1",
					"max_capacity": "1"
				}
			]
		},
		{
			"id": 2,
			"object": "resource",
			"location_id": 123,
			"name": "Asiento A17",
			"description": "Este recurso representa el asiento de un avión."
			"capacities": [
				{
					"id": 1,
					"type": "units",
					"type": "concurrent",
					"min_capacity": "1",
					"max_capacity": "1"
				}
			],
			"availabilities": [
				{
					"day_index":1,
					"start_time": 10:00,
					"end_time": 14:00
				}
				

			],
			"exceptions": [
				"24-12-2023"
			]
		},
		{
			"id": 2,
			"object": "resource",
			"location_id": 123,
			"name": "Avion 310",
			"description": "Este recurso representa el asiento de un avión."
			"capacities": [
				{
					"type": "seats",
					"type": "concurrent",
					"min_capacity": "1",
					"max_capacity": "1"
				},
				{
					"type": "orders",
					"type": "concurrent",
					"min_capacity": "1",
					"max_capacity": "1"
				}
			]
		}
		{
			"id": 3,
			"object": "resource",
			"location_id": 123,
			"name": "Mesa 3",
			"min_seats": "4",
			"max_seats": "6"
		}
		{
			"id": 4,
			"object": "resource",
			"location_id": 123,
			"name": "Mesa 4",
			"min_seats": "4",
			"max_seats": "6"
		},
		{
			"id": 4,
			"object": "resource",
			"location_id": 123,
			"name": "Mesa 1",
			"min_seats": "8",
			"max_seats": "10",
			"parent_resources" [
				{
					
				}
			]
			
		}
	],	
	"categories": [
		{
			"id": 1,	
			"object": "category",			
			"name": "Polos",		
			"slug": "polos"			
		},
		{
			"id": 2,	
			"object": "category",
			"name": "Promoción verano",	
			"slug": "promocion-verano"
		}
	
	],
	"media": [
		{
			"id": 1,	
			"product_id": "123",
			"url": "https://cdn.acelerala.com/img/123123.jpg",		
			"extension": "jpg",
			"optn1": "Rojo",
			"optn2": "L",
			"optn3": ""			
		},
		{
			"id": 2,	
			"product_id": "123",
			"url": "https://cdn.acelerala.com/img/123123.jpg",		
			"extension": "mp4",
			"optn1": "Azul",
			"optn2": "L",
			"optn3": ""	
		}
	
	],
	"created": "2021-03-29T14:39:08.000Z",
	"modified": "2021-03-29T14:39:35.000Z"	
}
				

---

Listar Locales

GET https://api.acelerala.com/v1/locations

---

Permisos:

Requiere el siguiente permiso:
No requiere permisos. El API de productos es público.

Ordenar:

Puedes elegir cualquiera de estos campos para ordenar los locales: id,priority,created,modified.

Ejemplos

Listar locales
GET https://api.acelerala.com/v1/locations

Listar 20 productos de una ciudad específica
GET https://api.acelerala.com/v1/locations?limit=20&city=Lima

---

Objeto Cobertura

Atributos

---

id integer

Identificador único del objeto.

---

object string, valor es "coverage"

Nombre del objeto.

---

store_id integer

Identificador de objeto "store", el proyecto de acelérala al cual le pertenece el comprobante.

---

label string, obligatorio

Nombre de la cobertura

---

description string

Descripción de la cobertura. Se utiliza como información adicional para otras personas de tu empresa.

---

active boolean, predeterminado 1

Si actualmente está activa o no la cobertura

---

coverage_zones

Las zonas que atiende esta cobertura.

---

created timestamp

La fecha y hora en la que se creo la orden (Formato ISO 8601).

---

modified timestamp

La última fecha y hora en la que se modificó la orden (Formato ISO 8601).

	
{
	"id": 123,
	"object": "coverage",
	"store_id": 4,
	"label": "Lima Metropolitana",	
	"description": "Distritos principales de Lima Metropolitana",
	"active": true,
	"coverage_zones": [
		{
			"id": 1,
			"object": "coverage_zone",
			"store_id": 4,
			"condition": "country_code",
			"conditional": "eq",
			"value": "PE",
			"created": "2021-03-29T14:39:08.000Z",
			"modified": "2021-03-29T14:39:35.000Z"		
		},
		{
			"id": 2,
			"object": "coverage_zone",
			"store_id": 4,
			"condition": "province",
			"conditional": "eq",
			"value": "Lima",
			"created": "2021-03-29T14:39:08.000Z",
			"modified": "2021-03-29T14:39:35.000Z"		
		}
	],
	"created": "2021-03-29T14:39:08.000Z",
	"modified": "2021-03-29T14:39:35.000Z"	
}

				

---

Listar Coberturas

GET https://api.acelerala.com/v1/coverages

---

Permisos:

Requiere el siguiente permiso:
read:coverages

Ordenar:

Puedes elegir cualquiera de estos campos para ordenar los locales: id,created,modified.

Ejemplos

Listar coberturas
GET https://api.acelerala.com/v1/coverages

---

Objeto Ruta

Define la conexión entre dos nodos, que pueden ser locales, o coberturas. Sirve para poder calcular la fecha de llegada de un pedido, siempre y cuando tengas el destino definido.

Atributos

---

id integer

Identificador único del objeto.

---

object string, valor es "link"

Nombre del objeto.

---

lead_time time (hh:mm:ss)

Tiempo que demora en ejecutrase esta ruta.

---

origin_id integer

Identificador de objeto de origen de esta ruta.

---

origin_type string

El tipo de origen, ya sea un local o una zona. Por ejemplo, para un pedido que va de tu almacén hacia una zona de cobertura, el tipo de origen sería location. Para una ruta de logística inversa, el origen sería la zona desde donde se va a recoger el producto.
location: Almacén.
coverage: Cobertura.

---

destination_id integer

Identificador de objeto de destino de esta ruta.

---

destination_type string

El tipo de destino, ya sea un local o una zona. Por ejemplo, para un pedido que va de tu almacén hacia una zona de cobertura, el tipo de destino sería coverage. Para una ruta de logística inversa, el destino sería el almacén a donde vas a dejar el producto (location).
location: Almacén.
coverage: Cobertura.

---

active boolean, predeterminado true

Si actualmente está activa o no la cobertura

---

created timestamp

La fecha y hora en la que se creo la orden (Formato ISO 8601).

---

modified timestamp

La última fecha y hora en la que se modificó la orden (Formato ISO 8601).

	
{
	"id": 123,
	"object": "leg",
	"origin_id": 4,
	"origin_type": "location",
	"destination_id": 5,
	"destination_type": "coverage",
	"label": "Lima Metropolitana",	
	"description": "Distritos principales de Lima Metropolitana",
	"active": true,	
	"created": "2021-03-29T14:39:08.000Z",
	"modified": "2021-03-29T14:39:35.000Z"	
}

				

---

Listar Tramos

GET https://api.acelerala.com/v1/legs

---

Permisos:

Requiere el siguiente permiso:
read:legs

Ordenar:

Puedes elegir cualquiera de estos campos para ordenar los tramos: id,created,modified.

Ejemplos

Listar tramos
GET https://api.acelerala.com/v1/legs

---