Skip to content

Integration Detail ​


Contents ​


1. Features ​

Review everything about one integration: what it is authorised to do, what its credentials are, when it was last called, and how webhook delivery is going. Start here whenever the other party reports "we can't connect" or you need to revoke access.

Jump to: Basic information | Credentials | Permission scopes | Webhook

1.1 Basic information ​

FieldDescription
NameThe name of this integration
Integration typeCreation-time compatibility identifier; formal dated upgrades do not require new credentials
StatusWhether it is currently usable. While disabled, calls are rejected at authentication
DescriptionThe purpose noted at creation
Created AtWhen it was created
Last UsedThe last successful call. Long empty means the other party never connected, or stopped using it

1.2 Credentials ​

The client ID can always be copied. Only the access token suffix is shown; an older key without a suffix displays Full key is no longer available. Full keys appear only at creation or rotation. Expiration, last rotation and current-key use are also shown. Usage timestamps can lag by five minutes; an empty value does not prove that switchover is complete.

Existing keys remain Never expires and are not invalidated by this update. Ordinary edits do not change expiration. New keys and replacements require a choice of six months, one year or no expiration. After expiration, issue a replacement to continue calling the API. Key expiration alone does not disable webhook signatures or delivery.

▸ Routine rotation

  1. Requires integration management permission. Press Rotate key, choose the new key's lifetime and confirm.
  2. The new key works immediately. The save window shows its full value and expiration and allows repeated copying. Acknowledge that it is saved before closing. The client ID, scopes and webhook settings stay the same.
  3. The previous key works for up to 24 hours or until its original expiry, whichever comes first. Update the other system before the displayed transition deadline.
  4. Once switched, Revoke previous key ends the old key's access early and cannot be undone. Further rotation is blocked until the previous key is revoked or the transition ends.

▸ Suspected key exposure

Confirm Revoke all keys now to invalidate both keys immediately and disable the integration and webhook. This is irreversible; re-enabling does not restore revoked keys. To reconnect, rotate and deliver a new key, enable the integration, and enable the webhook separately.

1.3 Permission scopes ​

What these credentials are allowed to do. To add or remove scopes, go to Edit Integration.

Legacy API versions have no concept of scopes, so this section does not appear — those credentials can reach everything the legacy version exposes.

1.4 Webhook ​

If this integration has event delivery configured, this section shows:

ItemDescription
URLThe endpoint events are delivered to
Webhook versionThe payload format version, independent of the integration's API version
Subscribed EventsWhich events are currently delivered
Signature VerificationNormally masked. Regenerate Secret shows the full new key in a save window where it can be copied. It cannot be viewed again after closing
DeliveriesHow many deliveries this webhook has accumulated

The enabled switch sits at the right of this section's title bar (a tick/cross icon with no label). You toggle it here, not on the edit page. Turning it off stops delivery while keeping the configuration, and you can turn it back on at any time; events that occur while it is off are not replayed afterwards.

⚠️ Rotating a webhook signing key invalidates the old value immediately, without a 24-hour transition. Agree a switchover time and deliver the new value from the save window.

To change the URL, version or subscribed events, go to Edit Integration.

Test: this actually sends a delivery to the URL above — the other party really receives a test event, it is not a simulation. The dialog that follows shows the status, response code and duration, which you can use to confirm their endpoint is reachable and the signature is configured correctly. The response code tells you whether their server returned an error (5xx) or the URL or signature is misconfigured (4xx); an unreachable endpoint or a timeout has no response code at all and shows as N/A.

Side effects to be aware of: the test is recorded as a real delivery, so Deliveries increases by one and it appears in Webhook Logs (flagged as manually triggered, separate from automatic deliveries). A failed test is not retried automatically.

Disabling the whole integration also disables its webhook; re-enabling the integration does not restore the webhook automatically — turn it back on with the switch above.

1.5 Delete ​

Removes these credentials. Cannot be undone. Any token the other party kept stops working immediately, and the webhook is disabled before being detached. If you are only pausing the relationship, disable it instead.


2. FAQ ​

Jump to: FAQ | Important notes

2.1 FAQ ​

▪ Can an integration append order items after an automatic processing gate has ended? ​

Yes. General order-item appends do not depend on App gate deadlines. The order must still be editable and not in picking, and the integration needs order write permission. Existing lines are preserved. If the connection is lost after sending, check the operation result first; missing evidence does not prove that nothing was written and must not trigger a blind retry.

▪ The other party keeps getting 401 / authentication failures. Where do I look? ​

Check whether the integration is enabled and whether the key has expired, been revoked or passed its transition deadline. Ask the other party to compare the key suffix and confirm they are using a valid value, then check IP restrictions against their source address.

▪ They are getting 403 / insufficient permissions. ​

That is not a credentials problem — the permission scopes do not cover what they are trying to do. Tick the matching scope on the edit page; there is no need to regenerate the token.

▪ They are getting 429. ​

They have hit a usage limit. It may be calls bunched too closely together, or the daily allowance being exhausted. Check the daily usage card on API Integrations to tell which.

▪ Last Used is still empty. Does that mean the integration failed? ​

It means there has never been a successful call. They may not have started yet, or there may be a mismatch in credentials, IP or version. Ask them for the exact error they receive and work through the questions above.

▪ Webhook delivery keeps failing. Does that affect the orders themselves? ​

No. Webhooks are an additional notification channel; failed delivery does not affect order or stock data, and the other party can still query the API directly. Do fix it promptly, though, or their system will keep working from stale status.

▪ Can the other party still look up stock after a product is deleted? ​

Inventory lists in formal versions v1, 2026-09, 2026-10, and 2026-11 exclude deleted products by default. For historical reconciliation, ask the other party's engineer to explicitly include deleted products. Existing inventory details remain accessible, and deleting a product does not remove physical stock. Depleted and blocked batches of live products remain queryable; filters can limit the results to normal batches.

To synchronize product deletions, the integration also needs product read access and must retrieve deletion times from the product list with deleted products included. Inventory change notifications alone do not report product deletion. A new product can reuse the same SKU, so distinguish old and new products by their product identifiers to avoid combining their stock. Refer to the integration documentation for the selected version for parameters and fields.

▪ Can the other party identify the inventory batches actually used for each order? ​

With version 2026-11 and inventory read access, they can query outbound movement batches, expiry dates and quantities, then match the public order line identifiers to order details. Reading the order still requires order read access. Deleted source lines or unresolved relationships may prevent matching to the original order, so these records alone are not a permanent cost ledger.

▪ Can the other party read or change processing fees? ​

With version 2026-11, work order read access and a plan that supports work orders, they can read the warehouse's recorded fees and each fee's billing state from a single work order detail. Only the warehouse can maintain fees; integrations cannot change them. A closed billing period does not mean paid. No recorded fees does not mean free service, and fees may be added after completion. Currency and tax treatment follow your agreement with the warehouse. For current fees, ask the other party to query the single work order again instead of only synchronizing recently updated work order lists.

2.2 Important notes ​

⚠️ Important ​

  • The previous key stops working at its transition deadline. Follow Routine rotation to complete the switch.
  • Deletion cannot be undone and also detaches the webhook configuration. Use disable for a temporary pause.
  • Full keys cannot be retrieved after closing. Rotate to replace a lost key.

FeatureDescriptionLink
API IntegrationsView all integrations and daily usageGo
Edit IntegrationAdjust scopes, IP restrictions and webhookGo
Create IntegrationIssue another set of credentialsGo

Last updated 2026-11-16 19:57