Connect TrueCommerce: order messages in, shipment and invoice messages out

Ask your TrueCommerce account team for the Base URL, fill in an API key or your OAuth client credentials, test, set up trading partner mapping, activate — order messages flow in and shipment and invoice messages flow back.

The TrueCommerce connector exchanges EDI documents with your trading partners through TrueCommerce: order messages from your partners flow in and become orders, and shipment and invoice messages flow back out to those partners. It is not a store connection — everything is organised by trading partner and by message.

Prerequisites#

• A TrueCommerce account, with an account team you can ask for the API Base URL and credentials.
• At least one trading partner you exchange EDI messages with — order messages in, shipment and invoice messages out. Each partner is mapped separately later in this guide.
• A decision on which auth method this connection will use: an API key on its own, or OAuth client credentials (Client ID + Client Secret) when you have no API key. The two methods are alternatives — do not mix fields from both.

Get your credentials#

1. Ask your TrueCommerce account team for the API Base URL for your account. The connection cannot be filled in without it — it is the address every message exchange goes through.
2. If you will use an API key: ask TrueCommerce for the API key for your account, and copy it in full. With an API key, you do not need the OAuth fields.
3. If you have no API key: ask TrueCommerce for OAuth client credentials instead — the OAuth Client ID and the OAuth Client Secret. Both are required together.
4. Save the Client Secret somewhere safe as soon as you get it: it is shown only once. If it is lost, ask your TrueCommerce account team to issue a new one.

Fill it into Integration#

1. Open Integration → Connector Marketplace → TrueCommerce → New connection.
2. Base URL: paste the TrueCommerce API base URL your account team gave you, starting with https://. This field is required, and it must be the TrueCommerce address — an address for any other system will not answer.
3. API key: if you are using the API key method, paste the API key from TrueCommerce here. If you are using OAuth instead, leave this field empty — an empty API key field is what tells the connection to use your OAuth client credentials.
4. OAuth Client ID: required only when the API key field is empty. Paste the OAuth client ID TrueCommerce issued for your account. If you filled in an API key, you can leave this field empty.
5. OAuth Client Secret: required only when the API key field is empty, and it pairs with the OAuth Client ID — the two must come from the same issued set. It is encrypted at rest and never echoed back.

Test the connection#

Click Test connection. The test goes to the Base URL you filled in and presents the credentials of the method you chose — the API key, or the OAuth Client ID and Client Secret when the API key field is empty. A pass means TrueCommerce was reached at that address and accepted those credentials. If it fails, keep the error the test shows: it tells you whether the address or the credentials were rejected, and the FAQ below walks through each case.

Mapping / pick a template#

Mapping on TrueCommerce is per trading partner, not one setting for the whole connection. For each partner, pick that partner’s template and check how its order messages map into the standard order — order number, line items, quantities, and ship-to details — and how shipment and invoice data maps back into the message format that partner expects. A partner with no mapping set up has nowhere for its messages to land: its order messages cannot become orders, and shipment and invoice messages cannot be built for it. Work through your partners one by one, and check the mapping preview for each before activating.

Activate#

After activation, order messages from your mapped trading partners flow in and become orders, and shipment and invoice messages are sent back out to each partner through TrueCommerce. Partners without a mapping stay silent — nothing flows for them until their mapping is set up. Watch the first messages for each partner in Runs / Logs before trusting the exchange unattended.

FAQ#

Test fails: the credentials are rejected

The credentials on the connection do not match what TrueCommerce issued for your account. The usual causes are a value copied incompletely, or a half-filled method: the API key field was left empty — which switches the connection to OAuth — but only one of the OAuth Client ID and Client Secret was filled in, so the pair is incomplete and cannot be accepted.

Decide on one method and fill it in completely. API key method: paste the full API key and leave the OAuth fields empty. OAuth method: leave the API key empty and paste both the OAuth Client ID and the OAuth Client Secret from the same issued set — remember the secret is shown only once, so if your saved copy is gone, ask your TrueCommerce account team for a new one. Save and test again.

Test fails: TrueCommerce cannot be reached at all

The Base URL in the connection is wrong, so the test is knocking on the wrong door. Common causes are a mistyped or truncated address, an address meant for a different system, or an old address after your account team gave you a new one — the credentials are never even checked because nothing from TrueCommerce answers there.

Ask your TrueCommerce account team to confirm the exact API Base URL for your account, replace the Base URL in the connection with that address exactly as given — starting with https:// — then save and test again.

Connected, but a partner’s order messages never become orders

The connection itself works — the test passes and other partners may be flowing. The problem is that this trading partner has no mapping set up, or its template does not cover its order messages, so its incoming messages have nowhere to land and are never turned into orders.

Open the mapping for that trading partner, pick its template, and check the mapping preview with one of its real order messages — order number, line items, quantities, and ship-to details should all land in the standard order. Save the mapping, then check Runs / Logs for that partner’s next message.

Orders come in, but shipment and invoice messages do not reach the partner

Inbound is working, so the address and credentials are fine. The gap is on the outbound side of that partner’s mapping: the partner is mapped for order messages in, but its shipment and invoice messages out were never set up, so the fulfilled results have no message to travel back in.

Open that trading partner’s mapping and set up the outbound side as well: shipment messages and invoice messages, in the format that partner expects. Check the mapping preview with a fulfilled order, then watch Runs / Logs for the next outbound message to that partner.