Caso d'uso per BSS B2B Solution

Sincronizzare regole e clienti B2B con l’ERP tramite API

Usi la Public API di BSS B2B Solution per creare e aggiornare regole Custom Pricing, Price List, Volume Pricing e dati di registrazione dal Suo ERP o PIM con una chiave API, invece di modificare le regole a mano.

  • App: BSS B2B Solution
  • Modello di business: Distributore
  • Funzionalità chiave: Public API

Ultimo aggiornamento

Revisionato da Hoa Nguyen. Ultima revisione

Scheda della chiave API in BSS B2B Solution subito dopo la generazione, con la chiave nascosta e i pulsanti Copy e Download
  • 4,9/5 1.190 recensioni di BSS B2B Solution nello Shopify App Store
  • Built for Shopify Badge che Shopify assegna alle app che rispettano i suoi standard di qualità
  • 20 lingue supportate nell'app

Il problema

Prezzi, clienti e regole vivono già in un ERP, un PIM o un foglio di calcolo, e nessuno vuole mantenerli una seconda volta nell’app. Copiare le modifiche a mano è lento, e i due sistemi si disallineano. Con i cataloghi grandi il problema peggiora ogni mese.

Il risultato

Il Suo sviluppatore o partner di integrazione invia le regole di prezzo dal sistema di riferimento a BSS B2B Solution con una chiave API. Le regole attive vengono caricate nel tema live, e la scheda Logs and usage mostra ogni richiesta e il motivo di un errore.

come funziona

Come funziona

  1. Verifichi il piano

    La Public API fa parte del piano Platinum. Verifichi il piano prima di pianificare qualsiasi lavoro di integrazione.

  2. Generi la chiave API

    Apra Integrations nell’app, trovi la scheda Public API, scelga Get API key e generi la chiave. La copi o la scarichi subito, perché viene mostrata una sola volta.

  3. Invii una prima richiesta

    Richiami un endpoint della versione 1 con il dominio del negozio e la chiave, sia come campo accessKey nel corpo sia nell’header x-bss-b2b-api-key.

  4. Scriva le regole dai dati dell’ERP

    Crei, aggiorni o elimini record di Custom Pricing, Price List, Volume Pricing, Discount Code e registrazione con il gruppo di endpoint corrispondente, in blocco dove l’endpoint lo consente.

  5. Carichi le regole attive

    Richiami l’endpoint di upload per il modulo così che le regole attive arrivino al tema attivo, al massimo una volta per modulo ogni 5 minuti.

  6. Controlli i log

    Apra Logs and usage per vedere ogni richiesta, il suo stato e la richiesta e la risposta complete quando qualcosa fallisce.

Per sincronizzare i prezzi B2B da un ERP a Shopify, usi la Public API di BSS B2B Solution: generi una chiave API con il piano Platinum, poi il Suo sviluppatore o partner di integrazione crea, aggiorna ed elimina le regole Custom Pricing, Price List e Volume Pricing dal sistema di riferimento, e richiama l’endpoint di upload così che le regole attive arrivino al tema live. Il Suo team smette di riscrivere i prezzi in una schermata dell’admin.

Questa guida è per distributori e produttori i cui prezzi, classi di prezzo o gruppi di clienti sono già in un ERP, un PIM o una pipeline di dati. Spiega chi ne trae beneficio, cosa copre l’API e cosa non copre, uno schema di integrazione in cinque passaggi, un esempio concreto e i limiti da considerare, incluso il fatto che non esiste un endpoint per gli ordini. È scritta per chi decide se costruire l’integrazione, e rimanda alla documentazione per sviluppatori per i payload esatti.

A chi è rivolto

La Public API fa per Lei se la maggior parte di queste affermazioni descrive il Suo negozio:

  • I prezzi sono mantenuti in un ERP, un PIM o un foglio di calcolo principale, e il negozio Shopify è una seconda copia.
  • Ha più classi di prezzo o gruppi di clienti, e una modifica di prezzo tocca centinaia o migliaia di varianti.
  • I prezzi cambiano ogni settimana o ogni giorno, quindi un aggiornamento manuale resta indietro tra un’esecuzione e l’altra.
  • Ha uno sviluppatore, un’agenzia o un partner di integrazione in grado di scrivere un job pianificato.
  • Esporta già i dati dei prezzi in CSV e vuole che gli stessi dati fluiscano senza che nessuno apra l’app.

Se il Suo listino cambia poche volte l’anno, un import CSV è più semplice. Veda importare prezzi all’ingrosso da CSV.

Perché conta

