POST v1/Suppliers

Add a new Supplier.

Request Information

Requires Authorization!

URI Parameters

None.

Body Parameters

The Supplier changes object

SupplierChanges
NameDescriptionTypeAdditional information
MainAddress

Gets or sets the main address.

ContactInfo

None.

Warehouses

Collection of WarehouseBasicInfo

None.

ShopOwnerId

Gets or sets the shop owner identifier.

integer

Required

PersonTitle

Gets or sets the person title.

string

Max length: 50

FirstName

Gets or sets the first name.

string

Max length: 50

MiddleName

Gets or sets the middle name.

string

Max length: 50

LastNamePrefix

Gets or sets the last name prefix.

string

Max length: 50

LastName

Gets or sets the last name.

string

Max length: 50

CultureId

Gets or sets the culture identifier.

integer

None.

PersonalNumber

Gets or sets the personal number.

string

Max length: 20

ChangedTimestamp

Gets or sets the changed timestamp.

date

None.

Id

Gets or sets the identifier.

integer

Must be 0

FullName

Gets or sets the full name.

string

Max length: 100

CompanyName

Gets or sets the name of the company.

string

Max length: 100

EMail

Gets or sets the e mail.

string

Max length: 200

ContactReference

Gets or sets the contact reference.

string

None.

Request Formats

application/json, text/json

Sample:
{
  "MainAddress": {
    "VatNumber": "sample string 1",
    "FullName": "sample string 2",
    "DateOfBirth": "2021-12-02T20:19:39.3884834+01:00",
    "Gender": "sample string 3",
    "PersonTitle": "sample string 4",
    "MiddleName": "sample string 5",
    "FirstName": "sample string 6",
    "LastName": "sample string 7",
    "LastNamePrefix": "sample string 8",
    "Id": 9,
    "CompanyName": "sample string 10",
    "Address": "sample string 11",
    "Address2": "sample string 12",
    "StreetAddress": "sample string 13",
    "StreetAddressNumber": "sample string 14",
    "StreetAddressExtension": "sample string 15",
    "PostalCode": "sample string 16",
    "City": "sample string 17",
    "CountryId": 1,
    "CountryCode": "sample string 18",
    "CountryName": null,
    "EMail": "sample string 19",
    "Phone": "sample string 20",
    "Phone2": "sample string 21",
    "StateProvince": "sample string 22",
    "StateProvinceCode": "sample string 23"
  },
  "Warehouses": [
    {
      "Id": 1,
      "Name": "sample string 2"
    },
    {
      "Id": 1,
      "Name": "sample string 2"
    }
  ],
  "ShopOwnerId": 1,
  "PersonTitle": "sample string 1",
  "FirstName": "sample string 2",
  "MiddleName": "sample string 3",
  "LastNamePrefix": "sample string 4",
  "LastName": "sample string 5",
  "CultureId": 1,
  "PersonalNumber": "sample string 6",
  "ChangedTimestamp": "2021-12-02T20:19:39.3884834+01:00",
  "Id": 7,
  "FullName": "sample string 8",
  "CompanyName": "sample string 9",
  "EMail": "sample string 10",
  "ContactReference": "sample string 11"
}

application/xml, text/xml

Sample:
<SupplierChanges xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>7</Id>
  <FullName>sample string 8</FullName>
  <CompanyName>sample string 9</CompanyName>
  <EMail>sample string 10</EMail>
  <ContactReference>sample string 11</ContactReference>
  <ShopOwnerId>1</ShopOwnerId>
  <PersonTitle>sample string 1</PersonTitle>
  <FirstName>sample string 2</FirstName>
  <MiddleName>sample string 3</MiddleName>
  <LastNamePrefix>sample string 4</LastNamePrefix>
  <LastName>sample string 5</LastName>
  <CultureId>1</CultureId>
  <PersonalNumber>sample string 6</PersonalNumber>
  <ChangedTimestamp>2021-12-02T20:19:39.3884834+01:00</ChangedTimestamp>
  <MainAddress>
    <Id>9</Id>
    <CompanyName>sample string 10</CompanyName>
    <Address>sample string 11</Address>
    <Address2>sample string 12</Address2>
    <StreetAddress>sample string 13</StreetAddress>
    <StreetAddressNumber>sample string 14</StreetAddressNumber>
    <StreetAddressExtension>sample string 15</StreetAddressExtension>
    <PostalCode>sample string 16</PostalCode>
    <City>sample string 17</City>
    <CountryId>1</CountryId>
    <CountryCode>sample string 18</CountryCode>
    <EMail>sample string 19</EMail>
    <Phone>sample string 20</Phone>
    <Phone2>sample string 21</Phone2>
    <StateProvince>sample string 22</StateProvince>
    <StateProvinceCode>sample string 23</StateProvinceCode>
    <VatNumber>sample string 1</VatNumber>
    <FullName>sample string 2</FullName>
    <DateOfBirth>2021-12-02T20:19:39.3884834+01:00</DateOfBirth>
    <Gender>sample string 3</Gender>
    <PersonTitle>sample string 4</PersonTitle>
    <MiddleName>sample string 5</MiddleName>
    <FirstName>sample string 6</FirstName>
    <LastName>sample string 7</LastName>
    <LastNamePrefix>sample string 8</LastNamePrefix>
  </MainAddress>
  <Warehouses>
    <WarehouseBasicInfo>
      <Id>1</Id>
      <Name>sample string 2</Name>
    </WarehouseBasicInfo>
    <WarehouseBasicInfo>
      <Id>1</Id>
      <Name>sample string 2</Name>
    </WarehouseBasicInfo>
  </Warehouses>
