API

Carrelli

Carrelli condivisibili che si chiudono su WhatsApp

Panoramica

I carrelli permettono a un visitatore del tuo negozio di comporre una lista di prodotti e portarla in una conversazione su WhatsApp con tutto il contesto. Un carrello è un'istantanea di breve durata: riceve un codice di 7 caratteri, è valido per 90 giorni ed è immutabile: per cambiarlo, creane uno nuovo.

Come funziona il flusso

Un visitatore del tuo negozio compone una lista di prodotti.
Il tuo negozio crea un carrello con POST /v1/carts e riceve un codice breve.
Mandi al visitatore un link come https://<tuo-negozio>/c/<codice> su WhatsApp.
Quando inizia la conversazione, il tuo agente ha già tutto il contesto di quello che il visitatore ha scelto.

Endpoint

Metodo	Percorso	Descrizione
POST	`/v1/carts`	Crea un carrello condivisibile
GET	`/v1/carts/:code`	Risolvi un carrello dal codice

Creare un carrello

Invia da 1 a 50 articoli, ognuno con un id di prodotto e una qty tra 1 e 99. La risposta è il codice breve del carrello:

POST/v1/carts

curl -X POST "https://rest-api.tbit.app/v1/carts" \
  -H "X-API-Key: $TBIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "items": [
      {
        "id": "prod_id_1",
        "qty": 2
      },
      {
        "id": "prod_id_2",
        "qty": 1
      }
    ]
  }'

const response = await fetch('https://rest-api.tbit.app/v1/carts', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.TBIT_API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    items: [
      {
        id: 'prod_id_1',
        qty: 2,
      },
      {
        id: 'prod_id_2',
        qty: 1,
      },
    ],
  }),
});
const data = await response.json();

import axios from 'axios';

const { data } = await axios.post(
  'https://rest-api.tbit.app/v1/carts',
  {
    items: [
      {
        id: 'prod_id_1',
        qty: 2,
      },
      {
        id: 'prod_id_2',
        qty: 1,
      },
    ],
  },
  {
    headers: {
      'X-API-Key': process.env.TBIT_API_KEY,
    },
  },
);

import os
import requests

response = requests.post(
    'https://rest-api.tbit.app/v1/carts',
    headers={'X-API-Key': os.environ['TBIT_API_KEY']},
    json={
        'items': [
            {
                'id': 'prod_id_1',
                'qty': 2,
            },
            {
                'id': 'prod_id_2',
                'qty': 1,
            },
        ],
    },
)
data = response.json()

<?php
$ch = curl_init('https://rest-api.tbit.app/v1/carts');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'X-API-Key: ' . getenv('TBIT_API_KEY'),
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode([
        'items' => [
            [
                'id' => 'prod_id_1',
                'qty' => 2,
            ],
            [
                'id' => 'prod_id_2',
                'qty' => 1,
            ],
        ],
    ]),
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

Risposta

{
  "data": {
    "code": "K3F9X2A"
  }
}

Ottenere un carrello

Risolve un codice nei suoi articoli, ognuno un oggetto prodotto completo più qty. I carrelli sono isolati per account: una chiave risolve solo i carrelli creati per il proprio agente; qualsiasi altra cosa restituisce 404:

GET/v1/carts/K3F9X2A

curl "https://rest-api.tbit.app/v1/carts/K3F9X2A" \
  -H "X-API-Key: $TBIT_API_KEY"

const response = await fetch('https://rest-api.tbit.app/v1/carts/K3F9X2A', {
  headers: {
    'X-API-Key': process.env.TBIT_API_KEY,
  },
});
const data = await response.json();

import axios from 'axios';

const { data } = await axios.get(
  'https://rest-api.tbit.app/v1/carts/K3F9X2A',
  {
    headers: {
      'X-API-Key': process.env.TBIT_API_KEY,
    },
  },
);

import os
import requests

response = requests.get(
    'https://rest-api.tbit.app/v1/carts/K3F9X2A',
    headers={'X-API-Key': os.environ['TBIT_API_KEY']},
)
data = response.json()

<?php
$ch = curl_init('https://rest-api.tbit.app/v1/carts/K3F9X2A');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'X-API-Key: ' . getenv('TBIT_API_KEY'),
    ],
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

Risposta

{
  "data": {
    "code": "K3F9X2A",
    "created_at": "2024-09-01T12:00:00Z",
    "items": [
      {
        "_id": "prod_id_1",
        "kind": "product",
        "title": "Kit fiesta dinosaurios",
        "currency": "COP",
        "base_price": 95000,
        "qty": 2
      },
      {
        "_id": "prod_id_2",
        "kind": "product",
        "title": "Piñata dinosaurio",
        "currency": "COP",
        "base_price": 45000,
        "qty": 1
      }
    ]
  }
}

Note

I codici hanno 7 caratteri.
I carrelli sono validi per 90 giorni.
I carrelli sono immutabili: creane uno nuovo per cambiare gli articoli.
I carrelli di altri agenti (o codici sconosciuti) restituiscono 404.