Due copie di un listino prezzi si disallineano. Qualcuno aggiorna l’ERP il lunedì, dimentica il negozio, e martedì un acquirente vede il prezzo del trimestre precedente. L’acquirente ordina al prezzo sbagliato e Lei assorbe la differenza o annulla l’ordine, oppure perde fiducia nel portale e chiama l’ufficio vendite. Più il catalogo è grande e più classi di prezzo gestisce, più spesso succede.

Una pipeline di dati elimina la causa invece del sintomo. L’ERP resta il sistema di riferimento, un job pianificato scrive le modifiche in BSS B2B Solution e la vetrina segue. I negozi reali vogliono questa flessibilità. Alpha Coffee, una torrefazione, segnala che con l’accesso API può mantenere Shopify come livello centrale del commercio ed estendere il collegamento a piattaforme ERP, CRM o finanziarie, e DermaplanePro riferisce una riduzione del lavoro manuale grazie alle connessioni pubbliche con sistemi esterni. Veda i casi Alpha Coffee e DermaplanePro.

Come configurarla con BSS B2B Solution

Questa sezione descrive l’integrazione dal lato del negoziante. Il Suo sviluppatore ha bisogno della guida alla Public API per endpoint e payload.

Passaggio 1: verifichi il piano

La Public API fa parte del piano Platinum. Un negozio può avere una sola chiave API alla volta, e il piano sblocca anche le Price List, che molte integrazioni con ERP usano per i prezzi specifici per cliente. Verifichi il piano prima di definire l’ambito di qualsiasi lavoro di integrazione.

Passaggio 2: generi la chiave API

Nell’app apra Integrations, trovi la scheda Public API e scelga Get API key. La chiave viene mostrata una sola volta, quindi la copi o la scarichi in quel momento e la conservi in un gestore di password o in una variabile d’ambiente del server. Se viene compromessa, la elimini nella stessa scheda: così si interrompe ogni client che la usa, poi ne genera una nuova.

Pagina Integrations nell’admin di BSS B2B Solution con la scheda Public API e il pulsante Get API key
Apra Integrations e trovi la scheda Public API.
Scheda della chiave API con il messaggio che la chiave è stata generata, la chiave nascosta e i pulsanti Copy e Download
La chiave viene generata e mostrata una sola volta: la copi o la scarichi subito.

Passaggio 3: autentichi la prima richiesta

Gli endpoint della versione 1 accettano il dominio `myshopify.com` del negozio e la chiave, sia come `accessKey` nel corpo della richiesta sia nell’header `x-bss-b2b-api-key`. L’endpoint volume pricing della versione 2 usa l’header `x-api-key`. Il token Bearer non è supportato e restituisce 401, quindi non costruisca il client attorno all’header `Authorization`.

Passaggio 4: scriva le regole dai dati dell’ERP

Associ ogni classe di prezzo dell’ERP a un target della regola, per esempio un tag cliente, e richiami il gruppo di endpoint del modulo che usa. L’API gestisce le regole Custom Pricing, Price List e Volume Pricing, le regole dei codici sconto, i record del modulo di registrazione e le regole sui limiti d’ordine, con operazioni di creazione, aggiornamento, eliminazione e operazioni in blocco dove l’endpoint lo consente. Gli endpoint di cliente e prodotto sono ricerche in sola lettura che aiutano a costruire i payload delle regole, per esempio trovare clienti per tag o elencare prodotti e collezioni. Le richieste vengono elaborate una per volta, quindi il client deve metterle in coda.

Pagina Custom Pricing nell’admin di BSS B2B Solution con l’elenco delle regole, i clienti, gli sconti, la priorità e lo stato
Le regole scritte dalla Sua integrazione compaiono nelle stesse liste di regole che il team usa nell’admin.

Passaggio 5: carichi una volta, poi verifichi

Dopo un blocco di modifiche, richiami l’endpoint di upload del modulo così che tutte le regole attive vengano scritte nel tema attivo. Gli endpoint di upload consentono una richiesta per modulo ogni cinque minuti, quindi carichi una volta alla fine di un’esecuzione di sincronizzazione, non dopo ogni riga. Una richiesta oltre il limite restituisce `429`, e vengono caricate solo le regole attive. Se le regole superano la capacità dei metafield, l’API salva ciò che entra e restituisce un report `partial_success` con HTTP 200, quindi legga il corpo della risposta e non solo il codice di stato. Poi verifichi il risultato nella scheda Logs and usage sotto Advanced Settings > Public API, che elenca le richieste recenti con orario, metodo, percorso e stato, e mostra la richiesta e la risposta complete quando qualcosa fallisce. L’API può anche restituire il prezzo che un determinato cliente ottiene per determinati prodotti, utile per confrontare l’app con l’ERP.

