Orders

The basket, placing orders and following them.

GET/basketThe basket
GET/basket/conditionsConditions to accept
POST/basket/itemsAdd to the basket
DELETE/basket/items/{item_id}Remove from the basket
POST/basket/placePlace the order
GET/ordersList orders
GET/orders/{order_id}An order

The basket

GET/basket

Needs the permission ticket:manage

What is in it, with prices.

Response 200

`id`required	string (uuid) \| null
`number`required	string \| null
`placed_at`required	string (date-time) \| null
`placed_by`	string \| null
`note`required	string
`items`required	object[]
`id`required	string (uuid)
`kind`required	string
`label`required	string
`months`required	integer \| null
`amount`required	number \| null
`currency`required	string \| null
`tax_rate`	number \| null
`details`required	map of string
`fields`required	object[]
`key`required	string
`required`required	boolean
`type`required	string
`max_length`required	integer
`totals`required	object[]
`months`required	integer
`amount`required	number
`currency`required	string
`tax`	number \| null
`total`	number \| null
`tax_rates`	number[]	default []
`ticket_id`	string \| null
`status`	string \| null
`closed`	boolean	default false

curl "https://portal.nimag.net/api/v1/basket" \
  -H "Authorization: Bearer nck_…"

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "number": "string",
  "placed_at": "2026-01-31T12:00:00Z",
  "placed_by": "string",
  "note": "string",
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "kind": "string",
      "label": "string",
      "months": 0,
      "amount": 0,
      "currency": "string",
      "tax_rate": 0,
      "details": {},
      "fields": [
        {
          "key": "string",
          "required": true,
          "type": "string",
          "max_length": 0
        }
      ]
    }
  ],
  "totals": [
    {
      "months": 0,
      "amount": 0,
      "currency": "string",
      "tax": 0,
      "total": 0,
      "tax_rates": []
    }
  ],
  "ticket_id": "string",
  "status": "string",
  "closed": false
}

Conditions to accept

GET/basket/conditions

Needs the permission ticket:manage

What must be accepted to place an order, and where to read it.

Response 200: Successful Response.

curl "https://portal.nimag.net/api/v1/basket/conditions" \
  -H "Authorization: Bearer nck_…"

{}

Add to the basket

POST/basket/items

Needs the permission ticket:manage

Body (JSON)

`kind`required	string	up to 32 characters
`plan`	string	up to 120 characters, default ""
`months`	integer \| null	from 1, up to 120
`domain`	string	up to 253 characters, default ""

Response 201

`id`required	string (uuid) \| null
`number`required	string \| null
`placed_at`required	string (date-time) \| null
`placed_by`	string \| null
`note`required	string
`items`required	object[]
`id`required	string (uuid)
`kind`required	string
`label`required	string
`months`required	integer \| null
`amount`required	number \| null
`currency`required	string \| null
`tax_rate`	number \| null
`details`required	map of string
`fields`required	object[]
`key`required	string
`required`required	boolean
`type`required	string
`max_length`required	integer
`totals`required	object[]
`months`required	integer
`amount`required	number
`currency`required	string
`tax`	number \| null
`total`	number \| null
`tax_rates`	number[]	default []
`ticket_id`	string \| null
`status`	string \| null
`closed`	boolean	default false

curl -X POST "https://portal.nimag.net/api/v1/basket/items" \
  -H "Authorization: Bearer nck_…" \
  -H "Content-Type: application/json" \
  -d '{
    "kind": "string",
    "plan": "",
    "months": 0,
    "domain": ""
  }'

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "number": "string",
  "placed_at": "2026-01-31T12:00:00Z",
  "placed_by": "string",
  "note": "string",
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "kind": "string",
      "label": "string",
      "months": 0,
      "amount": 0,
      "currency": "string",
      "tax_rate": 0,
      "details": {},
      "fields": [
        {
          "key": "string",
          "required": true,
          "type": "string",
          "max_length": 0
        }
      ]
    }
  ],
  "totals": [
    {
      "months": 0,
      "amount": 0,
      "currency": "string",
      "tax": 0,
      "total": 0,
      "tax_rates": []
    }
  ],
  "ticket_id": "string",
  "status": "string",
  "closed": false
}

Remove from the basket

DELETE/basket/items/{item_id}

Needs the permission ticket:manage

Path

item_idrequired string (uuid)

Response 204: no content.

curl -X DELETE "https://portal.nimag.net/api/v1/basket/items/{item_id}" \
  -H "Authorization: Bearer nck_…"

Place the order

POST/basket/place

Needs the permission ticket:manage

Orders what is in the basket. The order is binding: Nimag invoices it.

Body (JSON)

`note`	string	up to 4000 characters, default ""
`details`	map of map of string	default {}
`accept`	boolean	default false

Response 201

