Skip to main content
Records such as customers, products or invoices expect the ID of a record defined in Noyax in some fields instead of free text. For example, an address takes a DistrictId, not a district name. You get these IDs from the definition endpoints.

​
Which ID comes from where?

Country and city lists help you find a district: country → city (countryId) → district (cityId).

​
Example: finding a district for an address

1

Find the city

2

Find the district

3

Use it in the address

Put the Id of the district into the DistrictId field of the address.

​
Good to know

  • Definitions are company-specific. Lists return the records of the company sent in X-CompanyID. An ID of one company cannot be used in another company.
  • Permissions: lists under /definitions can be read with any valid API key. Creating, updating or deleting countries, cities, districts and shipment definitions requires the key to have write permission in any module. Customer definitions (/customers/groups, /customers/parameter-definitions) require the customer read permission.
  • Cache them. Definitions rarely change. Instead of querying before every record, store them on your side and refresh, for example, once a day. This saves your daily request limit.

​
Write rules

VAT rates and customer definitions are read-only through the API. Updates are full replaces; fields you do not send are cleared.