Aangepaste Product Catalogus Bron
Voeg uw eigen productcatalogus toe
In Bird kun je met behulp van een API-eindpunt een aangepaste productcatalogusbron maken. De API-respons moet voldoen aan een specifiek formaat dat productdetails, varianten, afbeeldingen en meer omvat. Hieronder staat een gids over hoe je je productcatalogusgegevens structureert en hoe je deze maakt met behulp van de API.
Aangepaste Productcatalogus Maken
Product Catalog Source API-formaat
De reactie van het API-eindpunt moet een array van productobjecten zijn, elk met verschillende velden. Hier is de structuur en voorbeeldwaarden voor elk veld:
Vereiste Velden:
id (string): Een unieke identificator voor het product. Voorbeeld:
"8890650190078"
name (string): De naam van het product. Voorbeeld:
"My Test Product"
description (string): Een beschrijving van het product. Voorbeeld:
"A cool product with lights available in different colors"
status (string): De huidige status van het product. De geldige waarden zijn:
active
: Het product is live en beschikbaar.archived
: Het product is gearchiveerd.draft
: Het product is een concept. Voorbeeld:"active"
created_at (string): De datum en tijd waarop het product is gemaakt, in ISO-8601 formaat. Voorbeeld:
"2022-05-25T10:55:16+02:00"
updated_at (string): De datum en tijd waarop het product voor het laatst is bijgewerkt, in ISO-8601 formaat. Voorbeeld:
"2022-05-25T10:55:16+02:00"
published_at (string): De datum en tijd waarop het product is gepubliceerd, in ISO-8601 formaat. Voorbeeld:
"2022-05-25T10:55:16+02:00"
vendor (string): De naam van de leverancier van het product. Voorbeeld:
"My Vendor"
deleted_at (string): De datum en tijd waarop het product is verwijderd (indien van toepassing), in ISO-8601 formaat. Voorbeeld:
"2022-05-25T10:55:16+02:00"
of een lege string""
als het product niet is verwijderd.
Optionele Velden:
url (string): De product-URL. Voorbeeld:
"https://www.myproduct.com"
type (string): Het producttype, dat kan worden gebruikt voor het filteren en zoeken van producten. Voorbeeld:
"color"
variants (array): Een array van productvarianten. Indien gespecificeerd, moet elke variant
id
,name
,sku
, en prijs bevatten.
Voorbeeld:
images (array): Een array van productafbeeldingen. Indien gespecificeerd, moet elke afbeelding
id
,position
,url
,alt
,width
, enheight
bevatten. Devariant_ids
array kan ook afbeeldingen koppelen aan specifieke productvarianten.
variant_ids (array): Een array van variant-id's die aan de productafbeelding zijn gekoppeld.
Stapsgewijze instructies voor het maken van een Custom Product Catalog Source
Bereid uw gegevens voor: Formatteer uw productcatalogusreactie volgens de hierboven beschreven structuur. Zorg ervoor dat alle verplichte velden zijn opgenomen en voeg optionele velden zoals
varianten
,afbeeldingen
enurl
toe indien nodig.Maak het API-eindpunt: Gebruik de BirdCRM API om de productgegevens te verzenden. Het eindpunt verwacht een reactie die voldoet aan de hierboven genoemde structuur. Zorg ervoor dat de gegevens in een geldig JSON-formaat zijn.
Test het eindpunt: Voordat u de bron van de productcatalogus in uw workflow integreert, is het belangrijk om het API-eindpunt te testen om te verifiëren dat de gegevens correct worden verwerkt. Dit zorgt ervoor dat alle producten en hun gerelateerde informatie (zoals varianten en afbeeldingen) correct worden opgehaald.
Monitoren en onderhouden: Zodra de bron van de productcatalogus is gemaakt, kunt u de prestaties ervan monitoren via de rapportagefuncties van BirdCRM. Als u productdetails moet bijwerken of nieuwe producten wilt toevoegen, werk dan eenvoudig de gegevens bij met behulp van de API.
Voorbeeld API-reactie:
Door deze stappen te volgen, kunt u een aangepaste productcatalogusbron maken en beheren binnen Bird. Zorg ervoor dat de API-reactie voldoet aan het vereiste formaat, en u kunt uw producten naadloos integreren in het platform.