Obtener ordenes

Método utilizado para obtener las ventas de una tienda particular.


GET {env}/1/orders

Headers


{
  "Authorization": "Bearer {access_token}",
  "X-Shop-Id": "12345"
}

Parámetro	Tipo	Requerido	Valores aceptados	Descripción
`Authorization`	string	Si	`Bearer` + access_token	Token obtenido mediante client_id y client_secret.
`X-Shop-Id`	string	Si	String numérico	Identificador único de la tienda a la cual se desea obtener sus ventas.

Query params


{
  "payment_status": 1,
  "payment_method": 7,
  "shipment_method": 4,
  "shipment_status": 0,
  "number": 14,
  "wholesale": 0,
  "email": "usuario@example.com",
  "from": "2023-07-18T15:59:25Z",
  "until": "2023-08-22T13:00:00Z",
  "page": 0,
  "sort": 1
}

Parámetro	Tipo	Requerido	Valores aceptados	Descripción
`payment_status`	int	No	-1: Esperando pago, 0: Pendiente, 1: Finalizado, 2: En proceso, 3: En mediación, 4: Rechazada, 5: Cancelada, 6: Pago devuelto, 7: En contracargo	Corresponde al estado del pago de la orden. Utilizado para filtrado.
`payment_method`	int	No	1: Mercado Pago, 2: Efectivo, 3: Acordar con el vendedor, 4: Todo Pago (deprecated), 5: Transferencia bancaria, 6: Mobbex, 7: Ualá Bis	Corresponde al medio de pago utilizado en la orden. Utilizado para filtrado.
`shipment_method`	int	No	1: Mercado Envíos, 2: Retiro en local, 3: Acordar con el vendedor, 4: Emprepack, 5: Envíos personalizados, 6: OCA, 7: Email (solo ventas digitales), 8: Correo Argentino, 9: E-Pick	Corresponde al medio de envío utilizado por la orden. Utilizado para filtrado.
`shipment_status`	int	No	0: Pendiente, 1: En preparación, 2: Enviado	Corresponde al estado actual del envío de la orden. Estos estados no cambian automáticamente, dependen del usuario. Utilizado para filtrado.
`number`	int	No	1 <= number < N	Permite buscar por un número de orden. Cuando es utilizado, solo arroja un único resultado. Puede ser usado con la información provista por el evento de webhook `OrderCreated` (campo `order_number`).
`wholesale`	int	No	0: La venta es minorista, 1: La venta es mayorista	Corresponde al tipo de orden. Utilizado para filtrado.
`email`	string	No	Email	Permite buscar las ordenes de un determinado cliente por su email. Utilizado para filtrado.
`from`	string	Solo si existe `until`	Fecha ISO 8601. Ej: “2023-07-18T15:59:25Z”	Permite obtener las ordenes desde cierta fecha, tomando como referencia `created_at`. Se utiliza en conjunto con `until`.
`until`	string	Solo si existe `from`	Fecha ISO 8601. Ej: “2023-07-18T15:59:25Z”	Permite obtener las ordenes hasta cierta fecha, tomando como referencia `created_at`. Se utiliza en conjunto con `from`.
`page`	int	No	page >= 0	Permite paginar los resultados de a 15 ordenes.
`sort`	int	No	0: más vieja a más nueva, 1: más nueva a más vieja	Permite ordenar las órdenes.

Response exitosa: 200 Ok


