logo

Het Manual/API-kanaal

6 min read

Vertaald voor het gemak. Bij verschillen geldt de Engelse versie.

Wanneer u een Manual/API-kanaal gebruikt

Een Manual/API-kanaal is niet gekoppeld aan een winkel. Er wordt niets naar een website geüpload en er komen geen bestellingen vanzelf binnen. Gebruik het wanneer:

  • U verkoopt op uw eigen website, op een marktplaats waarmee wij niet koppelen, op sociale media of telefonisch, en u elke bestelling zelf naar ons wilt sturen.
  • U heeft uw eigen systeem of ontwikkelaar en wilt bestellingen via onze API naar ons sturen.

Staat uw shop op een platform dat op de pagina Add Sales Channel staat, zoals Shopify, WooCommerce, eBay of TikTok Shop, koppel dat platform dan in plaats daarvan. Dan worden producten voor u geüpload en komen bestellingen vanzelf binnen.

U kunt meer dan één Manual/API-kanaal hebben, bijvoorbeeld één per website.

Het kanaal aanmaken

  1. Open Channels in het menu. U ziet de lijst met uw Sales Channels.
  2. Druk op Add Sales Channel. De pagina toont Select channel you want to create.
  3. Druk op de kaart Manual/API op Create.
  4. Een venster Create platform manual opent. Typ een naam voor het kanaal, bijvoorbeeld de naam van uw website. De naam mag tot 28 tekens lang zijn.
  5. Druk op Create.

U ziet het bericht Your Manual store has been created. en de kanaalpagina opent.

Elk van uw kanalen heeft zijn eigen naam nodig. Wordt de naam al gebruikt door een ander van uw kanalen, dan toont het venster een fout. Kies een andere naam.

Uw kanaalpagina

De kanaalpagina heeft de naam van uw kanaal als titel en de kop Manual/API order management. Er staan drie vakken, elk met een link View all:

  • Orders: de bestellingen die u in dit kanaal plaatste.
  • Clients: de mensen naar wie u bestellingen stuurt.
  • Products: de producten in uw lijst My Products.

In het menu, onder de kanaalnaam, vindt u:

De gebruikelijke manier van werken is:

  1. Voeg de producten die u verkoopt toe aan My Products met Add products. Dit is nodig voor de API. Voor bestellingen die u zelf intypt, is dit optioneel: het mandje laat u elk product kiezen dat wij verkopen.
  2. Krijgt u een bestelling, open dan Clients, zoek uw koper op of voeg hem toe.
  3. Druk op de klantpagina op Create Order, voeg de producten en aantallen toe en betaal.

De naam wijzigen of het kanaal sluiten

Om het kanaal te hernoemen, drukt u op de kanaalpagina op Edit en wijzigt u Store name.

Om een kanaal te sluiten, gaat u naar Channels en drukt u op de sluitknop in de kolom Action (tooltip Close channel). Het venster vraagt Are you sure you want to close this channel? en waarschuwt This operation is irreversible. Een gesloten kanaal verdwijnt uit het menu. Uw eerdere bestellingen en facturen blijven bewaard.

Uw eigen systeem koppelen met de API

De API laat uw website of app zelf doen wat u op de kanaalpagina's doet: onze productcatalogus met actuele prijzen lezen, producten aan My Products toevoegen, klanten aanmaken en wijzigen, bestellingen aanmaken, er producten aan toevoegen, ze indienen en volgen. U kunt uw lijst My Products ook als CSV- of JSON-feed downloaden om producten in uw eigen website te laden.

Open API onder uw kanaal. De pagina heeft deze tabbladen:

  • Overview: hoe u koppelt, het basisadres van de API en de knop API documentation. De documentatie somt elk eindpunt op met voorbeelden.
  • API tokens: de tokens voor dit kanaal.
  • API calls: de verzoeken die uw systeem deed.
  • History: wijzigingen aan uw account.

