Skip to content

Import service items

POST
/imports/service-items
curl --request POST \
--url https://example.com/imports/service-items \
--header 'Content-Type: application/json' \
--cookie __Host-bottle.session_token=<__Host-bottle.session_token> \
--data '{ "fileName": "example", "rows": [ { "accountNumber": "example", "customer": "example", "postcode": "example", "site": "example", "type": "example", "quantity": "example", "serial": "example", "product": "example", "installedOn": "example", "plan": "example", "nextDue": "example", "lastService": "example", "notes": "example", "details": { "additionalProperty": "example" } } ], "skip": [ 1 ], "firstRow": 1, "mapping": { "additionalProperty": "example" }, "types": { "additionalProperty": { "kind": "existing", "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f" } }, "plans": { "additionalProperty": { "kind": "existing", "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f" } } }'

Adds the items on every row that checks clean, with their due dates, in one go, and keeps a record so the import can be undone. Adds the new item types and plans chosen, and adds item types to an existing plan that did not cover them. Refused with 422 while any row has a problem or an item type or plan to choose.

Media typeapplication/json
object
fileName
required
string
>= 1 characters <= 200 characters
rows
required
Array<object>
>= 1 items <= 5000 items
object
accountNumber
string
<= 500 characters
customer
string
<= 500 characters
postcode
string
<= 500 characters
site
string
<= 500 characters
type
string
<= 500 characters
quantity
string
<= 500 characters
serial
string
<= 500 characters
product
string
<= 500 characters
installedOn
string
<= 500 characters
plan
string
<= 500 characters
nextDue
string
<= 500 characters
lastService
string
<= 500 characters
notes
string
<= 2000 characters
details
object
key
additional properties
string
<= 500 characters
skip
Array<integer>
<= 5000 items
firstRow
integer
>= 1
mapping
object
key
additional properties
string
<= 80 characters
types
object
key
additional properties
One of:
object
kind
required
string
Allowed values: existing
id
required

UUID v7

string format: uuid

Example

019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f
plans
object
key
additional properties
One of:
object
kind
required
string
Allowed values: existing
id
required

UUID v7

string format: uuid

Example

019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

Imported

Media typeapplication/json
object
id
required

UUID v7

string format: uuid
kind
required
string
Allowed values: customers cylinders service_items
fileName
required
string
created
required
integer
updated
required
integer
skipped
required
integer
byName
required
string | null
createdAt
required
string format: date-time
undoneAt
required
string | null format: date-time

Example

{
"id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
"kind": "customers"
}

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string

Example

{
"error": "not_found",
"message": "Customer not found"
}

Not an owner or admin, or the plan does not open Equipment servicing

Media typeapplication/json
object
error
required
string
message
required
string

Example

{
"error": "not_found",
"message": "Customer not found"
}

Not found, or Equipment servicing is not available to this business

Media typeapplication/json
object
error
required
string
message
required
string

Example

{
"error": "not_found",
"message": "Customer not found"
}

Equipment servicing is switched off, or the import was already undone

Media typeapplication/json
object
error
required
string
message
required
string

Example

{
"error": "not_found",
"message": "Customer not found"
}

Validation failed, rows still have problems, or an item type or plan still needs choosing

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string

Example

{
"error": "validation",
"issues": [
{
"path": "email",
"message": "Invalid email"
}
]
}