1. Ayuda
  2. Desarrolladores
  3. Carritos API
Regresar

Carritos API

Carritos contienen una serie de items con productos que representan la intención de compra.

Para generar y modificar carritos es necesario agregar el header Channel-Key, que se muestra en la vista del canal API dentro del administrador.

Objeto de Carrito

Atributo Tipo Descripción
id cadena Identificador único del carrito.
object cadena El nombre del tipo de objeto.
items arreglo Los productos relacionados con el carrito.
is_gift boleano Indica si el carrito fue marcada como regalo.
gift_message cadena El mensaje de regalo del carrito.
source_name cadena El medio por el cual fue creada el carrito.
customer_note cadena La nota agregada por el cliente a el carrito.
browser_ip cadena IP desde donde se creó el carrito.
user_agent cadena Información sobre el cliente o navegador desde donde se creo el carrito.
landing_site cadena Página desde dónde se creo la órden.
referring_site cadena Página desde dónde visito el cliente antes de crear el carrito.
total_products entero Cantidad total de productos en el carrito.
total_items entero Cantidad total de productos y su cantidad en el carrito.
total_price entero Total del carrito.
total_compared_price entero Total del carrito con precios antes de cualquier descuento.
currency cadena Moneda en la cual fue pagada el carrito.
total_weight entero Total de peso de los productos en el carrito.
created_at timestamp Fecha de creación del carrito.
updated_at timestamp Última fecha de actualización del carrito.

Consultar un Carrito

GET /v1/carts/{id}
{
  "data": {
    "id": "crt_cjgfgqad3000013o2v8dzo0s7",
    "is_gift": true,
    "gift_message": "Regalito",
    "source_name": "api",
    "customer_note": "Verificar acabado",
    "browser_ip": "127.0.0.1",
    "user_agent": "rest-client",
    "landing_site": "",
    "referring_site": "",
    "total_products": 2,
    "total_items": 3,
    "total_price": 40000,
    "total_compared_price": 0,
    "total_weight": 5000,
    "currency": "MXN",
    "created_at": 1524682728,
    "updated_at": 1524684026,
    "object": "cart",
    "items": [
      {
        "id": "itm_cjgfhclr00001aro2tbg2te1l",
        "cart_id": "crt_cjgfgqad3000013o2v8dzo0s7",
        "product_id": "prd_cjgff061n000013o22ef8a508",
        "sku_id": "sku_cjgff06q9000113o2wzmfyvzq",
        "quantity": 1,
        "price": 10000,
        "compared_price": 0,
        "total": 10000,
        "weight": 1000,
        "created_at": 1524683769,
        "updated_at": 1524683904,
        "object": "cart_item",
        "sku": {
          "id": "sku_cjgff06q9000113o2wzmfyvzq",
          "object": "sku",
          "permalink": "default",
          "name": "Default",
          "code": null,
          "price": 10000,
          "compared_price": 0,
          "modifiers": null,
          "is_listable": true,
          "is_taxable": false,
          "is_shipping_required": true,
          "stock_policy": "none",
          "is_backorderable": false,
          "in_stock": null,
          "is_notify": null,
          "low_threshold": null,
          "weight_unit": "kg",
          "weight_source": 1,
          "weight": 1000,
          "position": 1,
          "product_id": "prd_cjgff061n000013o22ef8a508",
          "created_at": 1524679830,
          "updated_at": 1524679830,
          "image_url": null
        },
        "product": {
          "id": "prd_cjgff061n000013o22ef8a508",
          "object": "product",
          "permalink": "test-product",
          "name": "Test Product",
          "excerpt": null,
          "description": null,
          "modifiers": null,
          "meta_title": "Test Product",
          "meta_description": null,
          "meta_keywords": null,
          "hidden_on": [],
          "is_active": true,
          "available_at": 1524679800,
          "created_at": 1524679829,
          "updated_at": 1524679829,
          "price": 10000,
          "compared_price": 0,
          "image_url": null
        }
      },
      {
        "id": "itm_cjgfhclmv0000aro2hod30z0e",
        "cart_id": "crt_cjgfgqad3000013o2v8dzo0s7",
        "product_id": "prd_cjgff0zr0000013o20rfypz7v",
        "sku_id": "sku_cjgff0zsp000113o29zwjilz8",
        "quantity": 2,
        "price": 15000,
        "compared_price": 0,
        "total": 30000,
        "weight": 2000,
        "created_at": 1524683769,
        "updated_at": 1524684026,
        "object": "cart_item",
        "sku": {
          "id": "sku_cjgff0zsp000113o29zwjilz8",
          "object": "sku",
          "permalink": "1",
          "name": "1",
          "code": null,
          "price": 15000,
          "compared_price": 0,
          "modifiers": [
            "1"
          ],
          "is_listable": true,
          "is_taxable": true,
          "is_shipping_required": true,
          "stock_policy": "none",
          "is_backorderable": false,
          "in_stock": null,
          "is_notify": null,
          "low_threshold": null,
          "weight_unit": "kg",
          "weight_source": 2,
          "weight": 2000,
          "position": 1,
          "product_id": "prd_cjgff0zr0000013o20rfypz7v",
          "created_at": 1524679868,
          "updated_at": 1524682213,
          "image_url": null
        },
        "product": {
          "id": "prd_cjgff0zr0000013o20rfypz7v",
          "object": "product",
          "permalink": "test-shirt",
          "name": "Test Shirt",
          "excerpt": null,
          "description": null,
          "modifiers": [
            "Talla"
          ],
          "meta_title": "Test Shirt",
          "meta_description": null,
          "meta_keywords": null,
          "hidden_on": [],
          "is_active": true,
          "available_at": 1524679800,
          "created_at": 1524679868,
          "updated_at": 1524679868,
          "price": 15000,
          "compared_price": 0,
          "image_url": null
        }
      }
    ]
  }
}

