Instance states and connection settings

Instance states and connection settings

Settings live on the instance form (3PL Connector > Configuration > Instances). Only Admins can change them, and every change is tracked in the instance's chatter. Settings whose capability the provider does not support are hidden throughout.

Header and identity

Name. The label used everywhere - dashboard card, dropdowns, chatter, the Sync Log. Must be unique per company.

Provider. Which 3PL this instance talks to. Locked once the instance leaves Draft - create a new instance rather than repointing an existing one, so history stays attached to the right 3PL.

Environment - Sandbox / Staging vs Production. Controls the default API host and shows as a coloured badge (blue Sandbox, green Live) on the dashboard and instance list. Locked while the instance is Active. Example: run "Sprint (Sandbox)" and "Sprint Live" as two instances; test risky changes on the sandbox one first, with zero chance of touching live orders.

State. Draft > Connected > Active (and Paused). Draft means untested credentials. Connected means Test Connection succeeded but the scheduler is not running. Active means scheduled flows run automatically. Paused stops the scheduler but keeps manual operations available.

  • Test Connection - makes a real, harmless API call and logs it.
  • Activate - requires at least one warehouse mapping; starts the scheduler.
  • Pause - suspends scheduled syncs. Nothing queues up dangerously: when you resume, polls simply pick up the current remote state.
  • Reset to Draft - for re-keying credentials or repointing hosts.

Connection tab (Admins only)

API Base URL. Pre-filled from the provider and environment. Override only if your 3PL gives you a dedicated host.

Credentials. Fields shown depend on the provider's authentication type (API key, Basic, bearer token with refresh). The provider-specific help box on this tab states exactly what goes in each field. Credential values are never shown to non-Admins and are always redacted in Sync Log request headers.

Webhook URL / token. Some 3PLs can push events instead of waiting to be polled. Give the 3PL the displayed URL (it embeds a secret token). Anything received is logged against the instance and triggers a status refresh for any order the payload references. Polling remains the safety net - a missed webhook is caught by the next poll, so webhooks are an accelerator, never a dependency.

    • Related Articles

    • Settings reference

      Settings is where you manage the app's connection to Amazon, decide which marketplaces your store maps to, choose which AI engine writes your listing content, and look after the data the app stores in your Shopify store. It is organised into five ...

    • Order behaviour settings

      These settings decide how orders leave Odoo and what happens when reality at the warehouse disagrees with the plan. Each entry covers what the setting does, its default, and a scenario where it matters. Order Behaviour Send Orders Automatically ...

    • Stock, inbound, returns and housekeeping settings

      Returns Behaviour (shown when the provider supports returns) Damaged Returns Location. Where returned stock graded non-restockable by the warehouse is received. Leave empty and the connector creates a Returns - Damaged internal location under the ...

    • Connect your first 3PL

      Everything from a blank instance to a live connection, in the order you should do it. Install the app and assign roles first (see the previous articles). Step 3 - Create the instance Go to 3PL Connector > Configuration > Instances > New. Name - how ...

    • What is the 3PL Connector?

      LataSys: 3PL Connector joins your Odoo database to one or more third-party logistics warehouses (3PLs). Once an instance is connected and activated, the connector pushes confirmed sales orders to the warehouse, polls their progress, writes despatch ...