Skip to content

The partner account

A partner is whoever builds apps on the API: a software company (an ERP, a WMS, an invoicing program), an agency, a developer, or a merchant connecting their own systems. Partners work in the partner portal, apart from the dashboard merchants use: it holds the apps, the team and the test organizations, with no orders or merchant menus.

  • One sign-in account. You register once (email and password) and use the same account in the portal and, if you are also a merchant, in the dashboard. Signing out signs you out of both.
  • Creating it: Create account registers you (or signs you in, if you already have an account) and takes you to the "New partner" step: the name and, optionally, the website (https) and the contact address. Sign in opens the portal.
  • The Partner agreement: creating the account requires accepting the Partner agreement. The acceptance is recorded, with the agreement's version.
  • The name is what merchants read as "Developed by <name>" on every app: in the store, on the app's page and on the consent screen. It may not be the platform's name, its assistant's or that of a vendor in the integration catalog, nor hold one as a word. Once the partner has a published app, a name change is reviewed like a version.
  • The contact address receives review decisions and webhook alerts. It is confirmed through a link; without a contact address or until it is confirmed, emails go to the owner's address. Security emails go to the owner and to the confirmed contact address.
  • One person may be a member of several partners and switches between them in the portal.
  • Two-factor authentication: turned on from the account's profile, in the dashboard; at sign-in, after the password, a code from an authenticator app is asked. The owner and admins who do not have it see on Home an invitation to turn it on. Wrong codes are limited to 10 per minute and 30 per hour per account; after 5 wrong codes, the password is asked again.
Role May
Owner Everything an admin may, plus transferring ownership and deleting the partner. There is exactly one owner.
Admin Invite and remove members, change roles (never the owner's), edit the partner's details, see Activity and retire apps, plus everything a developer may.
Developer Apps (deleting included, retiring not), secrets, the store listing, webhooks, installations, calls and test organizations. Does not see Activity.
  • Any member may leave the partner, except the owner, who transfers ownership first. The new owner is an existing member; the previous owner becomes an admin.
  • Transferring ownership and deleting the partner ask for the password again.
  • An admin or the owner invites an email address, as admin or developer. The link in the email is valid for 7 days; the invitation can be resent (a new link, another 7 days) or cancelled.
  • The link opens in the portal. Without an account, you register first; with one, you sign in. Accepting requires the account's confirmed address to be the invited address; otherwise the page shows which address the invitation is for.
  • On accepting you become a member and get access to every test organization of the partner.

A test organization is where you install and try your app before publishing it, with data you create yourself.

  • Created by any member, from Test organizations: a name and the country. The organization starts with fictitious company details and an address in the chosen country, with no orders, shipments or invoices.
  • Access: every member of the partner is a member of every test organization, with the owner role. Members come from the partner's team: nobody is invited to or removed from a test organization, and whoever leaves the team loses access.
  • Open takes you to the organization in the dashboard; each of its pages shows "Test organization", with the way back to the portal.
  • Before its first publication, a public app installs only in the partner's test organizations. After publication, the version being worked on applies there (versions).
  • A private app made for a test organization installs there, through its install link, once published (private apps).
  • A test organization never becomes a real one. Any member deletes it from the portal, with everything in it; the apps installed there are disconnected.

Every test organization starts with three test integrations connected; only test integrations can be connected there.

Integration What it does
Test store (test_store) From its page, Create a test order: fictitious products, customer and address, with a locality from the organization's country. The order enters like a real store order: it goes through the import rules, starts rules and automations and sends order.created.
Test courier (test_courier) One service, "Standard", sent from the organization's address. The AWB is issued at once, with a fictitious number and a sample PDF label; cancelling works; the status moves on with time (picked up, in transit, delivered), so it sends shipment.status_changed.
Test invoicing (test_invoicing) The issuer is the organization's company; invoices are numbered in the TEST series, with a sample PDF; storno works.

Test integrations appear in GET /integrations with the codes above, only in test organizations.

  • At most 10 test organizations per partner.
  • At most 5 partners created by one person per day.
  • At most 20 invitations (sent or resent) per partner per hour.
  • At most 60 test orders per hour in each test organization.
  • At most 5 versions submitted for review per app per day.
  • Past a limit, the action is refused until the period passes.

The owner deletes the partner, with the password confirmed and the name typed again.

  • Deletion is refused while an app of the partner has a live installation in an organization that is not a test one. Installations in test organizations never block it.
  • On deletion, the partner's apps are retired (tokens revoked, installations closed) and the test organizations, invitations and members are deleted. Merchants keep their call history, with the partner's name.