organisation

Mock

Mock. This operation is part of the approved contract but its module is not built yet. Run Core with N1_API_MODE=mock N1_DEV_AUTH=stub to get deterministic demo-shop data from it. The real server answers NOT_IMPLEMENTED until it ships; the schema and examples here will not change when it does.

The shop profile and settings

Compare

The shop profile and settings.

POST/graphqlapp audience

Who can call this. Any signed-in shop user. You can run it against Local or Staging from the request panel, with a demo-shop token.

Headers

Required Optional

AuthorizationstringRequired
Bearer <token>, issued for this endpoint's audience. The token decides the shop and roles; nothing in the request body can change them.
Example: Bearer eyJhbGciOiJFZERTQSJ9…
Content-TypestringRequired
Always application/json. Only POST is accepted.
Example: application/json
X-Request-IdstringOptional
Your id for this request (8–128 characters of A–Z a–z 0–9 . _ : -). Echoed back in the response header and in every error, so you can quote it when reporting a problem. Core makes one if you send none.
Example: app-7f3c2a9e-checkout

Arguments

This operation takes no arguments.

Returns

Required Optional

organisationOrganisation!Required
The shop profile and settings.
Show children
- addressAddress!Required
  Registered address.
  Example: {"line1":"Plot 12, Demo Industrial Estate","city":"Coimbatore","state":"Tamil Nadu","pincode":"641001"}
  Show children
  - cityString!Required
    City or town.
    Example: "Coimbatore"
  - line1String!Required
    Building, street.
    Example: "Plot 12, Demo Industrial Estate"
  - line2StringOptional
    Area, landmark.
  - pincodeString!Required
    6-digit PIN code.
    Example: "641001"
  - stateString!Required
    State name.
    Example: "Tamil Nadu"
- fyStartMonthInt!Required
  Month the financial year starts, 1–12 (4 = April).
  Example: 4
- gstinStringOptional
  GSTIN, if registered.
  Example: "33DEMOA0001A1Z5"
- idID!Required
  The shop id (the tenant).
  Example: "0192f0c1-0000-7000-8000-00000000000a"
- invoicePrefixString!Required
  Prefix of invoice numbers.
  Example: "DPW"
- nameString!Required
  Trade name.
  Example: "Demo Precision Works"
- stateCodeString!Required
  GST state code (2 digits); decides CGST+SGST or IGST.
  Example: "33"
- timezoneString!Required
  IANA timezone people read times in.
  Example: "Asia/Kolkata"

Errors

This operation has no documented error responses.

Every error has the same body. See Errors.

Rate limit tier

Tier: per user. Over the limit you get RATE_LIMITED (HTTP 429) with a Retry-After header. See Response handling.