API für Artikel von Marketplace-Partnern

Im Rahmen deiner Marketplace-Partnerschaft sind deine Inserate in bestimmten Ländern im Facebook Marketplace zu sehen.

Über die Graph API kannst du deine Produkte im Facebook Marketplace hochladen, aktualisieren oder löschen.

HTTP

POST /v20.0/{product-catalog-id}/items_batch HTTP/1.1

Wenn du wissen möchtest, wie du die Graph API optimal einsetzt, lies dir unseren Leitfaden zur Graph API durch.

Bei einer POST-Anfrage an diese Edge wird ein Produktartikel erstellt.

Parameter

ParameterBeschreibung

item_type

Dies wird als PRODUCT_ITEM festgelegt.

requests

Die Methode und Felder für jedes Produkt einer Produktreihe.

Der request-Parameter dient dazu, die Methode (method) und die Daten (data) deiner Anfrage zu definieren.

FeldBeschreibung

method

Angabe der Handlung, die für das jeweilige Produkt ausgeführt werden soll. Zur Auswahl stehen folgende Handlungen:
CREATE
UPDATE
DELETE

data

Die Informationen zu dem Produkt, das erstellt, aktualisiert oder gelöscht werden soll.

Ein beispielhafter requests-Parameter

[
    {
        "method": "CREATE",
        "data": {
            "id": "UniqueProductID",
            "title": "Title",
            "description": "This is the description",
            "price": "100 USD",
            "image_link": "https:\/\/www.facebook.com",
            "brand": "Monster",
            "availability": "in stock",
            "condition": "new",
            "link": "https:\/\/www.facebook.com",
            "return_details": {"return_days": "30", "return_type": "SELLER_PAID_RETURN"},
            "partner_product_checkout_uri": "https:\/\/www.facebook.com",
            "partner_product_location": "San Fransisco, CA",
            "partner_product_expiration_time": "1923181264",
            "partner_delivery_method": ["shipping"],
            "partner_shipping_type": "fixed",
            "partner_shipping_cost": "14.95",
            "partner_shipping_speed": "3:5",
            "partner_attribute_data": {"color": "blue"},
            "partner_seller_id": "MySellerId1",
            "partner_item_country": "US"
        }
    },
    .... {next product}
]
   

API-Durchsatzratenbegrenzung

Um Throttling zu verhindern, halte dich bitte an diese Empfehlungen:

  • Führe maximal 30 Aufrufe pro Minute durch. Mehr Aufrufe führen zu einer Drosselung.
  • Fasse bis zu 300 Items in einem API-Aufruf zusammen.

Felder für Artikel (Product_item)

ParameterTypErforderlich/optionalBeschreibung

id

String (Max. Zeichenanzahl: 100).

Erforderlich

Eine eindeutige Content-ID für den Artikel. Verwende nach Möglichkeit die SKU des Artikels. Jede Content-ID darf nur einmal in deinem Katalog vorkommen. Wenn eine ID mehrmals vorkommt, werden alle Vorkommen ignoriert.

Wenn Artikel in mehreren Ländern verfügbar sind, musst du in allen Katalogen dieselbe ID verwenden. Achte darauf, den Preis auf die Währung des Landes zu aktualisieren (siehe Preisfeld).

title

String (Max. Zeichenanzahl: 200)

Erforderlich

Die Produktbezeichnung, die im Marketplace-Inserat angezeigt wird.

Dieser Text wird im Marketplace angezeigt. Verwende keine HTML-Tags.

description

String (Max. Zeichenanzahl: 9999)

Erforderlich

Eine Beschreibung des Produkts. Zwar beläuft sich das Zeichenlimit für dieses Feld auf 9999 Zeichen, dennoch werden nur die ersten 256 Zeichen im Facebook Marketplace-Inserat angezeigt.

Dieser Text wird im Marketplace angezeigt. Verwende keine HTML-Tags.

Beispiel: Ein gemütliches, königsblaues Damen-T-Shirt aus organischem Baumwolle. Kappenärmel und lockere Passform. Perfekt für warme Sommertage.

condition

Enum {new, refurbished, used, used_like_new, used_good, used_fair, cpo, open_box_new}

Erforderlich

Der Zustand des Produktartikels.

partner_listing_type

Enum {fixed_price, auction, vehicle, rental, real_estate}

Optional

Dieser Wert bestimmt die Art des Inserats. Wenn keine Auswahl getroffen wurde, wird standardmäßig „fixed_price“ verwendet.

