Saltar al contenido
Comience gratis
Menú de documentos

Comience

API REST

MCP

Guías

Referencia

Comience

Inicio rápido

Cree una clave de API y realice sus primeras llamadas a la API de TradeCatalog en cinco minutos.

Ver como MarkdownAbrir en ClaudeAbrir en ChatGPT

Es necesario que sea el propietario de un espacio de trabajo de TradeCatalog con una asignación Pro o una cuenta de prueba. Los espacios de trabajo de demo no pueden usar la API.

1. Cree una clave de APIEnlace a esta sección#

  1. Abra su espacio de trabajo y vaya a Configuración → API.
  2. Asigne un nombre a la clave que pueda reconocer más tarde, como "sincronización de stock de Sage".
  3. Elija Solo lectura para buscar información, o Lectura y escritura para actualizar productos, clientes y pedidos.
  4. Elija Crear clave y cópiela. Comienza con tc_live_.

Cópiela ahora

Solo mostramos una clave una vez y solo guardamos un hash de ella. Si la pierde, revóquela y cree una nueva.

Coloque la clave en una variable de entorno para que no esté en su código:

bash
export TRADECATALOG_API_KEY="tc_live_…"

2. Compruebe que la clave funcioneEnlace a esta sección#

bash
curl https://tradecatalog.app/api/v1/workspace \
  -H "Authorization: Bearer $TRADECATALOG_API_KEY"
json
{
  "data": {
    "id": "0b6c1f5e-6f7a-4a57-9a0c-2f4d4c1e8a11",
    "slug": "northgate",
    "name": "Northgate Fixings",
    "currency": "GBP",
    "timezone": "Europe/London",
    "taxLabel": "ex VAT",
    "key": { "name": "Sage stock sync", "scope": "write" }
  }
}

3. Buscar productosEnlace a esta sección#

bash
curl "https://tradecatalog.app/api/v1/products?q=hinge&limit=2" \
  -H "Authorization: Bearer $TRADECATALOG_API_KEY"

El dinero siempre está en unidades menores de la moneda del espacio de trabajo, por lo tanto 1850 es £18.50. Vea Convenciones.

4. Obtener el precio de un clienteEnlace a esta sección#

Pase el código de cuenta (o id) de un cliente y un SKU:

bash
curl "https://tradecatalog.app/api/v1/prices?customer=OAK01&sku=HX-8510&qty=10" \
  -H "Authorization: Bearer $TRADECATALOG_API_KEY"
json
{
  "data": {
    "customer": {
      "id": "7d2e4f0a-1b3c-4d5e-8f90-a1b2c3d4e5f6",
      "accountCode": "OAK01",
      "name": "Oakfield Joinery"
    },
    "sku": "HX-8510",
    "name": "Hex bolt M10 x 50 zinc",
    "qty": 10,
    "unit": 1573,
    "line": 15730,
    "list": 1850,
    "discountBp": 1500,
    "source": "brand",
    "label": "Brand discount −15%"
  },
  "currency": "GBP"
}

Cómo se calculan los precios explica source y label.

5. Crear o actualizar un productoEnlace a esta sección#

Esto requiere una clave de Lectura y escritura.

bash
curl -X PUT https://tradecatalog.app/api/v1/products \
  -H "Authorization: Bearer $TRADECATALOG_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "products": [
      {
        "sku": "HX-8512",
        "name": "Hex bolt M12 x 50 zinc",
        "listPrice": 2240,
        "unitLabel": "Box of 100",
        "brand": "Northgate",
        "category": "Bolts"
      }
    ]
  }'
json
{
  "data": {
    "created": 1,
    "updated": 0,
    "priceChanges": 0,
    "priceChangeId": null,
    "unknownCustomers": []
  }
}

Los nuevos productos se ponen en marcha inmediatamente a su precio de lista. Si envía un precio diferente para un producto que ya tiene uno, el precio no cambia aún. Va a un cambio de precio en borrador que revisa y publica en la aplicación. Vea Productos.

Lo mismo en JavaScriptEnlace a esta sección#

js
const api = (path, init = {}) =>
  fetch(`https://tradecatalog.app/api/v1${path}`, {
    ...init,
    headers: {
      Authorization: `Bearer ${process.env.TRADECATALOG_API_KEY}`,
      'Content-Type': 'application/json',
      ...init.headers,
    },
  }).then(async (res) => {
    const body = await res.json()
    if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`)
    return body
  })

const { data: workspace } = await api('/workspace')
const { data: price } = await api('/prices?customer=OAK01&sku=HX-8510&qty=10')
console.log(`${workspace.name}: ${price.name} is ${price.unit / 100} each`)

Pasos siguientesEnlace a esta sección#