Collezione della vetrina demo per un cliente all’ingrosso in cui ogni prodotto mostra il prezzo al dettaglio barrato accanto al prezzo all’ingrosso
Dopo il caricamento, la vetrina mostra i prezzi che arrivano dai Suoi dati.

Esempio: un distributore con tre classi di prezzo

Questo esempio usa numeri illustrativi, non risultati di un negozio reale. Un distributore tiene tre classi di prezzo nel proprio ERP: Retail Partner, Trade e Key Account. In BSS B2B Solution ogni classe è una regola Price List che punta a un tag cliente. Un job notturno esporta le righe di prezzo modificate, le raggruppa per classe e richiama l’endpoint di salvataggio in blocco per ogni Price List. Quando tutte e tre finiscono, il job richiama una volta l’endpoint di upload della Price List.

Un lunedì l’ERP mostra 3.200 prezzi modificati. Invece di farle reinserire a un analista, il job parte alle 02:00, carica una volta e controlla nella scheda Logs and usage eventuali richieste fallite. Al mattino un acquirente Trade che accede vede i prezzi del lunedì nelle pagine di prodotto e di collezione. Una richiesta fallita lascia una voce nel log con il suo stato e il corpo, e il job la ripete dopo una breve attesa.

Pagina Price Lists nell’admin di BSS B2B Solution con il modulo attivo e una regola per i clienti connessi
Una pagina Price Lists con una regola di lista per un gruppo di clienti: lo stesso tipo di regola che scrive la Sua integrazione.

Funziona bene con

L’API è un canale di input per il motore dei prezzi. Le altre pagine descrivono cosa succede a quelle regole una volta create:

L’hub dei prezzi all’ingrosso raccoglie le guide sui prezzi. Voci utili del glossario sono price list, prezzo all’ingrosso e tag cliente.

Pagina Import and export in BSS B2B Solution con le schede Export e Import e una sezione con la cronologia degli export
La pagina Import and export è l’alternativa senza codice per i cataloghi più piccoli.

Limiti ed errori comuni

  • Non esiste un endpoint per gli ordini. L’API gestisce le regole di prezzo e di sconto, i record di registrazione e le regole sui limiti d’ordine, oltre alle ricerche in sola lettura di clienti, prodotti e collezioni. La sincronizzazione degli ordini resta nel connettore ERP per Shopify, e questa API serve per prezzi e gruppi di clienti.
  • Una chiave per negozio. Eliminare la chiave interrompe ogni client che la usa, quindi la ruoti con un piano e aggiorni subito l’integrazione.
  • L’upload ha un limite di frequenza. Gli endpoint di upload consentono una richiesta per modulo ogni cinque minuti. L’endpoint volume pricing della versione 2 consente 60 richieste ogni 60 secondi per ogni negozio.
  • I dati dei prezzi hanno dei limiti. Le regole sono salvate nei metafield di Shopify con al massimo 10 chiavi e 2.000.000 di caratteri per chiave. Il contenuto oltre i limiti viene saltato e segnalato come `partial_success`, quindi elimini le regole inattive o divida un set di regole molto grande prima di caricare di nuovo.
  • I nuovi tentativi richiedono una pausa. Le richieste vengono elaborate una per volta, e dopo un errore del server la guida indica di attendere fino a tre minuti prima di riprovare.
  • L’API non sostituisce la progettazione delle regole. Targeting, priorità ed esclusioni seguono le stesse regole delle regole create a mano, quindi provi prima una regola nell’admin.
  • L’API alimenta una vetrina su tema. I prezzi appaiono tramite l’app embed di BSS B2B Solution nel Suo tema Shopify, quindi verifichi che l’embed sia attivo dopo ogni modifica al tema.

Checklist di configurazione

  • Verifichi che il negozio sia sul piano Platinum.
  • Decida il sistema di riferimento per ogni classe di prezzo e a quale tag cliente corrisponde ogni classe.
  • Generi la chiave API e la conservi in un gestore di password o in una variabile d’ambiente.
  • Costruisca il client con `accessKey` o con l’header `x-bss-b2b-api-key`, e metta le richieste in coda.
  • Provi una regola dall’inizio alla fine in un negozio di sviluppo, poi la controlli nell’admin.
  • Preveda una chiamata di upload per modulo alla fine di ogni esecuzione di sincronizzazione.
  • Aggiunga avvisi per `429` ed errori del server, e legga la scheda Logs and usage dopo le prime esecuzioni.
  • Tenga la sincronizzazione degli ordini in un connettore separato.

Piani e requisiti