[
  {
    "id": "order-1",
    "number": 2,
    "created_at": "2023-07-12T09:32:00Z",
    "total": 1500.00,
    "subtotal": 1300.00,
    "coupon_discount": 75.00,
    "payment_method_discount": 25.00,
    "shipment_price": 300.00,
    "wholesale": false,
    "stock_returned": false,
    "has_digital_products": false,
    "checkout_id": "...",
    "customer_id": "customer-44",
    "payment": {
      "method": 1,
      "status": 1,
      "main_reference_id": "231523151",
      "extra_reference_id": "2f78f1a3-4e67-4e61-9157-526d1f6b3ab7",
      "method_discount": 25.00
    },
    "shipping": {
      "method": 3,
      "status": 0,
      "price": 300.00,
      "free_shipment_price": 0,
      "tracking_number": "3000031231231",
      "reference_id": null,
      "main_label": "https://andreani.com/asdasdasd.pdf",
      "extra_label": null,
      "contact": {
        "email": "usuario@example.com",
        "name": "John",
        "surname": "Doe",
        "identification": {
          "type": "DNI",
          "value": "12345678"
        },
        "phone": "5491100000000"
      },
      "address": {
        "street": "Calle Falsa",
        "number": "123",
        "floor": "3",
        "apartment": "B",
        "city": "La Plata",
        "state": "Buenos Aires",
        "zip_code": "1900",
        "country": "Argentina",
        "notes": "No me anda el timbre"
      },
      "metadata": {
        "days": "3",
        "method": 4,
        "type": 1,
        "subtype": 10044,
        "description": [
          "San Martín 2127, Rosario, Santa Fe",
          "Lunes a Viernes de 08:30 a 18:00 - Sábados de 09:00 a 13:00"
        ]
      }
    },
    "billing": {
      "invoice": {
        "invoiced": true,
        "link": ".....",
        "reference_id": null
      },
      "contact": {
        "email": "usuario@example.com",
        "name": "John",
        "surname": "Doe",
        "identification": {
          "type": "DNI",
          "value": "12345678"
        },
        "phone": "5491100000000"
      },
      "address": {
        "street": "Calle Falsa",
        "number": "123",
        "floor": "3",
        "apartment": "B",
        "city": "La Plata",
        "state": "Buenos Aires",
        "zip_code": "1900",
        "country": "Argentina"
      }
    },
    "products": [
      {
        "stock_id": "stock-213859",
        "product_id": "product-110638",
        "price": 1000,
        "quantity": 1,
        "name": "Remera coolkids",
        "sku": null,
        "height": 10,
        "weight": 0.3,
        "width": 10,
        "depth": 10,
        "digital": false,
        "attributes": [
          {
            "name": "Color",
            "value": "Rojo"
          }
        ]
      }
      //...
    ]
  }
  //...
]

Campos de la respuesta

