eBay
List eBay Integrations
List every connected eBay integration instance on the account. Returns the full instance record for each connection, including its settings and sync state.
Create eBay Integration
Create a new eBay integration instance. The response includes a redirect_url pointing to the eBay consent page; open it to authorize the connection. After authorization completes, listings and orders are automatically imported in the background.
Get eBay Integration
Get a single eBay integration instance, including its sales channel, store, and settings.
Update eBay Integration
Update an eBay integration instance. With PUT, a provided integration_settings object replaces the stored settings; use PATCH for merge semantics.
Partially Update eBay Integration
Partially update an eBay integration instance using merge semantics: provided integration_settings and connection_settings keys are deep-merged into the stored values, so nested settings you omit are preserved. Exception: the inventory object is always replaced in full when provided (its warehouse and location lists are positional arrays).
Delete eBay Integration
Delete an eBay integration instance. The deletion runs as a background job that removes the connection and its channel data. Returns 204 immediately after the job is queued.
Get eBay Authorization URL
Get the eBay OAuth consent URL for this integration instance. Open the returned URL in a browser to grant (or re-grant) access. Use this to reconnect an integration whose refresh token has expired or been revoked.
List eBay Integration Activity Log
List the audit history of eBay order records belonging to this integration instance, most recent first. Each entry describes a create/update event, the changed attributes, and who (or what) caused it.
Get eBay Listing
Get a single locally-synced eBay listing, including its mapped product (when mapped) and the raw listing payload as last fetched from eBay.
List Orders for eBay Listing
List eBay orders that contain the given listing, most recent first. Returns 403 when the listing does not belong to the integration instance.
Get eBay Listing Sync Status
Get summary statistics about the locally-synced eBay listings for an integration instance: the most recently updated listing, total listing count, and how many listings are mapped to products.
Refresh eBay Listings
Queue a background refresh that re-fetches listings from eBay for this integration instance. Returns immediately; listings are updated as the queued work completes. For a refresh whose progress can be polled, use the tracked refresh endpoint instead.
Start Tracked eBay Listing Refresh
Start a tracked background refresh of listings from eBay. Returns a tracked_job_log_id whose progress can be polled while the refresh runs.
Map eBay Listing to Product
Map a single eBay listing to an existing product or subscription offering. Creates (or updates) the product listing link and automatically queues re-mapping of any historical order lines that referenced the listing.
Unmap eBay Listing
Remove the product mapping from an eBay listing. The listing itself is untouched; only the link to the product is deleted. Returns 422 when the listing is not currently mapped.
Bulk Map eBay Listings
Map multiple eBay listings to products in one call by SKU.
Import eBay Listing Mappings
Queue a background import of listing-to-product mappings from a previously uploaded CSV file. The CSV must contain the eBay item identifier column and the SKU to map each listing to.
Create Product from eBay Listing
Create a product from a single eBay listing and map the listing to it. If a product with the listing SKU already exists, the listing is linked to that product instead of creating a duplicate (linked_existing is true in the response). Returns 422 when the listing is already mapped.
Bulk Create Products from eBay Listings
Queue background creation of products from eBay listings. Each targeted listing that resolves to a new SKU creates a product and maps the listing to it.
Bulk Archive eBay Listings
Archive eBay listings. Listings that have channel orders are silently skipped (use the archiveable check to find out which ones qualify first).
Bulk Unarchive eBay Listings
Restore previously archived eBay listings.
Check eBay Listings Archiveable
Check which eBay listings can be archived. A listing with channel orders cannot be archived; the response gives a per-listing verdict and reason.
Bulk Delete eBay Listings
Delete eBay listing records from the local catalog, together with their product mapping links. This does not end or modify the live listing on eBay.
Check eBay Listings Deleteable
Check which eBay listings can be deleted. The response gives a per-listing verdict and reason.
Sync eBay Listing Inventory
Push current stock quantities to eBay for the given listings. Quantities are computed from the warehouses selected in the integration inventory settings.
Hydrate eBay Listing Template
Fill an eBay listing template with values from a product. Static template fields keep their configured value; dynamic fields are evaluated against the product. Returns both the resolved field list and the generated listing payload ready for publishing.
Get eBay Field Mappings
Get the field mappings used when creating products from eBay listings. Returns the built-in default mappings, any custom overrides saved for this integration instance, and the effective (merged) mapping set, along with the catalogs of available eBay listing fields and product fields.
Update eBay Field Mappings
Replace the custom field mappings for this integration instance. Each mapping pairs an eBay listing field with the product field it populates; optional parsers transform the value on the way in.
Start Tracked eBay Order Refresh
Start a tracked background refresh of orders from eBay. Returns a tracked_job_log_id whose progress can be polled while the refresh runs.
Get eBay Order Sync Status
Get summary statistics about the locally-synced eBay orders for an integration instance: the most recent order, total order count, and how many are linked to sales orders.
Refresh eBay Order
Re-fetch a single order from eBay and update the local record. Returns the refreshed order.
Get Raw eBay Order
Fetch the order directly from the eBay Fulfillment API and return the live payload as eBay serves it (not the locally cached copy). Useful for verifying what eBay currently reports for the order.
List eBay Order Activity Log
List the audit history of a single eBay order, most recent first. Each entry describes an event, the changed attributes, and who (or what) caused it.
Archive eBay Order
Archive an eBay order record. Archived orders are excluded from listings and bulk operations by default. Returns whether the order was newly archived (archived: false means it was already archived).
Unarchive eBay Order
Restore an archived eBay order record. Returns whether the order was newly restored (unarchived: false means it was already active).
Delete eBay Order
Delete a single eBay order record from the local store. This does not affect the order on eBay, and any linked sales order is not removed by this call.
Show Order
Retrieve a single Ebay order by its database ID. Requires Bearer token.
Delete Linked Sales Order
Delete the sales order linked to an eBay order, keeping the eBay order record itself. Optionally archives the eBay order afterwards so it will not be re-created by order automation.
Bulk Delete eBay Orders
Delete multiple eBay order records from the local store in one call. Orders on eBay are unaffected.
List Pre-Start-Date eBay Orders
Query eBay live for orders created before the account inventory start date, within a creation-date window. Returns lightweight order data with per-order eligibility flags so eligible orders can be selected for import. An inventory start date must be configured before using this endpoint.
Search Pre-Start-Date eBay Orders
Search eBay live for specific pre-start-date orders by order ID or buyer username. Returns the same shape as the windowed query, filtered to orders created before the inventory start date.
Import Pre-Start-Date eBay Orders
Import selected pre-start-date orders from eBay. Each order is fetched with its own throttled API call, so the import runs as a queued background job rather than synchronously. Downloads the full order data for each ID and stores it locally; orders that already exist locally, were cancelled, or cannot be found on eBay are skipped with a per-order reason. Returns a tracked_job_log_id whose progress can be polled while the import runs.
List eBay Fulfillments
List fulfilled shipments for sales orders that originated from this eBay integration, most recent first. Each row includes its eBay submission state (sync_status: submitted or pending).
List Pending eBay Fulfillments
List fulfilled shipments that are waiting to be submitted to eBay (not yet pushed, order not cancelled, and not pickup-type). These are the fulfillments the automatic sync will submit next.
Get eBay Fulfillment Stats
Get fulfillment submission statistics for the integration instance: how many fulfillments are pending submission to eBay and the automatic submission schedule.
Submit eBay Fulfillment
Submit a single fulfillment to eBay, uploading its tracking number and carrier so the buyer is notified. The fulfillment must be in fulfilled status and not yet submitted.
Bulk Submit eBay Fulfillments
Submit multiple fulfillments to eBay in one call. Fulfillments that are already submitted, cancelled, or pickup-type are skipped. The response reports per-fulfillment failures.
Submit All Pending eBay Fulfillments
Submit every pending fulfillment for this integration instance to eBay. Equivalent to bulk-submitting the full pending list.
Submit Sales Order Fulfillment
Submit a sales order fulfillment to eBay by ID, uploading its tracking information. Body-based alternative to the path-based submit endpoint.
List eBay Inventory Comparison
List the inventory comparison for this eBay integration: one row per mapped listing, showing the locally computed quantity (sku_quantity), the quantity eBay currently reports (sales_channel_quantity), the variance, and a sync status of synced, variance, or needs_recalc. eBay has a single stock pool, so every row belongs to one synthetic location whose ID equals the integration instance ID.
Get eBay Inventory Summary
Get aggregate inventory-sync statistics for the integration instance: total tracked listings, how many are in sync with eBay, how many have a quantity variance, how many need local recalculation, and the timestamps of the last live fetch and the last push to eBay.
List eBay Inventory Locations
List inventory locations for this integration. eBay has no multi-location inventory, so this always returns a single synthetic location whose ID equals the integration instance ID; it exists so eBay responses share the same shape as multi-location channels.
Start eBay Inventory Recache
Start a tracked background job that recalculates the local (SKU.io side) quantities for every mapped listing on this integration. Run this when local quantities are flagged as needing recalculation. Returns a tracked_job_log_id to poll for progress.
Get eBay Inventory Recache Progress
Get the progress of a previously started inventory recache job.
Start eBay Inventory Sync
Start a tracked background job that pushes local quantities to eBay for every mapped listing on this integration. Returns a tracked_job_log_id to poll for progress.
Get eBay Inventory Sync Progress
Get the progress of a previously started inventory sync job.
Start eBay Live Inventory Fetch
Start a tracked background job that fetches current live quantities from eBay and stores them for comparison against local quantities. Returns a tracked_job_log_id to poll for progress.
Get eBay Live Inventory Fetch Progress
Get the progress of a previously started live inventory fetch job.
List Integration Instances
List all Ebay integration instances with standard list query parameters. Requires Bearer token.
List Legacy Products (Integration)
List all Ebay legacy product listings (the eBay listings grid) for a specific integration instance. Uses Spatie QueryBuilder — filters use the bracket format (filter[key]=value).
Show Legacy Product
Retrieve a single Ebay legacy product listing. Requires Bearer token.
Update Legacy Product
Update an existing Ebay legacy product listing. Requires Bearer token.
Delete Legacy Product
Delete an Ebay legacy product listing. Requires Bearer token.
Create SKU Products from Listings
Create SKU.io products from selected Ebay listings. Returns 400 if a listing is missing a SKU. Requires Bearer token.
Refresh Legacy Products
Queue a job to refresh all legacy product listings from the Ebay API. Returns a tracked job log ID for progress monitoring. Requires Bearer token.
Map Products
Map Ebay legacy listings to SKU.io products. Requires Bearer token.
Smart Match Product
Find suggested SKU product matches for a single eBay listing.
Get Raw Product from eBay
Fetch the raw eBay GetItem response for a single listing, live from eBay's Trading API. Powers the 'Load Raw Data from eBay' button on the listing detail page.
Export Legacy Products
Export all legacy product listings for an integration instance as a file download. Requires Bearer token.
Archive Legacy Products
Archive selected Ebay legacy product listings. Requires Bearer token.
Unarchive Legacy Products
Unarchive selected Ebay legacy product listings. Requires Bearer token.
Check Archiveable Products
Check which of the given listings can be archived. Returns lists of archiveable and non-archiveable products. Requires Bearer token.
Delete Legacy Products (Bulk)
Bulk delete selected Ebay legacy product listings. Requires Bearer token.
Check Deleteable Products
Check which of the given listings can be deleted (not linked to any Ebay orders). Requires Bearer token.
Import Mappings
Import field mapping configuration for linking Ebay listing fields to SKU.io product fields. Requires Bearer token.
Sync Inventory
Push current SKU.io inventory quantities to Ebay listings. Requires Bearer token.
Hydrate Product Template
Hydrate an Ebay listing template with data from a SKU.io product. Requires Bearer token.
Get Suggested Categories
Get Ebay category suggestions for a product query using the Ebay Taxonomy API. Requires Bearer token.
Build Payload
Build the Ebay listing payload for one or more SKU.io products. Used to preview the data that will be sent to Ebay before publishing. Requires Bearer token.
Publish Listings
Publish SKU.io products as new Ebay listings. Returns 400 if Ebay returns a bad request error. Requires Bearer token.
List Orders (Integration)
List all Ebay orders for a specific integration instance with standard list query parameters. Returns paginated results.
Refresh Orders
Queue a job to refresh all orders from the Ebay API. Returns a tracked job log ID for progress monitoring. Requires Bearer token.
Create SKU Orders from Ebay
Create SKU.io sales orders from selected Ebay orders. Requires Bearer token.
Export Orders
Export all Ebay orders for an integration instance as a file download. Requires Bearer token.
Bulk Archive eBay Orders
Archive multiple eBay orders in one request.
Bulk Unarchive eBay Orders
Unarchive multiple eBay orders in one request.
Update SKU Orders from Channel Orders
Update existing SKU orders from eBay channel orders. Accepts {ids} or {update_all_orders: true, filters?: <canonical filter object>} - filters scope the update to the grid's matching orders.
List Product Settings
Retrieve Ebay product settings for a specific SKU.io product. Returns all Ebay-specific settings (e.g., auction-until-sold configuration) for the product across all integration instances. Requires Bearer token.
Save Product Settings
Create or update Ebay product settings for a SKU.io product. Upserts by product_id and integration_instance_id. Requires Bearer token.
Get Blemished Auto-List Settings
Get the blemished auto-list configuration for an eBay integration instance. When a return is dispositioned as a new blemished SKU and its inventory lands, an enabled configuration automatically lists that SKU on eBay as an auction-until-sold listing using the selected default template. Returns default values when no configuration has been saved yet. Requires Bearer token.
Update Blemished Auto-List Settings
Create or update the blemished auto-list configuration for an eBay integration instance. Requires Bearer token.
Uncovered Blemished Products
Get a list of blemished/refurbished products that do not have an active Ebay listing covering them. Used for identifying inventory gaps in Ebay auction-until-sold programs. Requires Bearer token.
Listed Blemished Products Out of Stock
Get blemished products that currently have active Ebay listings but are out of stock. Useful for identifying listings that should be ended or revised due to zero inventory. Requires Bearer token.
List Blemished Auto-List eBay Instances
Return the eBay integration instances that have blemished auto-listing enabled. Use this to determine which instance a blemished product should be listed on before calling Auto-List Blemished Products. Requires Bearer token.
Auto-List Blemished Products on eBay
Queue auto-listing of the given blemished products on an eBay integration instance that has blemished auto-listing enabled. Each product is listed as an auction-until-sold listing; products that are already listed, out of stock, or not blemished are skipped. Processing runs in the background and the response returns an id for tracking progress. Requires Bearer token.
List Payouts
Returns a paginated list of eBay Managed Payments payouts synced for the integration instance. Each payout includes the settlement amount, a normalized summary split (sales, refunds, fees, shipping labels, charges, disputes, adjustments, and net), the accounting status, and the number of transaction lines.
Get Payout Filter Options
Returns the available filter values for the payouts list: every payout status and accounting status the system recognises, plus the settlement currencies present in the synced payouts for the integration instance.
Sync Payouts
Queues a background sync that imports eBay Managed Payments payouts and their transaction lines from eBay for the integration instance. Returns a tracked_job_log_id that can be used to monitor the progress of the sync.
Get Payout
Returns the full detail of a single payout, including the raw summary breakdown, the payout instrument, and every transaction line with its per-fee breakdown and linked local order where resolved. Returns 403 if the payout does not belong to the integration instance.
List Payout Transactions
Returns a paginated list of eBay Managed Payments payout transaction lines across every payout synced for the integration instance — the line-level detail behind the payout summaries. Each line includes its transaction type, financial code, booking entry (CREDIT/DEBIT), gross amount, total fee amount, an itemized fee breakdown (fees_json), status, and cross-link blocks for the parent payout and (when matched) the eBay order.
Get Payout Transaction Filter Options
Returns the distinct filter values present in the synced payout transactions for the integration instance: every transaction type and every financial code, so a client can populate the transaction filters.
List Global Payout Mapping Groups
Returns every global (workspace-wide) payout mapping group, ordered by sort order. Global groups apply to all eBay integration instances unless an instance defines its own groups. If no global groups exist yet, the two defaults (eBay Sales as an invoice group and eBay Fees as a bill group) are created and returned.
Create Global Payout Mapping Group
Creates a global payout mapping group that applies to every eBay integration instance. Type mappings assigned to the group are combined into a single financial document of the group's document type when a payout is posted.
Reorder Global Payout Mapping Groups
Reorders the global payout mapping groups. Pass the full list of global group IDs in the desired order; each group's sort order is updated to match its position in the list.
Update Global Payout Mapping Group
Updates the name, document type, or sort order of a global payout mapping group.
Delete Global Payout Mapping Group
Deletes a global payout mapping group. Type mappings that referenced the group are kept but left without a group assignment.
List Payout Mapping Groups
Returns the payout mapping groups visible to the integration instance: the instance's own groups first, followed by the global groups. If no global groups exist yet, the two defaults (eBay Sales as an invoice group and eBay Fees as a bill group) are created first.
Create Payout Mapping Group
Creates a payout mapping group scoped to the integration instance. Instance groups are listed ahead of the global defaults and can be used to separate the instance's payout lines into their own financial documents.
Reorder Payout Mapping Groups
Reorders the payout mapping groups scoped to the integration instance. Pass the full list of the instance's group IDs in the desired order; each group's sort order is updated to match its position in the list. Global groups are not affected.
Update Payout Mapping Group
Updates the name, document type, or sort order of a payout mapping group scoped to the integration instance.
Delete Payout Mapping Group
Deletes a payout mapping group scoped to the integration instance. Type mappings that referenced the group are kept but left without a group assignment.
List Payout Type Mappings
Returns the resolved payout type mappings for the integration instance: per-instance override rows plus the global default rows they have not overridden. Each row maps a financial code (a normalized transaction type, expanded with its memo for non-sale charges) to a general-ledger account and an optional mapping group; is_override indicates an instance-specific row. eBay payout transactions carry no separate source type, so source_type is typically empty and the reason is taken from the transaction memo. Before listing, any financial codes newly seen in the instance's synced payout transactions are registered as unmapped global rows so they can be configured.
Update Payout Type Mappings
Updates individual payout type mappings, assigning or clearing the general-ledger account and mapping group of each. Fields omitted from a mapping entry are left unchanged; pass null to clear an assignment.
Bulk Assign Payout Type Mappings
Assigns a general-ledger account and/or a mapping group to several payout type mappings at once. At least one of nominal_code_id or ebay_payout_mapping_group_id must be provided; pass null to clear that assignment on all selected mappings. Only mappings scoped to the integration instance are updated - global rows are not modified.
Get Payout Finance Settings
Returns the resolved payout finance settings for the integration instance: the fallback revenue and expense accounts used for unmapped payout lines, the clearing account payouts settle against, the accounting sync mode (per_order or per_payout; default per_order), and the optional payout accounting start date before which payouts are not posted. Fallback and clearing accounts fall back to the workspace-wide values when the instance has none of its own.
Update Payout Finance Settings
Updates the payout finance settings for the integration instance. All fields are optional; omitted fields keep their current values, and nullable fields can be set to null to clear them. Returns the resolved settings after the update.