Skip to main content

Create Integration Instance

POST 
/api/magento1/instances

Creates a Magento 1 integration instance from the supplied SOAP credentials and settings, and creates the linked sales channel record in the same request.

Not yet available to API tokens

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

Request body fields:

  • name (string, required) — display name for the connection.
  • connection_settings (object, required):
    • store_base_url (string, required) — the store's base URL (any trailing slash is stripped).
    • api_user (string, required) — the SOAP API user name.
    • api_key (string, required) — the SOAP API key. Stored server-side and never returned.
  • start_date (string, optional) — date (YYYY-MM-DD); orders placed before it are not imported.
  • inventory (object, optional):
    • masterOfStock (string) — sku.io or Neither.
    • inventoryModificationRules (object) — maxRuleType, minRuleType (strings) with optional maxRuleTypeValue, minRuleTypeValue, subtractBufferStock (numbers).
    • selectedWarehouses (array of integers) — ids of warehouses whose stock feeds the store.

The response returns the created instance. Note that the API normalizes success status codes to 200.

Authentication: Requires Bearer token.

Request​

Responses​

OK