POST v1/Shops

Add a new Shop for a ShopOwner.

Request Information

Requires Authorization!

URI Parameters

None.

Body Parameters

The Shop changes object

Name	Description	Type	Additional information
CompanyName	Gets or sets the name of the company.	string	Max length: 50
Url	Gets or sets the URL.	string	Max length: 100
CountryId	Gets or sets the country identifier.	integer	Required
CultureId	Gets or sets the culture identifier.	integer	Required
CurrencyId	Gets or sets the currency identifier.	integer	Required
SitePhone	Gets or sets the site phone.	string	Max length: 50
SiteEmail	Gets or sets the site email.	string	Max length: 200
SiteAddress	Gets or sets the site address.	string	Max length: 100
SitePostalCode	Gets or sets the site postal code.	string	Max length: 50
SiteCity	Gets or sets the site city.	string	Max length: 50
SiteCountryName	Gets or sets the name of the site country.	string	Max length: 50
SiteBankAccountIban	Gets or sets the site IBAN bank account.	string	Max length: 50
SiteVatNumber	Gets or sets the site VAT number.	string	Max length: 50
SiteCoC	Gets or sets the registration number of the site.	string	Max length: 50
SiteDirector	Gets or sets the site director.	string	Max length: 50
MailAddress	Gets or sets the mail address.	string	Max length: 100
LastMailCheck	Gets or sets the date of last mail check.	date	None.
SyncServiceLastSync	Gets or sets the date when the service was last synchronized.	date	None.
DefaultPaymentTermsId	Gets or sets the default payment terms identifier.	integer	None.
Notes	Gets or sets the notes.	string	Max length: 2147483647
PhoneCidName	Gets or sets the name of the phone Caller ID.	string	Max length: 100
PhoneOutboundPrefix	Gets or sets the phone outbound prefix.	string	Max length: 10
LiveStartDate	Gets or sets the live start date.	date	None.
LiveEndDate	Gets or sets the live end date.	date	None.
DefaultUseIncVat	Gets or sets a value indicating whether is used as default (include VAT).	boolean	Required
InvoiceNumberingAtShopLevel	Gets or sets a value indicating whether the invoice numbering at shop level is set.	boolean	Required
OrderNumberingAtShopLevel	Gets or sets a value indicating whether the order numbering at shop level is set.	boolean	Required
OfferNumberingAtShopLevel	Gets or sets a value indicating whether the offer numbering at shop level is set.	boolean	Required
DefaultVatTariffId	Gets or sets the default vat tariff identifier.	integer	None.
DefaultPaymentTypeId	Gets or sets the default payment type identifier.	integer	None.
IconFileId	Gets or sets the icon file identifier.	integer	None.
LogoFileId	Gets or sets the logo file identifier.	integer	None.
ActiveProductSelectionId	Gets or sets the active product selection identifier.	integer	None.
Parameters		Collection of ShopParameterBasic	None.
Id	Gets or sets the identifier.	integer	Must be 0
Name	Gets or sets the name.	string	Required Max length: 50
ShopOwnerId	Gets or sets the shop owner identifier.	integer	Required
ShopGroupId	Gets or sets the shop group identifier.	integer	Required
Active	Gets or sets a value indicating whether this is active.	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "CompanyName": "sample string 1",
  "Url": "sample string 2",
  "CountryId": 3,
  "CultureId": 4,
  "CurrencyId": 5,
  "SitePhone": "sample string 6",
  "SiteEmail": "sample string 7",
  "SiteAddress": "sample string 8",
  "SitePostalCode": "sample string 9",
  "SiteCity": "sample string 10",
  "SiteCountryName": "sample string 11",
  "SiteBankAccountIban": "sample string 12",
  "SiteVatNumber": "sample string 13",
  "SiteCoC": "sample string 14",
  "SiteDirector": "sample string 15",
  "MailAddress": "sample string 16",
  "LastMailCheck": "2021-12-02T20:19:38.8884832+01:00",
  "SyncServiceLastSync": "2021-12-02T20:19:38.8884832+01:00",
  "DefaultPaymentTermsId": 1,
  "Notes": "sample string 17",
  "PhoneCidName": "sample string 18",
  "PhoneOutboundPrefix": "sample string 19",
  "LiveStartDate": "2021-12-02T20:19:38.8884832+01:00",
  "LiveEndDate": "2021-12-02T20:19:38.8884832+01:00",
  "DefaultUseIncVat": true,
  "InvoiceNumberingAtShopLevel": true,
  "OrderNumberingAtShopLevel": true,
  "OfferNumberingAtShopLevel": true,
  "DefaultVatTariffId": 1,
  "DefaultPaymentTypeId": 1,
  "IconFileId": 1,
  "LogoFileId": 1,
  "ActiveProductSelectionId": 1,
  "Parameters": [
    {
      "Key": "sample string 1",
      "Value": "sample string 2",
      "DataType": "sample string 3"
    },
    {
      "Key": "sample string 1",
      "Value": "sample string 2",
      "DataType": "sample string 3"
    }
  ],
  "Id": 24,
  "Name": "sample string 25",
  "ShopOwnerId": 26,
  "ShopGroupId": 27,
  "Active": true
}

