N1Developer docsv1

Orders · v1

QUERY

order

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.

One order by id, with its lines

One order by id. Owner, admin, supervisor and accountant. ORDER_NOT_FOUND if the id is not in this shop.

POST/graphqlapp audience

Who can call this. Owner, admin, accountant, supervisor.

Headers

  • 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

  • idID!Required

    The order id.

    Example: "0192f0c1-0000-7000-8000-000000d00001"

Returns

  • orderOrder!Required

    One order by id. Owner, admin, supervisor and accountant. ORDER_NOT_FOUND if the id is not in this shop.

    Show children
    • createdAtString!Required

      UTC time the order was entered.

      Example: "2026-09-03T04:30:00.000Z"

    • customerIdID!Required

      The customer (see customer).

      Example: "0192f0c1-0000-7000-8000-0000000c0001"

    • customerNameString!Required

      The customer’s name, so a list needs no second call.

      Example: "Alpha Auto Components 1"

    • dueDateString!Required

      Promised delivery date, YYYY-MM-DD in the shop’s timezone.

      Example: "2026-09-30"

    • idID!Required

      Stable id (UUIDv7).

      Example: "0192f0c1-0000-7000-8000-000000d00001"

    • lines[OrderLine!]!Required

      The parts ordered, in line order.

      Example: [{"id":"0192f0c1-0000-7000-8000-000000d1000b","lineNo":1,"part":"Bush 25x30","drawingRef":"DRG-1A","quantity":40,"material":"Brass","jobCardId":"0192f0c1-0000-7000-8000-000000d2000b"},{"id":"0192f0c1-0000-7000-8000-000000d1000c","lineNo":2,"part":"Pulley 90","drawingRef":"DRG-1B","quantity":60,"material":"EN8","jobCardId":"0192f0c1-0000-7000-8000-000000d2000c"}]

      Show children
      • drawingRefStringOptional

        The customer’s drawing reference. The drawing file itself comes with N1C-049.

        Example: "DRG-1A"

      • idID!Required

        Stable id (UUIDv7).

        Example: "0192f0c1-0000-7000-8000-000000d1000b"

      • jobCardIdIDOptional

        The job card made for this line (open it with jobCard).

        Example: "0192f0c1-0000-7000-8000-000000d2000b"

      • lineNoInt!Required

        Position on the order, from 1.

        Example: 1

      • materialStringOptional

        Material to use.

        Example: "Brass"

      • partString!Required

        Part name or number.

        Example: "Bush 25x30"

      • quantityInt!Required

        Pieces ordered.

        Example: 40

    • poNumberString!Required

      The customer’s PO number.

      Example: "PO-2026-0001"

    • priorityOrderPriority!Required

      How urgently to take it.

      Example: "HIGH"

      • HIGHAhead of normal orders.
      • LOWFill gaps in the schedule.
      • NORMALThe default.
      • URGENTDrop other work for it.
    • quoteIdIDOptional

      The quote this order was converted from, if any (see quote).

    • statusOrderStatus!Required

      Worked out from the job cards.

      Example: "IN_PRODUCTION"

      • COMPLETEDEvery job card is done.
      • IN_PRODUCTIONAt least one job card has started and not every one is done.
      • OPENAccepted; no job card has started.
    • updatedAtString!Required

      UTC time of the last change.

      Example: "2026-09-03T04:30:00.000Z"

Errors

CodeHTTPWhen
ORDER_NOT_FOUND404The id is unknown in this shop (another shop's ids answer the same).
FORBIDDEN403Signed in, but the role or tenant does not allow the action.

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.

Search documentation

Search operations, types and errors from the generated contract.