Pular para o conteúdo
Comece gratuitamente
Menu de documentos

Comece agora

API REST

MCP

Guias

Referência

Comece agora

Início rápido

Crie uma chave de API e faça suas primeiras chamadas à API do TradeCatalog em cinco minutos.

Visualizar como MarkdownAbrir no ClaudeAbrir no ChatGPT

Você precisa ser o proprietário de um workspace do TradeCatalog com uma concessão Pro ou uma conta de pilotagem. Workspaces de demonstração não podem usar a API.

1. Crie uma chave de APILink para esta seção#

  1. Abra seu workspace e vá para Configurações → API.
  2. Dê um nome à chave que você reconhecerá mais tarde, como "sincronização de estoque do Sage".
  3. Escolha Somente leitura para pesquisar, ou Leitura e gravação para atualizar produtos, clientes e pedidos.
  4. Escolha Criar chave e copie-a. Ela começa com tc_live_.

Copie agora

Mostramos uma chave apenas uma vez, e mantemos apenas um hash dela. Se você a perder, revogue-a e crie uma nova.

Coloque a chave em uma variável de ambiente para mantê-la fora do seu código:

bash
export TRADECATALOG_API_KEY="tc_live_…"

2. Verifique se a chave funcionaLink para esta seção#

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. Pesquisar produtosLink para esta seção#

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

O dinheiro está sempre em unidades menores da moeda do workspace, então 1850 é £18.50.. Veja Convenções.

4. Obter o preço de um clienteLink para esta seção#

Passe o código (ou ID) da conta do cliente e um 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"
}

Como os preços são calculados explica source e label.

5. Criar ou atualizar um produtoLink para esta seção#

Isso requer uma chave de Leitura e gravação.

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": []
  }
}

Novos produtos entram em vigor imediatamente com seu preço de lista. Se você enviar um preço diferente para um produto que já tem um, o preço não muda ainda. Ele entra em uma alteração de preço em rascunho que você revisa e publica no app. Veja Produtos.

O mesmo em JavaScriptLink para esta seção#

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`)

Próximos passosLink para esta seção#