POST Api/v{apiVersion}/Suppliers
Creates a new supplier
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| apiVersion | string |
None. |
Body Parameters
SupplierValues| Name | Description | Type | Additional information |
|---|---|---|---|
| ParentID | globally unique identifier |
None. |
|
| Name | string |
None. |
|
| Status | SupplierStatus |
None. |
|
| IsBackendSupplier | boolean |
None. |
|
| Contact | string |
None. |
|
| PhoneNumber | string |
None. |
|
| AdSpecificationsHtml | string |
None. |
|
| Notes | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"ParentID": "251a99dc-0e1e-42b7-afaa-30e56214541a",
"Name": "sample string 1",
"Status": "InActive",
"IsBackendSupplier": true,
"Contact": "sample string 3",
"PhoneNumber": "sample string 4",
"AdSpecificationsHtml": "sample string 5",
"Notes": "sample string 6"
}
application/xml, text/xml
Sample:
<SupplierValues xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Hier.Api.ViewModels"> <AdSpecificationsHtml>sample string 5</AdSpecificationsHtml> <Contact>sample string 3</Contact> <IsBackendSupplier>true</IsBackendSupplier> <Name>sample string 1</Name> <Notes>sample string 6</Notes> <ParentID>251a99dc-0e1e-42b7-afaa-30e56214541a</ParentID> <PhoneNumber>sample string 4</PhoneNumber> <Status>InActive</Status> </SupplierValues>
application/x-www-form-urlencoded
Sample:
Sample not available.
multipart/form-data
Sample:
--MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="ParentID" 251a99dc-0e1e-42b7-afaa-30e56214541a --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Name" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Status" InActive --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="IsBackendSupplier" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Contact" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="PhoneNumber" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="AdSpecificationsHtml" sample string 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Notes" sample string 6 --MultipartDataMediaFormatterBoundary1q2w3e--
Response Information
Resource Description
SupplierDetails| Name | Description | Type | Additional information |
|---|---|---|---|
| SupplierID | globally unique identifier |
None. |
|
| Parent | SupplierPreview |
None. |
|
| Operator | OperatorPreview |
None. |
|
| Name | string |
None. |
|
| Status | SupplierStatus |
None. |
|
| IsBackendSupplier | boolean |
None. |
|
| Contact | string |
None. |
|
| PhoneNumber | string |
None. |
|
| Logo | FilePreview |
None. |
|
| AdSpecificationsHtml | string |
None. |
|
| Notes | string |
None. |
|
| CreatedAt | date |
None. |
|
| CreatedBy | string |
None. |
|
| ModifiedAt | date |
None. |
|
| ModifiedBy | string |
None. |
Response Formats
application/json
Sample:
{
"SupplierID": "9afaebcc-217e-47e0-91ed-874f34ce292b",
"Parent": {
"SupplierID": "10ccb6a3-a596-43e6-ad63-34407fa1bce1",
"ParentName": "sample string 2",
"Name": "sample string 3",
"Status": "InActive",
"IsBackendSupplier": true,
"Contact": "sample string 5",
"PhoneNumber": "sample string 6"
},
"Operator": {
"OperatorID": "d01a5351-2123-4197-be35-352eca56080a",
"ParentName": "sample string 2",
"Name": "sample string 3",
"Status": "InActive",
"Address": "sample string 4",
"Postcode": "sample string 5",
"City": {
"AreaID": "7924046e-ebad-4644-ba44-92f48e199065",
"ParentID": "5751da8c-8891-4ccb-b770-1628c8b67a25",
"ParentName": "sample string 2",
"SupplierName": "sample string 3",
"CustomerName": "sample string 4",
"StoreName": "sample string 5",
"Code": "sample string 6",
"Name": "sample string 7",
"Type": "Neighbourhood",
"Status": "InActive",
"OwnerName": "sample string 8",
"Population": 9,
"Mailboxes": 10
},
"PhoneNumber": "sample string 6",
"EmailAddress": "sample string 7"
},
"Name": "sample string 2",
"Status": "InActive",
"IsBackendSupplier": true,
"Contact": "sample string 4",
"PhoneNumber": "sample string 5",
"Logo": {
"FileID": "936aea53-a6b3-439d-9e36-3ee857d72b47",
"LinkedEntityID": "1999c145-7fda-4547-be9a-feb2d0612d9a",
"LinkedPropertyName": "sample string 3",
"FileName": "sample string 4",
"ContentType": "application/",
"BlobUrl": "https://hier.ralphkamphuis.nl/api/v1/files/936aea53-a6b3-439d-9e36-3ee857d72b47/blob?ff8d23a3-2f59-40be-9e76-bab0970c1d42"
},
"AdSpecificationsHtml": "sample string 6",
"Notes": "sample string 7",
"CreatedAt": "2026-04-02T12:41:00.9186804Z",
"CreatedBy": "sample string 9",
"ModifiedAt": "2026-04-02T12:41:00.9186804Z",
"ModifiedBy": "sample string 11"
}
text/json
Sample:
{
"SupplierID": "9afaebcc-217e-47e0-91ed-874f34ce292b",
"Parent": {
"SupplierID": "10ccb6a3-a596-43e6-ad63-34407fa1bce1",
"ParentName": "sample string 2",
"Name": "sample string 3",
"Status": "InActive",
"IsBackendSupplier": true,
"Contact": "sample string 5",
"PhoneNumber": "sample string 6"
},
"Operator": {
"OperatorID": "d01a5351-2123-4197-be35-352eca56080a",
"ParentName": "sample string 2",
"Name": "sample string 3",
"Status": "InActive",
"Address": "sample string 4",
"Postcode": "sample string 5",
"City": {
"AreaID": "7924046e-ebad-4644-ba44-92f48e199065",
"ParentID": "5751da8c-8891-4ccb-b770-1628c8b67a25",
"ParentName": "sample string 2",
"SupplierName": "sample string 3",
"CustomerName": "sample string 4",
"StoreName": "sample string 5",
"Code": "sample string 6",
"Name": "sample string 7",
"Type": "Neighbourhood",
"Status": "InActive",
"OwnerName": "sample string 8",
"Population": 9,
"Mailboxes": 10
},
"PhoneNumber": "sample string 6",
"EmailAddress": "sample string 7"
},
"Name": "sample string 2",
"Status": "InActive",
"IsBackendSupplier": true,
"Contact": "sample string 4",
"PhoneNumber": "sample string 5",
"Logo": {
"FileID": "936aea53-a6b3-439d-9e36-3ee857d72b47",
"LinkedEntityID": "1999c145-7fda-4547-be9a-feb2d0612d9a",
"LinkedPropertyName": "sample string 3",
"FileName": "sample string 4",
"ContentType": "application/",
"BlobUrl": "https://hier.ralphkamphuis.nl/api/v1/files/936aea53-a6b3-439d-9e36-3ee857d72b47/blob?2d8dc0e1-542d-4c4b-a62f-aff86dcb0d6a"
},
"AdSpecificationsHtml": "sample string 6",
"Notes": "sample string 7",
"CreatedAt": "2026-04-02T12:41:00.9186804Z",
"CreatedBy": "sample string 9",
"ModifiedAt": "2026-04-02T12:41:00.9186804Z",
"ModifiedBy": "sample string 11"
}
application/xml, text/xml
Sample:
<SupplierDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Hier.Api.ViewModels">
<AdSpecificationsHtml>sample string 6</AdSpecificationsHtml>
<Contact>sample string 4</Contact>
<CreatedAt>2026-04-02T14:41:00.9186804+02:00</CreatedAt>
<CreatedBy>sample string 9</CreatedBy>
<IsBackendSupplier>true</IsBackendSupplier>
<Logo>
<FileID>936aea53-a6b3-439d-9e36-3ee857d72b47</FileID>
<FileName>sample string 4</FileName>
<LinkedEntityID>1999c145-7fda-4547-be9a-feb2d0612d9a</LinkedEntityID>
<LinkedPropertyName>sample string 3</LinkedPropertyName>
</Logo>
<ModifiedAt>2026-04-02T14:41:00.9186804+02:00</ModifiedAt>
<ModifiedBy>sample string 11</ModifiedBy>
<Name>sample string 2</Name>
<Notes>sample string 7</Notes>
<Operator>
<Address>sample string 4</Address>
<City>
<AreaID>7924046e-ebad-4644-ba44-92f48e199065</AreaID>
<Code>sample string 6</Code>
<CustomerName>sample string 4</CustomerName>
<Mailboxes>10</Mailboxes>
<Name>sample string 7</Name>
<OwnerName>sample string 8</OwnerName>
<ParentID>5751da8c-8891-4ccb-b770-1628c8b67a25</ParentID>
<ParentName>sample string 2</ParentName>
<Population>9</Population>
<Status>InActive</Status>
<StoreName>sample string 5</StoreName>
<SupplierName>sample string 3</SupplierName>
<Type>Neighbourhood</Type>
</City>
<EmailAddress>sample string 7</EmailAddress>
<Name>sample string 3</Name>
<OperatorID>d01a5351-2123-4197-be35-352eca56080a</OperatorID>
<ParentName>sample string 2</ParentName>
<PhoneNumber>sample string 6</PhoneNumber>
<Postcode>sample string 5</Postcode>
<Status>InActive</Status>
</Operator>
<Parent>
<Contact>sample string 5</Contact>
<IsBackendSupplier>true</IsBackendSupplier>
<Name>sample string 3</Name>
<ParentName>sample string 2</ParentName>
<PhoneNumber>sample string 6</PhoneNumber>
<Status>InActive</Status>
<SupplierID>10ccb6a3-a596-43e6-ad63-34407fa1bce1</SupplierID>
</Parent>
<PhoneNumber>sample string 5</PhoneNumber>
<Status>InActive</Status>
<SupplierID>9afaebcc-217e-47e0-91ed-874f34ce292b</SupplierID>
</SupplierDetails>
multipart/form-data
Sample:
--MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="SupplierID" 9afaebcc-217e-47e0-91ed-874f34ce292b --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Parent.SupplierID" 10ccb6a3-a596-43e6-ad63-34407fa1bce1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Parent.ParentName" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Parent.Name" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Parent.Status" InActive --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Parent.IsBackendSupplier" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Parent.Contact" sample string 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Parent.PhoneNumber" sample string 6 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Operator.OperatorID" d01a5351-2123-4197-be35-352eca56080a --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Operator.ParentName" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Operator.Name" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Operator.Status" InActive --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Operator.Address" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Operator.Postcode" sample string 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Operator.City.AreaID" 7924046e-ebad-4644-ba44-92f48e199065 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Operator.City.ParentID" 5751da8c-8891-4ccb-b770-1628c8b67a25 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Operator.City.ParentName" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Operator.City.SupplierName" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Operator.City.CustomerName" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Operator.City.StoreName" sample string 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Operator.City.Code" sample string 6 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Operator.City.Name" sample string 7 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Operator.City.Type" Neighbourhood --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Operator.City.Status" InActive --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Operator.City.OwnerName" sample string 8 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Operator.City.Population" 9 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Operator.City.Mailboxes" 10 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Operator.PhoneNumber" sample string 6 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Operator.EmailAddress" sample string 7 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Name" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Status" InActive --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="IsBackendSupplier" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Contact" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="PhoneNumber" sample string 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Logo.FileID" 936aea53-a6b3-439d-9e36-3ee857d72b47 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Logo.LinkedEntityID" 1999c145-7fda-4547-be9a-feb2d0612d9a --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Logo.LinkedPropertyName" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Logo.FileName" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Logo.ContentType" application/ --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Logo.BlobUrl" https://hier.ralphkamphuis.nl/api/v1/files/936aea53-a6b3-439d-9e36-3ee857d72b47/blob?ef4af8c3-7d19-48f1-9f11-eeea382c363e --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="AdSpecificationsHtml" sample string 6 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Notes" sample string 7 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="CreatedAt" 2026-04-02T14:41:00.9186804+02:00 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="CreatedBy" sample string 9 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="ModifiedAt" 2026-04-02T14:41:00.9186804+02:00 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="ModifiedBy" sample string 11 --MultipartDataMediaFormatterBoundary1q2w3e--