Skip to main content

Partially Update eBay Integration

PATCH 
/api/ebay/:integrationInstance

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).

Not yet available to API tokens

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

Accepts the same body fields as the PUT update; all fields are optional.

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