La Public API richiede il piano Platinum di BSS B2B Solution, una chiave per negozio e l’app embed sul Suo tema. Gli altri piani e la prova gratuita di 14 giorni sui piani a pagamento sono nella pagina prezzi BSS B2B. I payload esatti sono nella guida alla Public API, nella guida all’API di upload e nella guida all’API Custom Pricing. Installi BSS B2B Solution dallo Shopify App Store e chieda al Suo sviluppatore di iniziare con una sola Price List.

funzionalità principali

Cosa lo rende possibile

Endpoint delle regole

Lettura, creazione, aggiornamento ed eliminazione di regole Custom Pricing, Price List e Volume Pricing dal codice, incluso il salvataggio in blocco e l’eliminazione di massa.

Ricerche di clienti e prodotti

Endpoint in sola lettura per trovare clienti per tag, ID o ricerca, e per elencare prodotti e collezioni per i payload delle regole.

Upload sul tema

Una richiesta carica tutte le regole attive nel tema attivo, così la vetrina corrisponde ai Suoi dati.

Log e utilizzo

Una scheda nell’app elenca le richieste recenti con orario, metodo, percorso e stato.

Configuralo con BSS B2B Solution

Installi BSS B2B Solution dallo Shopify App Store, poi segua la guida per attivarlo nel Suo store.

faq

Domande frequenti

Quale piano include la Public API?

Il piano Platinum. Un negozio può avere una sola chiave API alla volta. Se una chiave viene compromessa, la elimini nella scheda Public API in Integrations, e ogni client che la usa smette subito di funzionare. Poi può generarne una nuova e aggiornare la Sua integrazione. Tratti la chiave come una password e la conservi in una variabile d’ambiente del server.

Posso sincronizzare gli ordini tramite API?

No. L’API gestisce le regole di prezzo e di sconto, i record del modulo di registrazione e le regole sui limiti d’ordine, oltre alle ricerche in sola lettura di clienti, prodotti e collezioni. Non ha una risorsa per gli ordini. Gli ordini restano in Shopify, quindi usi gli strumenti di Shopify se il Suo ERP ne ha bisogno, e usi questa API per i prezzi e i gruppi di clienti.

Quali sono i limiti di frequenza?

Gli endpoint di upload consentono una richiesta per modulo ogni 5 minuti, e una richiesta oltre il limite restituisce 429. L’endpoint Volume Pricing della versione 2 consente 60 richieste ogni 60 secondi per ogni negozio e invia gli header del limite di frequenza. Raggruppi le modifiche e carichi una volta dopo un’esecuzione di sincronizzazione, non dopo ogni riga.

Come autentico una richiesta?

Gli endpoint della versione 1 accettano il dominio del negozio e la chiave di accesso, sia come accessKey nel corpo sia nell’header x-bss-b2b-api-key. L’endpoint della versione 2 usa l’header x-api-key. Non invii la chiave come token Bearer, perché questo formato non è supportato e la richiesta fallisce con 401.

Quali regole posso gestire con l’API?

Può creare, aggiornare ed eliminare regole Custom Pricing, Price List e Volume Pricing, oltre alle regole dei codici sconto, ai record del modulo di registrazione e alle regole sui limiti d’ordine, con operazioni in blocco su più endpoint. Gli endpoint di cliente, prodotto e collezione sono ricerche in sola lettura per costruire i payload delle regole. Verifichi le operazioni esatte in ciascuna guida.

Cosa succede se carico più regole di quante ne entrino?

I dati dei prezzi sono salvati nei metafield di Shopify con al massimo 10 chiavi e 2.000.000 di caratteri per chiave. Se le regole attive superano questa capacità, l’API salva le regole che entrano e restituisce un report partial_success con HTTP 200, con il numero di regole saltate. Elimini le regole inattive o divida il set, poi carichi di nuovo.

Come vedo perché una richiesta API è fallita?

Apra la scheda Logs and usage in Advanced Settings e Public API. Elenca le richieste recenti con orario, metodo, percorso e stato, con schede per Custom Pricing, Volume Pricing e Pricing List. Clicchi su una riga per vedere la richiesta e la risposta complete. La usi per confermare che l’integrazione si connette e per fare il debug degli errori.

Le serve l’API o basta un import CSV?

Se i prezzi cambiano poche volte l’anno, l’import CSV nell’app è più semplice e non richiede uno sviluppatore. La Public API ha senso quando i prezzi vivono in un ERP o PIM e cambiano spesso, perché un job pianificato può inviare le modifiche senza che nessuno apra l’app. L’API richiede il piano Platinum.

Installi BSS B2B Solution prova gratuita di 14 giorni (piani a pagamento)