`id`required	string (uuid) \| null
`number`required	string \| null
`placed_at`required	string (date-time) \| null
`placed_by`	string \| null
`note`required	string
`items`required	object[]
`id`required	string (uuid)
`kind`required	string
`label`required	string
`months`required	integer \| null
`amount`required	number \| null
`currency`required	string \| null
`tax_rate`	number \| null
`details`required	map of string
`fields`required	object[]
`key`required	string
`required`required	boolean
`type`required	string
`max_length`required	integer
`totals`required	object[]
`months`required	integer
`amount`required	number
`currency`required	string
`tax`	number \| null
`total`	number \| null
`tax_rates`	number[]	default []
`ticket_id`	string \| null
`status`	string \| null
`closed`	boolean	default false

curl -X POST "https://portal.nimag.net/api/v1/basket/place" \
  -H "Authorization: Bearer nck_…" \
  -H "Content-Type: application/json" \
  -d '{
    "note": "",
    "details": {},
    "accept": false
  }'

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "number": "string",
  "placed_at": "2026-01-31T12:00:00Z",
  "placed_by": "string",
  "note": "string",
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "kind": "string",
      "label": "string",
      "months": 0,
      "amount": 0,
      "currency": "string",
      "tax_rate": 0,
      "details": {},
      "fields": [
        {
          "key": "string",
          "required": true,
          "type": "string",
          "max_length": 0
        }
      ]
    }
  ],
  "totals": [
    {
      "months": 0,
      "amount": 0,
      "currency": "string",
      "tax": 0,
      "total": 0,
      "tax_rates": []
    }
  ],
  "ticket_id": "string",
  "status": "string",
  "closed": false
}

List orders

GET/orders

Needs the permission ticket:read

Placed orders, newest first.

Response 200

`id`required	string (uuid) \| null
`number`required	string \| null
`placed_at`required	string (date-time) \| null
`placed_by`	string \| null
`note`required	string
`items`required	object[]
`id`required	string (uuid)
`kind`required	string
`label`required	string
`months`required	integer \| null
`amount`required	number \| null
`currency`required	string \| null
`tax_rate`	number \| null
`details`required	map of string
`fields`required	object[]
`key`required	string
`required`required	boolean
`type`required	string
`max_length`required	integer
`totals`required	object[]
`months`required	integer
`amount`required	number
`currency`required	string
`tax`	number \| null
`total`	number \| null
`tax_rates`	number[]	default []
`ticket_id`	string \| null
`status`	string \| null
`closed`	boolean	default false

curl "https://portal.nimag.net/api/v1/orders" \
  -H "Authorization: Bearer nck_…"

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "number": "string",
    "placed_at": "2026-01-31T12:00:00Z",
    "placed_by": "string",
    "note": "string",
    "items": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "kind": "string",
        "label": "string",
        "months": 0,
        "amount": 0,
        "currency": "string",
        "tax_rate": 0,
        "details": {},
        "fields": [
          {
            "key": null,
            "required": null,
            "type": null,
            "max_length": null
          }
        ]
      }
    ],
    "totals": [
      {
        "months": 0,
        "amount": 0,
        "currency": "string",
        "tax": 0,
        "total": 0,
        "tax_rates": []
      }
    ],
    "ticket_id": "string",
    "status": "string",
    "closed": false
  }
]

An order

GET/orders/{order_id}

Needs the permission ticket:read

Path

order_idrequired string (uuid)

Response 200

`id`required	string (uuid) \| null
`number`required	string \| null
`placed_at`required	string (date-time) \| null
`placed_by`	string \| null
`note`required	string
`items`required	object[]
`id`required	string (uuid)
`kind`required	string
`label`required	string
`months`required	integer \| null
`amount`required	number \| null
`currency`required	string \| null
`tax_rate`	number \| null
`details`required	map of string
`fields`required	object[]
`key`required	string
`required`required	boolean
`type`required	string
`max_length`required	integer
`totals`required	object[]
`months`required	integer
`amount`required	number
`currency`required	string
`tax`	number \| null
`total`	number \| null
`tax_rates`	number[]	default []
`ticket_id`	string \| null
`status`	string \| null
`closed`	boolean	default false

curl "https://portal.nimag.net/api/v1/orders/{order_id}" \
  -H "Authorization: Bearer nck_…"

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "number": "string",
  "placed_at": "2026-01-31T12:00:00Z",
  "placed_by": "string",
  "note": "string",
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "kind": "string",
      "label": "string",
      "months": 0,
      "amount": 0,
      "currency": "string",
      "tax_rate": 0,
      "details": {},
      "fields": [
        {
          "key": "string",
          "required": true,
          "type": "string",
          "max_length": 0
        }
      ]
    }
  ],
  "totals": [
    {
      "months": 0,
      "amount": 0,
      "currency": "string",
      "tax": 0,
      "total": 0,
      "tax_rates": []
    }
  ],
  "ticket_id": "string",
  "status": "string",
  "closed": false
}