Skip to content
Select language:English

/api/v1/accounts/{accountId}/vendors (POST)

POST
/api/v1/accounts/{accountId}/vendors
curl --request POST \
--url https://example.com/api/v1/accounts/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/vendors \
--header 'Content-Type: application/json' \
--data '{ "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "name": "example", "kind": "store", "address": "example", "phone": "example", "website": "example" }'
accountId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
Media typeapplication/json
object
id
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
name
required
string
>= 1 characters <= 120 characters
kind
string
Allowed values: store online service_centre station other
address
Any of:
string
<= 500 characters
phone
Any of:
string
<= 40 characters
website
Any of:
string
<= 2000 characters

Default Response

Media typeapplication/json
object
item
required
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
rowVersion
required
integer
>= -9007199254740991 <= 9007199254740991
ownerAccountId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
name
required
string
kind
required
string
Allowed values: store online service_centre station other
address
required
string | null
phone
required
string | null
website
required
string | null
possibleDuplicates
required
Array<object>
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
name
required
string
similarity
required
number
Example
{
"item": {
"kind": "store"
}
}