Skip to main content

Update eBay Integration

PUT 
/api/ebay/:integrationInstance

Update an eBay integration instance. With PUT, a provided integration_settings object replaces the stored settings; use PATCH for merge semantics.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

All body fields are optional:

  • name (string): New display name.
  • integration_settings (object): Same shape as on create; every key is optional.
  • connection_settings (object): OAuth token fields.
  • is_automatic_sync_enabled (boolean): Toggle scheduled background sync.

Side effects: changing start_date re-normalizes the stored date; changing store_id updates the linked sales channel; changing the pricing master triggers a price re-cache; changing inventory settings invalidates the inventory cache so quantities are recalculated.

Requires the integrations.update permission.

Store and sales channel: new orders are created in the store of this connection's sales channel. Whenever the request includes integration_settings.store_id, the sales channel is put in that store if it is in a different one — including when the value equals the saved setting, so re-saving the same store realigns a sales channel that had drifted from it. Nothing is written when the sales channel already uses that store, and orders already imported keep their store. When the sales channel moves, the response adds two top-level keys:

  • message (string): e.g. "Settings saved. New orders will now be created in store 'Curvy AU' — the sales channel was moved from 'Placeholder'."
  • sales_channel_store_updated (object): from and to, each {id, name}; from.id and from.name are null when the sales channel had no store. Both keys are absent when the sales channel did not move.

Request​

Responses​

OK

Response Headers
    Content-Type