Een token krijgen

  1. Druk op Generate API token.
  2. Is het token alleen voor het lezen van gegevens, vink dan Read only (cannot create, change or submit orders) aan.
  3. Druk op Click to Generate.
  4. Kopieer het token met het kopieerpictogram en bewaar het veilig. Het venster zegt Put this token in a safe place, you won't be able to see it again. Het korte label in de tokenlijst is alleen een naam, niet het token.

Stuur het token met elk verzoek mee in de header Authorization: Bearer gevolgd door uw token. Elk token hoort bij één kanaal: producten, klanten en bestellingen die uw systeem aanmaakt, gaan naar dat kanaal. Om een token te laten stoppen werken, verwijdert u het in het tabblad API tokens.

Eerst testen op staging

Het tabblad Overview heeft ook Open staging mirror. Staging is een aparte kopie van de site waar u kunt testen zonder echte bestellingen of betalingen. Log in met hetzelfde e-mailadres en wachtwoord. Staging wordt regelmatig teruggezet met een verse kopie, waardoor wat u daar aanmaakte verdwijnt. Tokens van de echte site werken niet op staging: genereer een apart token op staging, en een nieuw na elke reset. Het basisadres van staging staat op het tabblad Overview.

Hoe API-bestellingen worden betaald

Wanneer uw systeem een bestelling indient, betalen wij deze eerst van uw accountsaldo, dan van uw opgeslagen kaarten. Voeg een kaart toe voordat u begint. Zodra u een token heeft, toont het menu Saved Cards. Zolang er geen kaart is opgeslagen, toont de API-pagina You have no cards saved yet. met een knop Add card.

Dekken noch uw saldo noch uw kaarten de bestelling, dan wordt deze gemarkeerd als Unpaid en gaat ze niet naar het magazijn. Voeg geld toe aan uw saldo met Top Up, open de bestelling en druk op Pay … with balance. De knop verschijnt zodra uw saldo het verschuldigde bedrag dekt.

Als er iets misgaat

  • De naam is al bezet wanneer ik het kanaal aanmaak. Een van uw open kanalen heeft die naam al. Typ een andere naam. De naam van een gesloten kanaal kan opnieuw gebruikt worden.
  • Mijn bestellingen komen niet vanzelf binnen. Een Manual/API-kanaal haalt nooit bestellingen op van een website. Maak ze aan op de klantpagina, of stuur ze vanuit uw systeem via de API. Verkoopt u op een platform dat op de pagina Add Sales Channel staat, koppel dat platform dan als eigen kanaal.
  • Mijn producten staan niet op mijn website. Wij uploaden niets vanuit een Manual/API-kanaal. Laad ze zelf in uw website in, met de CSV-download op My Products of via de API.
  • Ik ben mijn API-token kwijt. Het kan niet opnieuw getoond worden. Genereer een nieuw token, zet het in uw systeem en verwijder het oude.
  • De API antwoordt dat ik geen bestellingen kan aanmaken of wijzigen. Het token is alleen-lezen. Genereer een token zonder Read only aangevinkt.
  • De API weigert mijn verzoeken voor een korte tijd. Elk token kan tot 120 verzoeken per minuut doen. Vertraag uw systeem en probeer het na een minuut opnieuw.
  • De API zegt "This order has no products yet". Voeg minstens één product aan de bestelling toe voordat u deze indient.
  • De API zegt "Unable to find related portfolio item". Via de API voegt u een product aan een bestelling toe met zijn My Products-item, niet met het product zelf. Voeg het product eerst toe aan My Products en gebruik het id van dat item.
  • De API zegt dat er al een andere transactie met hetzelfde product bestaat. Het product staat al op de bestelling. Wijzig de hoeveelheid van die regel in plaats van het opnieuw toe te voegen.
  • De API zegt dat de bestelling "is already in the 'submitted' state and cannot be updated". Ingediende bestellingen kunnen niet via de API gewijzigd of verwijderd worden. Vraag het ons in de chat op onze website als de bestelling moet wijzigen.
  • Mijn API-bestelling toont Unpaid. Uw saldo en opgeslagen kaarten dekten haar niet. Waardeer uw saldo op, open de bestelling en druk op Pay … with balance, en controleer of uw opgeslagen kaart nog geldig is.