Skip to main content

Postman collection

A ready-to-run Postman collection covering every Partner API and Supplier Access endpoint. Generated from the same OpenAPI specification that powers the API reference, so it stays in step with the live API.

nuntiq-supplier-api.postman_collection.json

12 requests · Partner API + Supplier Access · Collection format v2.1

Download collection

nuntiq-supplier-api.postman_environment.json

Optional · keeps your key out of the collection file

Download environment

Setup​

  1. In Postman, Import → drop in the collection file (and the environment file, if you want one).
  2. Open the collection's Variables tab (or the environment) and set:
VariableSet it to
baseUrlDefaults to the development host. See Environments to switch to test or production.
apiKeyYour partner API key.
rotationSecretOnly needed for the self-rotate request. See Key rotation.
  1. Send any request. That's the whole setup.

How auth is wired​

apiKey is set once as collection-level authorization and inherited by every Partner API request, so there is no per-request header to fill in.

The Supplier Access folder is set to No auth on purpose. Those endpoints back the public key-claim and email-preference flow and are reached before a supplier has a key, so sending one would be meaningless.

The self-rotate request carries an extra X-Rotation-Secret header bound to the rotationSecret variable, since that endpoint needs both credentials.

Notes​

  • The default host is development. A fresh import cannot accidentally post live invoices at production. Change baseUrl deliberately.
  • Request bodies are generated from the schema, so every field appears with a placeholder like <string> or <date>. Delete the ones you do not send — every field except invoice is optional. See Submitting invoices for what each one means.
  • Submit e-invoice file is a multipart/form-data request. The files field is a file picker: attach your XML / EDI / CSV / JSON document, plus any supporting PDF.
  • Optional query parameters ship unticked, so you can see what exists without sending it. Required ones are left ticked and need a value.
  • Customer-credential endpoints are not in this collection. They use a different key type and live in the Customer API collection.