Wenn als Wert „auction“, „vehicle“, „rental“ oder „real_estate“ festgelegt ist, wird für Käufer*innen im Marketplace die angegebene Art des Partnerinserats angezeigt.

partner_product_condition

Enum {acceptable, brand_new, certified_pre_owned, certified_refurbished, damaged, digital_good, excellent_refurbished, for_parts_or_not_working, good, good_refurbished, graded, like_new, new, new_other, new_other_see_details, new_with_box, new_with_defects, new_with_tags, open_box, others, pre_owned, remanufactured, retread, seller_refurbished, ungraded, used, very_good, very_good_refurbished, new_open_box, open_box_used, new_factory_sealed, unknown}

Optional

Produkt-Zustand. Optionales Feld, mit dem du das Zustand-Feld überschreiben lassen kannst Verwende es, um den Zustand des Produktes zu präzisieren.

brand

String

Erforderlich

Die Marke des Produkts. Setze dieses Feld auf „N/A“ (k.A.), falls die Marke nicht vorhanden ist.

price

String (Max. Zeichenanzahl: 9999)

Erforderlich

Formatierung der Preisangabe: Gib die entsprechende Zahl an, gefolgt von einem Leerzeichen, und dann die drei Buchstaben des jeweiligen Währungscodes gemäß ISO 4217. Beispiel: 10,99 EUR

Wenn die Art des Inserats „auction“ ist, ist dies der Gebotspreis für das Produkt. Formatierung der Preisangabe: Gib die entsprechende Zahl an, gefolgt von einem Leerzeichen, und dann die drei Buchstaben des jeweiligen Währungscodes gemäß ISO 4217.

availability

Enum {in stock, out of stock}

Erforderlich

Die Verfügbarkeit des Artikels.

link

String

Erforderlich

Mobiler URL-Weblink zur Produktdetailseite.

partner_product_checkout_uri

String

Optional

Link mit der Checkout-URL, zu der wir Nutzer*innen weiterleiten, wenn sie beim Inserat auf „Kaufen“ tippen.
Wir ergänzen den Parameter um die click_id. Falls diese Angabe fehlt, wird standardmäßig die URL aus dem „link“-Feld verwendet.

partner_product_html_desc_uri

String

Optional

Der URL-Link zur Website mit der vollständigen Beschreibung des Produktes. Dieses Feld wird verwendet, wenn die Produktbeschreibung länger ist als die zulässige Zeichenvorgabe für das Textfeld „description“. Im Marketplace wird dann bei Bedarf ein Link zur vollständigen Beschreibung bereitgestellt.

image_link

String

Erforderlich

Die URL für das primäre Bild deines Artikels. Die Bilder müssen mindestens 500 x 500 Pixel groß sein. Die Dateigröße darf 8 MB nicht überschreiten. Zulässige Dateiformate für Bilder sind JPEG und PNG. Lies dir außerdem die Spezifikationen für Produktbilder durch.

partner_seller_id

String (Max. Zeichenanzahl: 100)

Erforderlich

Eine eindeutige Kennung für den*die Verkäufer*in. Die Kennung muss mit der partner_seller_id in den Informationen zum*zur Verkäufer*in übereinstimmen.

Beispiel: „partner_seller_id“: „great_seller_inc“

partner_item_country

Enum {AT, BE, BG, CY, CZ, DE, DK, EE, ES, FI, FR, GR, HR, HU, IE, IS, IT, LI, LT, LU, LV, MT, NL, NO, PL, PT, RO, SE, SI, SK}

Erforderlich

In diesem Land ist das Produkt verfügbar und kann gegebenenfalls dorthin versendet werden. Der Länderkatalog und partner_item_country müssen übereinstimmen.

Bei Artikeln, für die ein grenzüberschreitender Versand unterstützt wird, ist es erforderlich, den Artikel in jedem Katalog für ein Land zu erstellen, in dem der Versand unterstützt wird und der Partner ihn vertreiben möchte.

fb_product_category

String

Optional

Die Facebook-Produktkategorie für den Artikel. Angabe der genauesten Facebook-Produktkategorie aus dieser Liste: Tabellen-Datei (CSV) oder Klartext (TXT).

status

Enum {active, archived}

Optional

Der aktuelle Status des Produkts.

sale_price

String

Optional

Formatierung der Preisangabe: Gib die entsprechende Zahl an, gefolgt von einem Leerzeichen, und dann die drei Buchstaben des jeweiligen Währungscodes gemäß ISO 4217. Beispiel: 10,99 EUR Dies ist das gleiche Format wie beim Preis-Feld. Verwende dieses Feld in Kombination mit dem Preis-Feld, um Rabatte anzuzeigen.

