Skip to content

Add a supplier

POST
/stock/suppliers
curl --request POST \
--url https://example.com/stock/suppliers \
--header 'Content-Type: application/json' \
--cookie __Host-bottle.session_token=<__Host-bottle.session_token> \
--data '{ "name": "example", "address": "example", "addressLine1": "example", "addressLine2": "example", "town": "example", "postcode": "example", "accountNumber": "example", "note": "example", "howToOrder": "example" }'
Media typeapplication/json
object
name
required
string
>= 1 characters <= 120 characters
address
string | null
<= 500 characters
addressLine1
string | null
<= 200 characters
addressLine2
string | null
<= 200 characters
town
string | null
<= 100 characters
postcode
string | null
<= 12 characters
accountNumber
string | null
<= 120 characters
note
string | null
<= 2000 characters
howToOrder
string | null
<= 2000 characters

Example generated

{
"name": "example",
"address": "example",
"addressLine1": "example",
"addressLine2": "example",
"town": "example",
"postcode": "example",
"accountNumber": "example",
"note": "example",
"howToOrder": "example"
}

The supplier, with its contacts

Media typeapplication/json
object
id
required

UUID v7

string format: uuid
name
required
string
address
required
string | null
addressLine1
required
string | null
addressLine2
required
string | null
town
required
string | null
postcode
required
string | null
accountNumber
required
string | null
note
required
string | null
howToOrder
required
string | null
archivedAt
required
string | null format: date-time
yardIds
required
Array<string>
productIds
required
Array<string>
costs
required
Array<object>

What a supplier charges the business for one product. Kept on the supplier only; not shown on the product.

object
productId
required

UUID v7

string format: uuid
unitCostPence
required
integer | null
<= 100000000
breaks
required
Array<object>
<= 10 items

A cheaper cost from a quantity, before VAT (“10 or more at £22.00 each”).

object
fromQuantity
required
integer
>= 2 <= 100000
unitCostPence
required
integer
<= 100000000
contacts
required
Array<object>
object
id
required

UUID v7

string format: uuid
name
required
string
jobTitle
required
string | null
phone
required
string | null
email
required
string | null
note
required
string | null
isMain
required
boolean
isBilling
required
boolean
forOrders
required
boolean
forDeliveries
required
boolean
openOrders
required
integer
lastOrderedAt
required
string | null format: date-time

Example

{
"id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
"yardIds": [
"019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
],
"productIds": [
"019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
],
"costs": [
{
"productId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
}
],
"contacts": [
{
"id": "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 a member, or without the permission this needs

Media typeapplication/json
object
error
required
string
message
required
string

Example

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

No such supplier or contact in this business

Media typeapplication/json
object
error
required
string
message
required
string

Example

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

Validation failed

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