ShipMonk adapter - setup and reference

ShipMonk adapter - setup and reference

What this adapter provides

Orders created and submitted in one push, amendment by upsert, despatch write-back with per-parcel tracking, available stock via the inventory-sync search, product create, inbound receivings, goods received confirmations, returns and warehouse lookups.

Not on the integrations API: order cancellation and holds, the supplier master, ASN cancellation and lot detail. Webhooks exist but are subscribed in the ShipMonk app rather than over the API.

Prerequisites

  • The 3PL Connector core app, installed and licensed.
  • A ShipMonk store and its API key. One Odoo instance maps to one ShipMonk store.
  • The API host from your ShipMonk API pack, if Test Connection 404s.

Installation

Install LataSys 3PL Connector: ShipMonk Adapter alongside the core app. The provider appears in the instance form's Provider list as soon as the module is installed - no configuration is needed to register it.

Connection setup

Field Value
Provider ShipMonk
Base URL leave empty unless Test Connection 404s, then use the host from your API pack
API Key the store's API key, sent in the Api-Key header

Press Test Connection - it lists the ShipMonk facility codes (KY1-KY8, PA1-PA3, TX1, NV1, UK1, CZ1, MX1 and others).

Mappings

Warehouses. Press Fetch Warehouses and put the ShipMonk facility code in each warehouse mapping's remote code.

Carriers and services. Map delivery methods onto the shipping method names agreed with ShipMonk, or set a Default Shipping Method. Leave both empty to let ShipMonk rate-shop.

Statuses. Press Load Missing Defaults: pending, submitted, processing, shipped, hold, cancelled.

ShipMonk Options tab

Field Meaning
Default Shipping Method Requested shipping method sent when no mapping resolves one. Leave empty for ShipMonk's default rate shopping.

Provider-specific behaviour

Orders are two calls, and both must succeed. ShipMonk creates the order (POST /v1/integrations/order) and then submits it to the warehouse (POST /v1/integrations/submit-order). An order that is created but never submitted sits at ShipMonk unfulfilled while looking perfectly synced in Odoo - the worst possible failure. The connector therefore does both in one push and treats a failed submit as a failed push, naming the ShipMonk order id in the error. Retrying is safe because the create call upserts on your order number.

One instance per store. API keys are scoped to a ShipMonk store, so several storefronts mean several instances. The Order Routing pack can split across them by rule.

Inventory sync is a two-step walk. A POST opens the search and a GET pages it. The canonical quantity is AVAILABLE, not gross on hand.

Weights are pounds. Odoo kilograms are converted on product push.

Troubleshooting

Symptom Cause and fix
Test Connection returns 404 The host differs by account generation. Put the host from your ShipMonk API pack in the Base URL field.
"created order N but rejected the submit step" The order exists at ShipMonk but is not released. Fix the cause named in the error and retry - the create upserts, so no duplicate.
401 on every call Wrong or revoked store API key. Regenerate it in the ShipMonk app.
Order cancel greyed out Expected - the integrations API has no cancel endpoint. Cancel in the ShipMonk app before picking starts.

Part of the LataSys 3PL Connector. Support: support@latasys.com | Help Center

    • Related Articles

    • ShipBob adapter - setup and reference

      Everything you need to connect the LataSys 3PL Connector to ShipBob: prerequisites, connection setup, mappings, capabilities and provider-specific behaviour. ShipBob's Developer API is versioned REST/JSON (this adapter speaks the 2026-07 version). ...
    • Huboo adapter - setup and reference

      Everything you need to connect the LataSys 3PL Connector to Huboo: prerequisites, connection setup, mappings, capabilities and provider-specific behaviour. The adapter speaks Huboo's public REST API v2. What this adapter provides Flow Supported Order ...
    • ShipHero adapter - setup and reference

      Everything you need to connect the LataSys 3PL Connector to ShipHero: prerequisites, connection setup, mappings, capabilities and provider-specific behaviour. What this adapter provides Flow Supported Order push and despatch write-back Yes Order ...
    • MintSoft adapter - setup and reference

      Everything you need to connect the LataSys 3PL Connector to MintSoft (Mintsoft OMS/WMS): prerequisites, connection setup, mappings, capabilities and provider-specific behaviour. What this adapter provides Flow Supported Order push and despatch ...
    • Infoplus adapter - setup and reference

      What this adapter provides Orders (create, amend, cancel), despatch write-back with multi-parcel tracking, available stock, item create and update, ASNs, goods received confirmations from item receipts, warehouse and carrier lookups. Not part of this ...