Atributo	Tipo	Descripción
`id`	string	Corresponde al id interno de ordenes, es único para todas las ordenes de Empretienda.
`number`	int	Corresponde al número de orden de la tienda.
`created_at`	string	Corresponde a la fecha de la orden en formato ISO 8601.
`total`	float	Corresponde al monto que paga el usuario, es calculado como: `total = subtotal - coupon_discount - payment_method_discount + shipment_price`.
`subtotal`	float	Corresponde a la suma de los precios de los productos de la orden.
`coupon_discount`	float	Indica el monto de descuento generado por el cupón de descuento de la orden. En caso de que su valor sea 0, entonces no hay cupón de descuento aplicado.
`payment_method_discount`	float	Indica si se hizo un descuento por abonar la orden con cierto método de pago. En caso de que su valor sea 0, entonces no se hizo dicho descuento.
`shipment_price`	float	Indica el costo del envío de la orden.
`wholesale`	boolean	Indica si se trata de una venta mayorista o no.
`stock_returned`	boolean	Indica si el stock de la orden fue devuelto o no.
`has_digital_products`	boolean	Indica si la orden posee productos digitales o no.
`checkout_id`	string	Corresponde al identificador único del carrito de compras asociado a la orden.
`customer_id`	string	Corresponde al identificador único del cliente que genero la orden.
`payment.method`	int	Corresponde al método de pago utilizado en la orden. 1: Mercado Pago, 2: Efectivo, 3: Acordar con el vendedor, 4: Todo Pago (deprecated), 5: Transferencia bancaria, 6: Mobbex, 7: Ualá Bis.
`payment.status`	int	Corresponde al estado de pago de la orden. -1: Esperando pago, 0: Pendiente, 1: Finalizado, 2: En proceso, 3: En mediación, 4: Rechazada, 5: Cancelada, 6: Pago devuelto, 7: En contracargo.
`payment.main_reference_id`	string	Corresponde al identificador principal de la integración utilizada para el cobro de la orden y su semántica depende del `payment.method`: 1: Almacena el preference id de Mercado Pago, 2: null, 3: null, 4: deprecated, 5: null, 6: Almacena el id de checkout de Mobbex, 7: Almacena el uuid de Ualá Bis.
`payment.extra_reference_id`	string	Corresponde al identificador secundario de la integración utilizada para el cobro de la orden y su semántica depende del `payment.method`: 1: Almacena el payment id de Mercado Pago, 2: null, 3: null, 4: deprecated, 5: null, 6: Almacena el payment id o transaction id de Mobbex, 7: Almacena el ref number de Ualá Bis.
`payment.method_discount`	float	Indica si se hizo un descuento por abonar la orden con cierto método de pago. En caso de que su valor sea 0, entonces no se hizo dicho descuento. Almacena el mismo valor que `payment_method_discount`.
`shipment.method`	int	Almacena el método de envío utilizado para la orden. 1: Mercado Envíos, 2: Retiro en local, 3: Acordar con el vendedor, 4: Emprepack, 5: Envíos personalizados, 6: OCA, 7: Email, 8: Correo Argentino, 9: E-Pick.
`shipment.status`	int	Corresponde al estado actual del envío de la orden. Estos estados no cambian automáticamente, dependen del usuario. Utilizado para filtrado. 0: Pendiente, 1: En preparación, 2: Enviado.
`shipment.price`	float	Corresponde al costo del envío de la orden. Almacena el mismo valor que `shipment_price`.
`shipment.free_shipment_price`	float	Corresponde al costo del envío que fue absorbido por ofrecer envío gratis.
`shipment.tracking_number`	string	Corresponde al número de seguimiento del envío.
`shipment.reference_id`	string	Corresponde al identificador del envío en la plataforma correspondiente.
`shipment.main_label`	string	Corresponde al link de la etiqueta de envío de la orden.
`shipment.extra_label`	string	Corresponde al link de la etiqueta secundaria o remito de envío de la orden.
`shipment.contact.email`	string	Corresponde al email de contacto de quién recibe la orden.
`shipment.contact.name`	string	Corresponde al nombre de quién recibe la orden.
`shipment.contact.surname`	string	Corresponde al apellido de quién recibe la orden.
`shipment.contact.identification.type`	string	Corresponde al tipo de identificación de quién recibe la orden.
`shipment.contact.identification.value`	string	Corresponde al número de identificación de quién recibe la orden.
`shipment.contact.phone`	string	Corresponde al número de teléfono de quién recibe la orden.
`shipment.address.street`	string	Corresponde a la calle de quién recibe la orden.
`shipment.address.number`	string	Corresponde al número de calle de quién recibe la orden.
`shipment.address.floor`	string	Corresponde al piso de quién recibe la orden.
`shipment.address.apartment`	string	Corresponde al apartamento de quién recibe la orden.
`shipment.address.city`	string	Corresponde a la ciudad de quién recibe la orden.
`shipment.address.state`	string	Corresponde al estado o provincia de quién recibe la orden.
`shipment.address.zip_code`	string	Corresponde al código postal de quién recibe la orden.
`shipment.address.country`	string	Corresponde al país de quién recibe la orden.
`shipment.address.notes`	string	Corresponde a las notas de envío.
`shipment.metadata.days`	string	Corresponde a los días que aproximadamente demora el envío luego de ser despachado.
`shipment.metadata.method`	int	Corresponde al método de envío, posee el mismo valor que `shipment.method`.
`shipment.metadata.type`	int	Corresponde a información adicional al tipo de envío. Valores: Si es Mercado Envíos → 0: Envío a domicilio. Si es Retiro en local → x>0: id del local utilizado. Si es Acordar con el vendedor → 0: Default. Si es Emprepack → 1: Envío a sucursal, 2: Envío a domicilio, 3: Envío a domicilio prioritario. Si es Envíos personalizados → x>0: id de envío personalizado utilizado. Si es OCA → 1: Envío a sucursal, 2: Envío a domicilio. Si es Email → 0: Default. Si es Correo Argentino → 1: Envío a sucursal, 2: Envío a domicilio, 3: Envío a domicilio prioritario. Si es E-Pick → 2: Envío a domicilio.
`shipment.metadata.subtype`	int	Agrega información extra al `shipment.metadata.type`. Valores: Si es Mercado Envíos → 0: Default. Si es Retiro en local → 0: Default. Si es Acordar con el vendedor → 0: Default. Si es Emprepack → si es envío a sucursal: X representa el id de sucursal de destino, si es envío a domicilio: 0 Default. Si es Envíos personalizados → 0: Default. Si es OCA → si es envío a sucursal: X representa el id de sucursal de destino, si es envío a domicilio: 0 Default. Si es Email → 0: Default. Si es Correo Argentino → si es envío a sucursal: X>0 representa el id de la sucursal de destino, si es envío a domicilio: 0 Default. Si es E-Pick → 0: Default.
`shipment.metadata.description`	[string]	Agrega información extra del destino si corresponde a una sucursal o un punto de retiro.
`billing.invoice.invoiced`	boolean	Indica si la orden fue marcada manualmente como facturada o no.
`billing.invoice.link`	string	Corresponde al link del pdf de la factura en caso de que haya sido facturada.
`billing.invoice.reference_id`	string	Corresponde al id de la factura en la plataforma integradora de facturación.
`billing.contact.email`	string	Corresponde al email de contacto de quién abona la orden.
`billing.contact.name`	string	Corresponde al nombre de quién abona la orden.
`billing.contact.surname`	string	Corresponde al apellido de quién abona la orden.
`billing.contact.identification.type`	string	Corresponde al tipo de identificación de quién abona la orden.
`billing.contact.identification.value`	string	Corresponde al número de identificación de quién abona la orden.
`billing.contact.phone`	string	Corresponde al número de teléfono de quién abona la orden.
`billing.address.street`	string	Corresponde a la calle de quién abona la orden.
`billing.address.number`	string	Corresponde al número de calle de quién abona la orden.
`billing.address.floor`	string	Corresponde al piso de quién abona la orden.
`billing.address.apartment`	string	Corresponde al apartamento de quién abona la orden.
`billing.address.city`	string	Corresponde a la ciudad de quién abona la orden.
`billing.address.state`	string	Corresponde al estado o provincia de quién abona la orden.
`billing.address.zip_code`	string	Corresponde al código postal de quién abona la orden.
`billing.address.country`	string	Corresponde al país de quién abona la orden.
`products[]`	[object]	Corresponde a la lista de productos de la orden.
`products[].stock_id`	string	Corresponde al stock_id vinculado al producto. Un producto puede tener diferentes variantes de stock.
`products[].product_id`	string	Corresponde al product_id del producto.
`products[].price`	float	Corresponde al precio unitario del producto.
`products[].quantity`	int	Corresponde a la cantidad de unidades compradas del producto en cuestión.
`products[].name`	string	Corresponde al nombre del producto.
`products[].sku`	string	Corresponde al sku del producto.
`products[].height`	int	Corresponde a la altura del producto en su paquete en cm.
`products[].weight`	float	Corresponde al peso del producto en kg.
`products[].width`	int	Corresponde al ancho del producto en su paquete en cm.
`products[].depth`	int	Corresponde a la profundidad del producto en su paquete en cm.
`products[].digital`	boolean	Indica si el producto es digital o no. En caso de serlo, el mismo no contendrá dimensiones físicas.
`products[].attributes[]`	[object]	Corresponde al array de atributos del producto (ej: color, talle, etc) del stock_id en cuestión.
`products[].attributes[].name`	string	Corresponde al nombre del atributo (ej: Color, Talle).
`products[].attributes[].value`	string	Corresponde al valor del atributo (ej: Rojo, Verde, L, XL).

Responses de error

En caso de que la respuesta http no sea 200, entonces se debe considerar el error.

Atributo	Tipo	Descripción
`status`	int	Http code de respuesta.
`code`	string	Código de error, indica la naturaleza del mismo.
`msg`	string	Mensaje de error.

Ejemplo response 401 Unauthorized:


{
  "status": 401,
  "code": "error",
  "msg": "Unauthorized"
}

Ejemplo response 400 Bad Request genérico:


{
  "status": 400,
  "code": "request_error",
  "msg": "Send valid data"
}

Ejemplo response 400 Bad Request si algún parámetro de entrada requerido no es enviado:


{
  "status": 400,
  "code": "param_required",
  "msg": "invalid <param_name>. The value is required"
}

Ejemplo response 400 Bad Request si algún parámetro de entrada es inválido:


{
  "status": 400,
  "code": "param_invalid",
  "msg": "Invalid <param_name>. The value is invalid"
}

Ejemplo response 500 Internal Server Error:


{
  "status": 500,
  "code": "server_error",
  "msg": "Something went wrong"
}