MBE Feed Onboarding

Meta Business Extension (MBE) allows your sellers to easily list products across the Meta family of apps by connecting existing assets such as the Facebook product catalog or by creating entirely new assets.

Example — Onboarding flow from partner surface (Business Login)

Before You Start

  1. Your app must be owned by a Business Manager that is a verified business. Learn more about how to verify your business.
  2. A Meta app is required with the following permissions approved via App Review particularly those apps engaging in feed management:
    • catalog_management — Alternatively, you can request the ads_management permission if you also want to manage merchants ads on behalf of the client.

Required Configurations

Extras

FieldDescription

setup

Type: setup

Required.

Seller’s Facebook setup, such as their unique identifier (external_business_id) or the currency of their catalog (currency). See setup object details.

business_config

Type: business_config

Required.

Configuration object that the Meta Business Extension uses to configure the Meta Business Extension workflow. See business_config object details.

repeat

Type: boolean

Required.

Set this value to false.

Setup

FieldDescription

external_business_id
Type: string

Required.
Unique business ID to represent your client's business. We use this as a unique identifier. For example, if the seller's company is called "Fubar", then "fubar-123" could be their external_business_id.

timezone
Type: string

Required.
The time zone in which the business is located. See possible time zone values.

currency
Type: string

Required.
Three-letter ISO currency code of the default currency used by the business's catalog items. See supported currency codes.

business_vertical
Type: enum

Required.
Vertical associated with the business.
Value: ECOMMERCE

merchant_settings_id
Type: string

Optional.
Used when upgrading from Meta Business Extension, v1. Contact your Meta partner if you are migrating from v1 to v2.

domain
Type: string

Required for COMMERCE and COMMERCE_OFFSITE channels
Domain used for Instagram manual approval. For example, https://exampleshop.partnersite.com.

channel
Type: enum

Required.
Provides a way for the partner to express intent for the user regarding features that require additional steps or constraints.
Value: FEED
FEED — Flow allowing retailers to sync their catalog, excluding Pixel as an asset. Recommended only for partners that have feed/catalog capabilties and do not have website hosting.

business_manager_id
Type: string

Optional.
Business Manager ID for user's existing Business Manager that a partner can enter to preselect for the user in the setup flow.

ad_account_id
Type: string

Optional.
Ad Account ID for user's existing ad account that a partner can enter to preselect for the user in the setup flow.

page_id
Type: string

Optional.
Page ID for the user's existing Facebook Page that partner can enter to preselect for the user in the setup flow.

ig_profile_id
Type: string

Optional.
Instagram Business Profile ID for the user's existing Instagram Business Profile that a partner can enter to preselect for the user in the setup flow.

pixel_id
Type: string

Optional.
Pixel ID for the user's existing pixel that a partner can enter to preselect for the user in the setup flow.

catalog_id
Type: string

Optional.
Catalog ID for the user's existing catalog that a partner can enter to preselect for the user in the setup flow.

Business Config

FieldDescription

business
FBEBusinessPropertiesConfigData

Required.
Information for the end user's business

catalog_feed_scheduled
FBECatalogFeedConfigData

Optional.
Determines whether the Facebook Business Extension should use a feed approach, which grabs catalog items from a feed_url

FBECatalogFeedConfigData

Use this object to configure catalog feed or the "pull" method for updating the catalog.

FieldDescription

enabled
Type: boolean

Required.
Flag to enable or disable the feature

feed_url
Type: string

Required.
URL of a publicly hosted file containing the business's inventory (must be in CSV, TSV, or XML format)