Skip to content

Check service items before importing them

POST
/imports/service-items/check
curl --request POST \
--url https://example.com/imports/service-items/check \
--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" } } }'

Says what importing each row would do: add its items, skip them as already in Bottle, or a problem with the fix. Lists every item type and plan the file names, with the one each matched by name. Nothing is saved.

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

What each row would do

Media typeapplication/json
object
rows
required
Array<object>
object
row
required
integer
action
required
string
Allowed values: create same problem waiting skip
label
required
string | null
problems
required
Array<string>
items
required
Array<object>
object
type
required
string
count
required
integer
existing
required
integer
plan
required
string
nextDueOn
required
string | null
duplicateOf
required
integer | null
counts
required
object
create
required
integer
same
required
integer
problem
required
integer
skip
required
integer
waiting
required
integer
items
required
integer
types
required
Array<object>
object
text
required
string
rows
required
integer
typeId
required

UUID v7

string | null format: uuid
plans
required
Array<object>
object
text
required
string
rows
required
integer
planId
required

UUID v7

string | null format: uuid
monthly
required
boolean

Example

{
"rows": [
{
"action": "create"
}
],
"types": [
{
"typeId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
}
],
"plans": [
{
"planId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
}
]
}

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"
}
]
}