application/xml, text/xml

Sample:

<ShopChanges xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>24</Id>
  <Name>sample string 25</Name>
  <ShopOwnerId>26</ShopOwnerId>
  <ShopGroupId>27</ShopGroupId>
  <Active>true</Active>
  <CompanyName>sample string 1</CompanyName>
  <Url>sample string 2</Url>
  <CountryId>3</CountryId>
  <CultureId>4</CultureId>
  <CurrencyId>5</CurrencyId>
  <SitePhone>sample string 6</SitePhone>
  <SiteEmail>sample string 7</SiteEmail>
  <SiteAddress>sample string 8</SiteAddress>
  <SitePostalCode>sample string 9</SitePostalCode>
  <SiteCity>sample string 10</SiteCity>
  <SiteCountryName>sample string 11</SiteCountryName>
  <SiteBankAccountIban>sample string 12</SiteBankAccountIban>
  <SiteVatNumber>sample string 13</SiteVatNumber>
  <SiteCoC>sample string 14</SiteCoC>
  <SiteDirector>sample string 15</SiteDirector>
  <MailAddress>sample string 16</MailAddress>
  <LastMailCheck>2021-12-02T20:19:38.8884832+01:00</LastMailCheck>
  <SyncServiceLastSync>2021-12-02T20:19:38.8884832+01:00</SyncServiceLastSync>
  <DefaultPaymentTermsId>1</DefaultPaymentTermsId>
  <Notes>sample string 17</Notes>
  <PhoneCidName>sample string 18</PhoneCidName>
  <PhoneOutboundPrefix>sample string 19</PhoneOutboundPrefix>
  <LiveStartDate>2021-12-02T20:19:38.8884832+01:00</LiveStartDate>
  <LiveEndDate>2021-12-02T20:19:38.8884832+01:00</LiveEndDate>
  <DefaultUseIncVat>true</DefaultUseIncVat>
  <InvoiceNumberingAtShopLevel>true</InvoiceNumberingAtShopLevel>
  <OrderNumberingAtShopLevel>true</OrderNumberingAtShopLevel>
  <OfferNumberingAtShopLevel>true</OfferNumberingAtShopLevel>
  <DefaultVatTariffId>1</DefaultVatTariffId>
  <DefaultPaymentTypeId>1</DefaultPaymentTypeId>
  <IconFileId>1</IconFileId>
  <LogoFileId>1</LogoFileId>
  <ActiveProductSelectionId>1</ActiveProductSelectionId>
  <Parameters>
    <ShopParameterBasic>
      <Key>sample string 1</Key>
      <Value>sample string 2</Value>
      <DataType>sample string 3</DataType>
    </ShopParameterBasic>
    <ShopParameterBasic>
      <Key>sample string 1</Key>
      <Value>sample string 2</Value>
      <DataType>sample string 3</DataType>
    </ShopParameterBasic>
  </Parameters>