Parámetros

Ningúno.

Crear un Carrito

POST /v1/carts

Carga útil

Un objeto con los siguientes elementos:

Nombre Tipo Requerido Descripción
is_gift boleano false Indica si el carrito es un regalo.
gift_message cadena false La nota de regalo en caso de que sea un carrito de regalo.
note cadena false Información o comentarios que el cliente quiera agregar a su carrito.
items[] cadena false Los items que se agregarán al carrito. La estructura es un objeto donde cada llave es el id de una variante y el valor el número de items a agregar.

Si es exitoso la respuesta será un objeto de carrito.

Ejemplos

Crear un carrito vacío.

{
}

Crear un carrito con algunos productos.

{
    "items": {
        "sku_cjgff0zsp000113o29zwjilz8": 2,
        "sku_cjgff06q9000113o2wzmfyvzq": 1
    }
}

Crear un producto especificando todas las opciones.

{
    "is_gift": true,
    "gift_message": "¡Feliz cumpleaños!",
    "note": "Verificar que los productos sean en acabado mate",
    "items": {
        "sku_cjgff0zsp000113o29zwjilz8": 2,
        "sku_cjgff06q9000113o2wzmfyvzq": 1
    }
}

Actualizar un Carrito

PUT /v1/carts/{id}

Carga útil

La misma que al crear un carrito.

Ejemplos

Agregar un nuevo item con tres productos.

{
    "items": {
        "sku_cjgff0zsp0001133rfgyj42qd": 3
    }
}

Actualizar el número de productos de un item.

{
    "items": {
        "sku_cjgff0zsp0001133rfgyj42qd": 4
    }
}

Eliminar un producto del carrito.

{
    "items": {
        "sku_cjgff0zsp0001133rfgyj42qd": 0
    }
}

Actualizar la información de regalo y nota de cliente.

{
    "is_gift": true,
    "gift_message": "Felicidades amigo",
    "note": "Acabado brillante por favor",
}

Quitar información de regalo.

{
    "is_gift": false
}

_La nota de regalo gift_message se elimina automáticamente cuando is_gift es falso._

Checkout de un Carrito

Consulta la documentación de Checkouts para ver cómo realizar el checkout de un carrito.