Skip to main content

Sync Odoo 3PL Shipments

POST 
/api/odoo-3pl/:integration_instance/shipments/sync

Queues a refresh of shipments from Odoo 3PL. Each newly shipped order is recorded as a sales order fulfillment with its tracking number and, when enabled, its shipping cost.

Not yet available to API tokens

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

The sync runs in the background. The response returns tracked_job_log_id, which you can use to follow the job's progress and outcome.

Body (all optional):

  • mode — since_last_update (default; re-pull everything and upsert changes), from_start_date (only rows whose request date is on/after the instance's configured sync start date), date_range (only rows whose request date falls between date_from and date_to), specific (only rows whose reference, e-commerce order number or tracking number contains search).
  • date_from — date (Y-m-d); required when mode is date_range.
  • date_to — date (Y-m-d); must be on/after date_from.
  • search — string, max 255; required when mode is specific.

Odoo 3PL has no server-side filters, so narrowing is applied as records are ingested.

Requires the integrations.sync permission.

Authentication: Bearer token (Personal Access Token).

Request​

Responses​

OK

Response Headers
    Content-Type