Questo guida crea i due lavori più necessari per i fornitori:
- Sincronizzazione notturna: invia prodotti e clienti dal tuo ERP a TradeCatalog.
- Poller degli ordini: ogni pochi minuti, estrai nuovi ordini nel tuo ERP e segnali come ricevuti.
Hai bisogno di una chiave API Read & write. Vedi Autenticazione.
Come si comporta la sincronizzazione notturnaCollegamento a questa sezione#
- I prodotti vengono abbinati per SKU e i clienti per codice account, quindi eseguire la sincronizzazione due volte è innocuo.
- I nuovi prodotti vengono attivati al loro prezzo di listino immediatamente.
- I prezzi di listino modificati non vengono attivati. Si accumulano in modifiche dei prezzi in bozza. Ogni mattina qualcuno apre Modifiche dei prezzi nell'app, controlla l'anteprima e gli avvisi, seleziona una data e pubblica. I clienti possono essere inviati le loro nuove tariffe.
brand,category,manufacturerRefedescriptionvengono scritti come inviati, quindi invia sempre il prodotto completo.- I
emailediscountBpdei clienti vengono scritti come inviati:nullli cancella.
Invia solo ciò che è cambiato
Se il tuo ERP può dirti quali prodotti sono cambiati dall'ultima esecuzione, invia solo quelli. Meno richieste, e meno prodotti da scansionare in ogni bozza.
Sincronizzazione notturna (Node.js)Collegamento a questa sezione#
Richiede Node.js 20 o versione successiva, per il fetch integrato. Sostituisci le due funzioni fromErp con letture dal tuo sistema.
// sync.mjs — run nightly: TRADECATALOG_API_KEY=tc_live_… node sync.mjs
const BASE = 'https://tradecatalog.app/api/v1'
const KEY = process.env.TRADECATALOG_API_KEY
const sleep = (seconds) => new Promise((r) => setTimeout(r, seconds * 1000))
async function api(method, path, body, attempt = 0) {
const res = await fetch(BASE + path, {
method,
headers: {
Authorization: `Bearer ${KEY}`,
'Content-Type': 'application/json',
},
body: body && JSON.stringify(body),
})
if ((res.status === 429 || res.status >= 500) && attempt < 5) {
await sleep(Number(res.headers.get('Retry-After')) || 2 ** attempt)
return api(method, path, body, attempt + 1)
}
const json = await res.json()
if (!res.ok) {
const detail = json.error.issues
?.map((i) => `${i.path}: ${i.message}`)
.join('; ')
throw new Error(`${method} ${path}: ${json.error.message} ${detail ?? ''}`)
}
return json
}
// Replace these with reads from your ERP. Money in pence, discounts in basis points.
async function productsFromErp() {
return [
{
sku: 'HX-8510',
name: 'Hex bolt M10 x 50 zinc',
listPrice: 1950,
unitLabel: 'Box of 100',
brand: 'Northgate',
category: 'Bolts',
availability: 'in_stock',
},
]
}
async function customersFromErp() {
return [
{
accountCode: 'OAK01',
name: 'Oakfield Joinery',
email: 'accounts@oakfieldjoinery.co.uk',
discountBp: 500,
},
]
}
const batches = (rows, size = 100) =>
Array.from({ length: Math.ceil(rows.length / size) }, (_, i) =>
rows.slice(i * size, i * size + size),
)
const { data: workspace } = await api('GET', '/workspace')
console.log(`Syncing into ${workspace.name} (${workspace.currency})`)
for (const customers of batches(await customersFromErp())) {
const { data } = await api('PUT', '/customers', { customers })
console.log(`Customers: ${data.created} new, ${data.updated} updated`)
}
// Every batch adds its price changes to the same draft.
let priceChangeId
for (const products of batches(await productsFromErp())) {
const { data } = await api('PUT', '/products', { products, priceChangeId })
console.log(`Products: ${data.created} new, ${data.updated} updated`)
priceChangeId = data.priceChangeId ?? priceChangeId
if (data.unknownCustomers.length)
console.warn('Unknown customers in onlyFor:', data.unknownCustomers)
}
if (priceChangeId) {
const { data } = await api('GET', `/price-changes/${priceChangeId}`)
console.log(
`Draft price change: ${data.counts.up} up, ${data.counts.down} down,` +
` ${data.warnings.length} warnings. Publish it in TradeCatalog → Price changes.`,
)
}
I clienti vanno per primi, quindi i prodotti con onlyFor possono trovarli.
Esegui il programma da cron, da un compito pianificato o dal runner di job del tuo ERP:
0 2 * * * cd /opt/tradecatalog && TRADECATALOG_API_KEY=tc_live_… node sync.mjs >> sync.log 2>&1
Poller degli ordini (Node.js)Collegamento a questa sezione#
Ogni pochi minuti, recupera nuovi ordini, passa ciascuno al tuo ERP e poi segnali come ricevuti. Il cliente riceverà un'email che dice che il loro ordine è stato ricevuto.
// orders.mjs — run every 5 minutes. Copy BASE, KEY, sleep and api() from sync.mjs.
async function sendToErp(order) {
// Create the sales order in your system. Use order.reference as its external
// reference, and check it first so a retry can't create it twice.
console.log(
`${order.reference} for ${order.customer.accountCode}: ${order.lines.length} lines`,
)
}
const { data: newOrders } = await api('GET', '/orders?status=new')
for (const summary of newOrders.reverse()) {
const { data: order } = await api('GET', `/orders/${summary.id}`)
await sendToErp(order)
await api('PATCH', `/orders/${order.id}`, { status: 'acknowledged' })
}
Gli ordini più vecchi vengono gestiti per primi (reverse()), perché la lista è ordinata per data più recente.
Se il passo del tuo ERP ha successo ma il PATCH fallisce, l'ordine è ancora new la prossima volta. Per questo motivo sendToErp dovrebbe verificare se ci sono order.reference prima di creare qualcosa.
Più tardi, quando un ordine viene spedito, segnalo come spedito con i dettagli di tracciamento nel nota:
await api('PATCH', `/orders/${orderId}`, {
status: 'dispatched',
note: 'DPD tracking 1554 2210 0931',
})
Poller degli ordini (Python)Collegamento a questa sezione#
Lo stesso poller con requests:
# orders.py: run every 5 minutes. TRADECATALOG_API_KEY=tc_live_… python orders.py
import os
import time
import requests
BASE = "https://tradecatalog.app/api/v1"
session = requests.Session()
session.headers["Authorization"] = f"Bearer {os.environ['TRADECATALOG_API_KEY']}"
def api(method, path, body=None, attempt=0):
res = session.request(method, BASE + path, json=body, timeout=30)
if (res.status_code == 429 or res.status_code >= 500) and attempt < 5:
time.sleep(int(res.headers.get("Retry-After", 2**attempt)))
return api(method, path, body, attempt + 1)
data = res.json()
if not res.ok:
raise RuntimeError(f"{method} {path}: {data['error']['message']}")
return data
def send_to_erp(order):
# Create the sales order in your system; skip it if order["reference"] exists.
print(order["reference"], order["customer"]["accountCode"], len(order["lines"]), "lines")
for summary in reversed(api("GET", "/orders?status=new")["data"]):
order = api("GET", f"/orders/{summary['id']}")["data"]
send_to_erp(order)
api("PATCH", f"/orders/{order['id']}", {"status": "acknowledged"})
Denaro e codiciCollegamento a questa sezione#
listPrice,unitPrice,lineTotaletotalsono in unità minori (pence per GBP). Dividi per 100 per ottenere sterline.- I prezzi degli ordini sono come li hai impostati: prima delle tasse se il tuo
taxLabeldice “escl. …” (il tuo ERP aggiunge l'IVA quando emette la fattura), inclusa la tassa se dice “incl. …”. - Usa i codici account dei clienti del tuo ERP come codici account di TradeCatalog, in modo che entrambi i sistemi si corrispondano senza una tabella di ricerca.
Limiti da pianificareCollegamento a questa sezione#
- 100 righe per
PUT, e 120 richieste al minuto per chiave. Un catalogo di 10.000 prodotti è 100 richieste, circa un minuto. GET /orderscopre i 200 ordini più recenti corrispondenti. Esegui il poll spesso abbastanza che meno di 200 nuovi ordini arrivino tra un'elaborazione e l'altra.- La pubblicazione delle modifiche dei prezzi, delle regole degli sconti e dei prezzi concordati viene effettuata nell'app.