</ShopChanges>

Response Information

Resource Description

Shop

Name	Description	Type	Additional information
CompanyName	Gets or sets the name of the company.	string	Max length: 50
Url	Gets or sets the URL.	string	Max length: 100
CountryId	Gets or sets the country identifier.	integer	Required
CultureId	Gets or sets the culture identifier.	integer	Required
CurrencyId	Gets or sets the currency identifier.	integer	Required
SitePhone	Gets or sets the site phone.	string	Max length: 50
SiteEmail	Gets or sets the site email.	string	Max length: 200
SiteAddress	Gets or sets the site address.	string	Max length: 100
SitePostalCode	Gets or sets the site postal code.	string	Max length: 50
SiteCity	Gets or sets the site city.	string	Max length: 50
SiteCountryName	Gets or sets the name of the site country.	string	Max length: 50
SiteBankAccountIban	Gets or sets the site IBAN bank account.	string	Max length: 50
SiteVatNumber	Gets or sets the site VAT number.	string	Max length: 50
SiteCoC	Gets or sets the registration number of the site.	string	Max length: 50
SiteDirector	Gets or sets the site director.	string	Max length: 50
MailAddress	Gets or sets the mail address.	string	Max length: 100
LastMailCheck	Gets or sets the date of last mail check.	date	None.
SyncServiceLastSync	Gets or sets the date when the service was last synchronized.	date	None.
DefaultPaymentTermsId	Gets or sets the default payment terms identifier.	integer	None.
Notes	Gets or sets the notes.	string	Max length: 2147483647
PhoneCidName	Gets or sets the name of the phone Caller ID.	string	Max length: 100
PhoneOutboundPrefix	Gets or sets the phone outbound prefix.	string	Max length: 10
LiveStartDate	Gets or sets the live start date.	date	None.
LiveEndDate	Gets or sets the live end date.	date	None.
DefaultUseIncVat	Gets or sets a value indicating whether is used as default (include VAT).	boolean	Required
InvoiceNumberingAtShopLevel	Gets or sets a value indicating whether the invoice numbering at shop level is set.	boolean	Required
OrderNumberingAtShopLevel	Gets or sets a value indicating whether the order numbering at shop level is set.	boolean	Required
OfferNumberingAtShopLevel	Gets or sets a value indicating whether the offer numbering at shop level is set.	boolean	Required
DefaultVatTariffId	Gets or sets the default vat tariff identifier.	integer	None.
DefaultPaymentTypeId	Gets or sets the default payment type identifier.	integer	None.
IconFileId	Gets or sets the icon file identifier.	integer	None.
LogoFileId	Gets or sets the logo file identifier.	integer	None.
ActiveProductSelectionId	Gets or sets the active product selection identifier.	integer	None.
Parameters		Collection of ShopParameterBasic	None.
Id	Gets or sets the identifier.	integer	Must be 0
Name	Gets or sets the name.	string	Required Max length: 50
ShopOwnerId	Gets or sets the shop owner identifier.	integer	Required
ShopGroupId	Gets or sets the shop group identifier.	integer	Required
Active	Gets or sets a value indicating whether this is active.	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "CompanyName": "sample string 1",
  "Url": "sample string 2",
  "CountryId": 3,
  "CultureId": 4,
  "CurrencyId": 5,
  "SitePhone": "sample string 6",
  "SiteEmail": "sample string 7",
  "SiteAddress": "sample string 8",
  "SitePostalCode": "sample string 9",
  "SiteCity": "sample string 10",
  "SiteCountryName": "sample string 11",
  "SiteBankAccountIban": "sample string 12",
  "SiteVatNumber": "sample string 13",
  "SiteCoC": "sample string 14",
  "SiteDirector": "sample string 15",
  "MailAddress": "sample string 16",
  "LastMailCheck": "2021-12-02T20:19:38.8884832+01:00",
  "SyncServiceLastSync": "2021-12-02T20:19:38.8884832+01:00",
  "DefaultPaymentTermsId": 1,
  "Notes": "sample string 17",
  "PhoneCidName": "sample string 18",
  "PhoneOutboundPrefix": "sample string 19",
  "LiveStartDate": "2021-12-02T20:19:38.8884832+01:00",
  "LiveEndDate": "2021-12-02T20:19:38.8884832+01:00",
  "DefaultUseIncVat": true,
  "InvoiceNumberingAtShopLevel": true,
  "OrderNumberingAtShopLevel": true,
  "OfferNumberingAtShopLevel": true,
  "DefaultVatTariffId": 1,
  "DefaultPaymentTypeId": 1,
  "IconFileId": 1,
  "LogoFileId": 1,
  "ActiveProductSelectionId": 1,
  "Parameters": [
    {
      "Key": "sample string 1",
      "Value": "sample string 2",
      "DataType": "sample string 3"
    },
    {
      "Key": "sample string 1",
      "Value": "sample string 2",
      "DataType": "sample string 3"
    }
  ],
  "Id": 24,
  "Name": "sample string 25",
  "ShopOwnerId": 26,
  "ShopGroupId": 27,
  "Active": true
}

