Skip to main content

Step 1 — Prepare catalogues

Before creating equipment and orders, catalogues must exist. There are several independent groups.

Suggested order

Create equipment types/brands/models first, then service-order catalogues and states, then intervention types/states.

1.1 Equipment types, brands and models​

POST /gateway/equipment-type
Content-Type: application/json
Authorization: Bearer {token}
{
  "keyId": "PORT",
  "description": "Laptop"
}
POST /gateway/equipment-brand
Content-Type: application/json
Authorization: Bearer {token}
{
  "keyId": "LEN",
  "description": "Lenovo"
}
POST /gateway/equipment-model
Content-Type: application/json
Authorization: Bearer {token}
{
  "keyId": "T14",
  "description": "ThinkPad T14",
  "brandKeyId": "LEN"
}
Path keys

These three resources use alphanumeric {keyId} on GET/PUT/DELETE (e.g. GET /equipment-brand/LEN), but equipment itself uses numeric {id} (GET /equipment/123). Always check each resource reference.

1.2 Service order catalogues​

Unified endpoint — {catalogType} selects the table: 0 = Priorities, 1 = Assistance types.

POST /gateway/service-order-catalog/0
Content-Type: application/json
Authorization: Bearer {token}
{
  "keyId": "URG",
  "description": "Urgent"
}
POST /gateway/service-order-catalog/1
Content-Type: application/json
Authorization: Bearer {token}
{
  "keyId": "REP",
  "description": "Workshop repair"
}

1.3 Service order states​

POST /gateway/service-order-state
Content-Type: application/json
Authorization: Bearer {token}
{
  "keyId": "RECEB",
  "description": "Received",
  "requestReason": false,
  "closeServiceOrder": false,
  "sendSmsToCustomer": false,
  "sendEmailToCustomer": false
}

Required: keyId (≤10 chars) and description (≤50 chars).

With requestReason: true, a reason is mandatory whenever the order moves to this state (stored in the state history). This behaviour is live.

Automations not active yet

Other fields (sendSmsToCustomer, sendEmailToCustomer, sendSmstoUser, sendEmailToUser, closeServiceOrder, closePendingQuotes and related texts/layouts) are stored and returned by the API, but the associated automations (SMS/email and automatic close) are not implemented yet. Configuring them has no effect for now.

Close the order explicitly with POST /service-order/{guid}/close — see Service order — Close.

1.4 Intervention types and states​

Unified — {configType}: 0 = Types, 1 = States.

POST /gateway/intervention-config/0
Content-Type: application/json
Authorization: Bearer {token}
{
  "keyId": "DIAG",
  "description": "Diagnosis"
}
POST /gateway/intervention-config/1
Content-Type: application/json
Authorization: Bearer {token}
{
  "keyId": "CURSO",
  "description": "In progress"
}

Next​

Read SAT configuration (sat-config) before creating orders. Then optionally configure assistance contracts or continue to equipment.