</SupplierChanges>

Response Information

Resource Description

The Supplier object.


Supplier
NameDescriptionTypeAdditional information
MainAddress

Gets or sets the main address.

ContactInfo

None.

Warehouses

Collection of WarehouseBasicInfo

None.

ShopOwnerId

Gets or sets the shop owner identifier.

integer

Required

PersonTitle

Gets or sets the person title.

string

Max length: 50

FirstName

Gets or sets the first name.

string

Max length: 50

MiddleName

Gets or sets the middle name.

string

Max length: 50

LastNamePrefix

Gets or sets the last name prefix.

string

Max length: 50

LastName

Gets or sets the last name.

string

Max length: 50

CultureId

Gets or sets the culture identifier.

integer

None.

PersonalNumber

Gets or sets the personal number.

string

Max length: 20

ChangedTimestamp

Gets or sets the changed timestamp.

date

None.

Id

Gets or sets the identifier.

integer

Must be 0

FullName

Gets or sets the full name.

string

Max length: 100

CompanyName

Gets or sets the name of the company.

string

Max length: 100

EMail

Gets or sets the e mail.

string

Max length: 200

ContactReference

Gets or sets the contact reference.

string

None.

Response Formats

application/json, text/json

Sample:
{
  "MainAddress": {
    "VatNumber": "sample string 1",
    "FullName": "sample string 2",
    "DateOfBirth": "2021-12-02T20:19:39.4041075+01:00",
    "Gender": "sample string 3",
    "PersonTitle": "sample string 4",
    "MiddleName": "sample string 5",
    "FirstName": "sample string 6",
    "LastName": "sample string 7",
    "LastNamePrefix": "sample string 8",
    "Id": 9,
    "CompanyName": "sample string 10",
    "Address": "sample string 11",
    "Address2": "sample string 12",
    "StreetAddress": "sample string 13",
    "StreetAddressNumber": "sample string 14",
    "StreetAddressExtension": "sample string 15",
    "PostalCode": "sample string 16",
    "City": "sample string 17",
    "CountryId": 1,
    "CountryCode": "sample string 18",
    "CountryName": null,
    "EMail": "sample string 19",
    "Phone": "sample string 20",
    "Phone2": "sample string 21",
    "StateProvince": "sample string 22",
    "StateProvinceCode": "sample string 23"
  },
  "Warehouses": [
    {
      "Id": 1,
      "Name": "sample string 2"
    },
    {
      "Id": 1,
      "Name": "sample string 2"
    }
  ],
  "ShopOwnerId": 1,
  "PersonTitle": "sample string 1",
  "FirstName": "sample string 2",
  "MiddleName": "sample string 3",
  "LastNamePrefix": "sample string 4",
  "LastName": "sample string 5",
  "CultureId": 1,
  "PersonalNumber": "sample string 6",
  "ChangedTimestamp": "2021-12-02T20:19:39.4041075+01:00",
  "Id": 7,
  "FullName": "sample string 8",
  "CompanyName": "sample string 9",
  "EMail": "sample string 10",
  "ContactReference": "sample string 11"
}

application/xml, text/xml

Sample:
<Supplier xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>7</Id>
  <FullName>sample string 8</FullName>
  <CompanyName>sample string 9</CompanyName>
  <EMail>sample string 10</EMail>
  <ContactReference>sample string 11</ContactReference>
  <ShopOwnerId>1</ShopOwnerId>
  <PersonTitle>sample string 1</PersonTitle>
  <FirstName>sample string 2</FirstName>
  <MiddleName>sample string 3</MiddleName>
  <LastNamePrefix>sample string 4</LastNamePrefix>
  <LastName>sample string 5</LastName>
  <CultureId>1</CultureId>
  <PersonalNumber>sample string 6</PersonalNumber>
  <ChangedTimestamp>2021-12-02T20:19:39.4041075+01:00</ChangedTimestamp>
  <MainAddress>
    <Id>9</Id>
    <CompanyName>sample string 10</CompanyName>
    <Address>sample string 11</Address>
    <Address2>sample string 12</Address2>
    <StreetAddress>sample string 13</StreetAddress>
    <StreetAddressNumber>sample string 14</StreetAddressNumber>
    <StreetAddressExtension>sample string 15</StreetAddressExtension>
    <PostalCode>sample string 16</PostalCode>
    <City>sample string 17</City>
    <CountryId>1</CountryId>
    <CountryCode>sample string 18</CountryCode>
    <EMail>sample string 19</EMail>
    <Phone>sample string 20</Phone>
    <Phone2>sample string 21</Phone2>
    <StateProvince>sample string 22</StateProvince>
    <StateProvinceCode>sample string 23</StateProvinceCode>
    <VatNumber>sample string 1</VatNumber>
    <FullName>sample string 2</FullName>
    <DateOfBirth>2021-12-02T20:19:39.4041075+01:00</DateOfBirth>
    <Gender>sample string 3</Gender>
    <PersonTitle>sample string 4</PersonTitle>
    <MiddleName>sample string 5</MiddleName>
    <FirstName>sample string 6</FirstName>
    <LastName>sample string 7</LastName>
    <LastNamePrefix>sample string 8</LastNamePrefix>
  </MainAddress>
  <Warehouses>
    <WarehouseBasicInfo>
      <Id>1</Id>
      <Name>sample string 2</Name>
    </WarehouseBasicInfo>
    <WarehouseBasicInfo>
      <Id>1</Id>
      <Name>sample string 2</Name>
    </WarehouseBasicInfo>
  </Warehouses>
</Supplier>