About the Marketplace APIs

The Wix Marketplace connects clients who need professional help building or growing their site with the providers who deliver it. A client submits a request, Wix matches it with suitable providers, and each match becomes an engagement the provider works through to delivery and review.

The Marketplace APIs are built for providers and the apps that serve them. They surface the work waiting on a provider and let the provider manage how they show up in the marketplace:

• Projects: Retrieve and advance the engagements between a provider and their clients. Read what each client asked for, move a project through its lifecycle as work starts, finishes, or falls through, and respond to the reviews clients leave.
• Provider State: Read a provider's own standing in the marketplace — their status and their availability — and pause or resume receiving new leads, for example while on vacation.

How the APIs fit together

A provider's presence in the marketplace and the work they take on are two sides of the same account. The Provider State API governs whether a provider is live and accepting leads: only a published, available provider is matched with new client requests. Each match Wix creates becomes a project, and the Projects API is where the provider reads and drives that engagement from first contact through to delivery and review. A provider who pauses their availability stops receiving new projects but continues to manage the ones they already have.

Both APIs are scoped to the caller's own provider account. A provider reads and manages only their own state and their own projects.

Terminology

• Provider: a professional who offers services in the Wix Marketplace. A provider's ID is their Wix account ID.
• Client: a Wix user who requests help from a provider.
• Brief: the request a client submits when looking for help. A project is created from a brief.
• Project: the engagement between one client and one provider for a submitted brief.
• Provider state: a provider's standing in the marketplace, including their status and availability.
• Availability: whether a provider is currently accepting new leads.

Before you begin

It's important to note the following points before starting to code:

• Both APIs are scoped to the caller's provider account. A project or provider state belonging to another account reads as not found.
• Neither projects nor provider states are created through these APIs. Wix creates a project when it matches a brief with a provider, and a provider state when the provider registers for the marketplace.