application/xml, text/xml

Sample:

<Shop xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>24</Id>
  <Name>sample string 25</Name>
  <ShopOwnerId>26</ShopOwnerId>
  <ShopGroupId>27</ShopGroupId>
  <Active>true</Active>
  <CompanyName>sample string 1</CompanyName>
  <Url>sample string 2</Url>
  <CountryId>3</CountryId>
  <CultureId>4</CultureId>
  <CurrencyId>5</CurrencyId>
  <SitePhone>sample string 6</SitePhone>
  <SiteEmail>sample string 7</SiteEmail>
  <SiteAddress>sample string 8</SiteAddress>
  <SitePostalCode>sample string 9</SitePostalCode>
  <SiteCity>sample string 10</SiteCity>
  <SiteCountryName>sample string 11</SiteCountryName>
  <SiteBankAccountIban>sample string 12</SiteBankAccountIban>
  <SiteVatNumber>sample string 13</SiteVatNumber>
  <SiteCoC>sample string 14</SiteCoC>
  <SiteDirector>sample string 15</SiteDirector>
  <MailAddress>sample string 16</MailAddress>
  <LastMailCheck>2021-12-02T20:19:38.8884832+01:00</LastMailCheck>
  <SyncServiceLastSync>2021-12-02T20:19:38.8884832+01:00</SyncServiceLastSync>
  <DefaultPaymentTermsId>1</DefaultPaymentTermsId>
  <Notes>sample string 17</Notes>
  <PhoneCidName>sample string 18</PhoneCidName>
  <PhoneOutboundPrefix>sample string 19</PhoneOutboundPrefix>
  <LiveStartDate>2021-12-02T20:19:38.8884832+01:00</LiveStartDate>
  <LiveEndDate>2021-12-02T20:19:38.8884832+01:00</LiveEndDate>
  <DefaultUseIncVat>true</DefaultUseIncVat>
  <InvoiceNumberingAtShopLevel>true</InvoiceNumberingAtShopLevel>
  <OrderNumberingAtShopLevel>true</OrderNumberingAtShopLevel>
  <OfferNumberingAtShopLevel>true</OfferNumberingAtShopLevel>
  <DefaultVatTariffId>1</DefaultVatTariffId>
  <DefaultPaymentTypeId>1</DefaultPaymentTypeId>
  <IconFileId>1</IconFileId>
  <LogoFileId>1</LogoFileId>
  <ActiveProductSelectionId>1</ActiveProductSelectionId>
  <Parameters>
    <ShopParameterBasic>
      <Key>sample string 1</Key>
      <Value>sample string 2</Value>
      <DataType>sample string 3</DataType>
    </ShopParameterBasic>
    <ShopParameterBasic>
      <Key>sample string 1</Key>
      <Value>sample string 2</Value>
      <DataType>sample string 3</DataType>
    </ShopParameterBasic>
  </Parameters>
</Shop>