sale_price_effective_date

String

Optional

Start- und Enddatum und -uhrzeit für den Verkauf, durch einen Schrägstrich getrennt. Schreibe das Start- und Enddatum im Format JJJJ-MM-TT. Füge nach jedem Datum „T“ hinzu und gib dann die Uhrzeit an. Schreibe die Zeit im 24-Stunden-Format (0:00 bis 23:59).

Beispiel: 2014-11-01T12:00-0300/2014-12-01T00:00-0300.

additional_image_link

String (Max. Zeichenanzahl: 2000)

Optional

URLs für bis zu 20 zusätzliche Bilder des Artikels. Die einzelnen Angaben müssen durch ein Komma (,), ein Semikolon (;), ein Leerzeichen ( ) oder einen vertikalen Strich (|) getrennt werden. Hierbei gelten dieselben Bildvorgaben wie für das Hauptfeld image_link.

return_details

Nullwertiges JSON-Objekt (d. h. Map) { "return_days": 30, "return_type": enum }

Enum: FINAL_SALE NO_RETURNS_WITH_EXCEPTION NO_RETURNS SELLER_PAID_RETURN BUYER_PAID_RETURN

Oder falls keine Rücksendungen möglich sind:
„return_details“: null

Optional

return_days gibt in Tagen die Frist an, innerhalb derer der*die Käufer*in mit der Rückgabe des Artikels beginnen muss.
Bei NO_RETURNS bzw. FINAL_SALE muss für return_days der Wert „-1“ angegeben werden.

return_type beschreibt den Rückgabetyp, der für das Produkt unterstützt wird. Verfügbare Optionen: FINAL_SALE, NO_RETURNS_WITH_EXCEPTION, NO_RETURNS, SELLER_PAID_RETURN, BUYER_PAID_RETURN

Wenn dieses Feld freigelassen wird, werden keine Angaben zur Rücksendung angezeigt.

partner_attribute_data

Nullwertiges JSON-Objekt { "color": "blue" }

Verfügbare Schlüssel: aspect_ratio, band_material, bike_type, brand, break_type, cable_length, capacity, case_size, certification, character, circulated_uncirculated, closure, color, compatible_bike_type, compatible_brand, compatible_model, compatible_operating_system, compatible_product, connectivity, credit_included, denomination, department, display_technology, dress_length, exterior_color, exterior_material, fabric_type, features, film_format, fit, focal_length, focus_type, form_factor, format, frame_color, game_name, game, gauge, golf_club_type, handedness, inseam, internet_connectivity, item_height, item_length, item_weight, item_width, items_included, main_stone, manufacturer_part_number, manufacturer, material, maximum_aperture, maximum_magnification, maximum_resolution, memory_cards_supported, metal_purity, metal, model, mount, mpn, network, number_of_items, occasion, outer_shell_material, package_quantity, part_type, pattern, performance_activity, platform, processor, publication_name, quantity, rack_type, rim_diameter, rim_width, ring_size, screen_size, section_width, series, set_includes, set, size_type, size, skirt_length, sleeve_length, sport_activity, sport, storage_capacity, style, type, unit_quantity, unit_type, upper_material, us_shoe_size, vintage, voltage, volume, waist_size, wheel_diameter, year

Optional

Eine Liste der Produktmerkmale, die unter den Produktdetails aufgeführt werden. Die Werte sind im String-Format.

Schlüssel für Mietobjekte/Immobilien: property_type (erforderlich), sale_type, bed_bath, area_size, pet_friendly, ac_type, heating_type, laundry_type, parking_type, parkingSpace, furnishing_type, garden_type, tenure_type, listed_by, property_tax_and_condo_fee, construction_status, lease_duration, energy_rating_eu, co2_emission_rating

Schlüssel für Fahrzeuge: vehicle_type, year, make, model, number_of_owners, trim, body_style, exterior_color, interior_color, transmission, fuel_type, mileage, money_still_owed, motorcycle_type, engine_size

partner_product_creation_time

UNIX-Zeitstempel in Sekunden UTC (Zahlenwert)

Optional

UNIX-Zeitstempel, wann das Produkt erstellt oder aktualisiert wurde.

Beispiel: „partner_product_creation_time“: 1713917255

partner_product_location

String

Optional

