Platform Marketplaces Pricing Dashboard Start for free

Platform Marketplaces Pricing Dashboard

Guide

Overview Getting started

Authentication Connecting a seller

BYOK (your own app)

Marketplace support Receiving webhooks Tracking jobs Idempotency and limits Billing Errors

API

Overview Metadata Create a seller POST List sellers GET Get a seller GET Update a seller PATCH Delete a seller DELETE

Products and variants Create product POST List products GET Get product GET Update product PATCH Archive product DELETE List variants GET Get variant GET Create variant POST Update variant PATCH Archive variant DELETE List kit components GET Replace kit components PUT Get product media soonGET Replace product media soonPUT Propagate changes soonPOST

Overview Create upload POST Complete upload POST Ingest from URL soonPOST Copy media POST Get asset GET Delete asset DELETE Read content GET

Variant inventory Get variant balance GET Record inventory movement POST Republish inventory POST List inventory movements GET List stock discrepancies soonGET Resolve discrepancy soonPOST

Overview Create warehouse POST List warehouses GET Get warehouse GET Update warehouse PATCH Archive warehouse DELETE

Marketplace products List marketplace products GET Get marketplace product GET Update marketplace product content PATCH Get resolved marketplace product content GET List marketplace product variations GET Replace marketplace product variations PUT Publish marketplace product content POST Get the catalog link soonGET Set the catalog link soonPUT Remove the catalog link soonDELETE Find catalog candidates soonGET Check catalog eligibility soonPOST

Listings Create local listing POST List listings GET Get listing GET Update listing intent PATCH Remove listing DELETE Clone listing for A/B POST Publish listing POST Validate the offer soonPOST Run a marketplace action soonPOST Refresh the offer from the marketplace soonPOST Publish listings in batch soonPOST Get resolved data GET Get observed state GET Compare desired and observed GET List offer issues GET View offer activity GET List offer relations GET List publish attempts GET List conflicts GET Resolve conflict POST List variant bindings GET Replace variant bindings PUT Update variant binding PATCH Remove variant binding DELETE Get synchronization policy GET Update synchronization policy PATCH Get marketplace options GET Update marketplace options PATCH

Overview List returns soonGET Get return soonGET Act on a return soonPOST

Returns

List returns

Lists the account returns, paginated and filtered.

GET/v1/returns

Coming soon

This route is not in the API yet. This page shows what it will do. Fields, examples and the playground arrive when it ships.

Returns the returns of every seller of the account. Filter by orderId, status or connectionId to build your after-sales queue.

Each return has the reason, the returned lines, the tracking of the way back and refundInCents. One return: Get return.

Overview

What a return is and the rules that apply to all its endpoints.

Get return soonGET

Returns one return with lines, tracking and allowed actions.