Skip to main content

Update Odoo 3PL Integration Instance

PUT 
/api/odoo-3pl/:integration_instance

Updates an Odoo 3PL integration instance. This is a partial update (PATCH is also accepted): send only the fields you want to change, and omitted settings keep their current values.

Not yet available to API tokens

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

Body (all optional):

  • name — string, max 255, unique across integration instances.
  • connection_settings — object:
    • base_url — string. HTTPS URL ending in /api/v1/3pl.
    • api_key — string, nullable. Must start with 3pl_. An empty or null value keeps the stored key.
  • settings — object, optional:
    • timezone — string, valid timezone identifier (default America/Toronto). The timezone Odoo 3PL's naive date-times are read in.
    • auto_create_products — boolean (default false).
    • record_shipping_costs — boolean (default true). Record the shipping fee Odoo 3PL reports on each shipment as a fulfillment cost.
    • sync_start_date — date, nullable. Anchor for from_start_date syncs.
    • fulfillment_cost_financial_line_type_id — integer, nullable, an existing financial line type ID used for recorded shipping costs.
  • is_automatic_sync_enabled — boolean, optional. Turns scheduled syncing on or off.

Requires the integrations.update permission.

Authentication: Bearer token (Personal Access Token).

Request​

Responses​

OK

Response Headers
    Content-Type