Artikelstandort wird als String angezeigt. Beispiel: „Paris, Frankreich“. Keine Einschränkungen dazu, wie genau oder weitgefasst die Ortsangabe ist.

partner_product_expiration_time

UNIX-Zeitstempel in Sekunden UTC (Zahlenwert)

Optional

Zeitpunkt, zu dem das Inserat aus dem Marketplace entfernt wird. Die Angabe muss in der Zukunft liegen.

partner_delivery_method

Datenfeld der String-Enumerate {shipping, in_person}

Optional

Angabe, wie das Produkt an eine*n Käufer*in übergeben wird. Gib beide Optionen an, wenn ein Produkt entweder versandt oder abgeholt werden kann.
Beispiel: [“shipping”,“in_person”]

Standard: [“shipping”]

partner_item_latitude

Gleitkommazahl

Optional

Breitengrad des Items. Erforderlich, wenn die Zustellungsmethode „in_person“ beinhaltet.

partner_item_longitude

Float

Optional

Längengrad des Artikels. Erforderlich, wenn die Versandmethode „in_person“ beinhaltet.

partner_shipping_type

Enum {free, fixed, dynamic}

Optional

Versandpreis-Strategie für Artikel. Ist der Versand kostenlos, verwende „free“. Wenn für den Versand unabhängig vom Ort ein Festpreis gilt, gib „fixed“ an und lege die Kosten unter partner_shipping_cost fest. Variieren die Versandkosten je nach Standort des*der Käufer*in oder Auswahl der Produktvariante usw., wähle „dynamic“ aus. Falls du „dynamic“ wählst, werden die Versandkosten nicht im Vorfeld, doch erst beim Kaufabschluss angezeigt. Darauf verweist ein Hinweis.

Standard: „dynamic“

partner_shipping_cost

Float

Optional

Erforderlich, wenn partner_shipping_type „fixed“ ist.
Beispiel „14.95“

partner_shipping_speed

String
‘MIN_DELIVERY_SPEED_IN_DAYS:MAX_DELIVERY_SPEED_IN_DAYS’

Optional

Minimale und maximale voraussichtliche Werktage für den Versand von Artikeln.
Beispiel: „3:5“

partner_auction_bid_close_time

UNIX-Zeitstempel in Sekunden UTC (Zahlenwert)

Optional

Erforderliches Feld, wenn der partner_listing_type "auction" ist. Das ist der Zeitpunkt, wenn die Gebote für das Produkt schließen. Beispiel: „partner_auction_bid_close_time“: 1713917255

partner_auction_bid_count

Anzahl

Optional

Nur anwendbar, wenn „partner_listing_type“ „auction“ ist. Dies ist die aktuelle Anzahl der Gebote, die auf das Produkt abgegeben wurden.

additional_fields

Nullwertiges JSON-Objekt

Freiform (Enum/Schlüssel nicht festgelegt)

{ “revised_title”: “Premium Blue T-Shirt” }

Optional

Ein Freiform-JSON-Feld, über das Partner zusätzliche Felder senden können.

Status des Uploads prüfen

Nachdem du eine Anfrage zum Erstellen, Aktualisieren oder Löschen gesendet hast, erhältst du einen Handle zurück. Du kannst das Ergebnis der gesandten Anfrage mit einer weiteren Anfrage überprüfen.

Die Angabe data -> status wird nach Abschluss auf „finished“ gesetzt und die Fehler und Warnungen werden angezeigt.

HTTP

GET /v20.0/{product-catalog-id}/check_batch_request_status?handle={your handle}

Beispiel für eine Rückgabe

{
  "data": [
    {
      "handle": "Acy3FUJwzE10XnWrYr4ttrjOAfs-h6BUg-Wtg6sWGeV7qZZaErX15XPfqT_KWeyC6T4-nTbng9r1BJuScb6hgO1B",
      "status": "finished",
      "errors_total_count": 0,
      "errors": [
      ],
      "warnings": [
        {
          "line": 1,
          "id": "YourItemID",
          "message": "These attributes are invalid and need to be updated in the feed file: The product_tags information under  is invalid. Review for more details"
        }
      ],
      "ids_of_invalid_requests": [
      ]
    }
  ],
  "__www_request_id__": "Az3ghYsDh-101IH2t6DXKuP"
}
    

Produkte ansehen und verwalten

Zur Ansicht und Verwaltung von hochgeladenen Produkten im Commerce Manager. Falls Probleme mit deinen Produkten bestehen, werden sie im Commerce Manager angezeigt und können ggf. im Tool behoben werden.