POST Business/BusinessContact

Retrieves a BusinessContact

Request Information

URI Parameters

None.

Body Parameters

BusinessContactRequest
NameDescriptionTypeAdditional information
ID

integer

None.

BusinessID

integer

None.

AuthToken

Business authorization code for customer enrollment and gathering business details or contacts

string

None.

Lang

string

None.

StoreID

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "ID": 1,
  "BusinessID": 2,
  "AuthToken": "sample string 3",
  "Lang": "sample string 4",
  "StoreID": 5
}

application/xml, text/xml

Sample:
<BusinessContactRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Web.Models.View.Business">
  <Lang xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Web.Models.Common.Base">sample string 4</Lang>
  <StoreID xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Web.Models.Common.Base">5</StoreID>
  <AuthToken>sample string 3</AuthToken>
  <BusinessID>2</BusinessID>
  <ID>1</ID>
</BusinessContactRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

BusinessContact
NameDescriptionTypeAdditional information
ID

integer

None.

Alias

string

None.

Name

string

Required

String length: inclusive between 0 and 100

Surnames

string

Required

String length: inclusive between 0 and 100

VatIdentifier

string

None.

Email

string

None.

WebURL

string

None.

Phone

string

None.

Addressee

string

None.

Street

string

None.

PostalCode

string

None.

Place

Place

None.

Country

Country

None.

RegionCode

string

None.

Response Formats

application/json, text/json

Sample:
{
  "ID": 1,
  "Alias": "sample string 2",
  "Name": "sample string 3",
  "Surnames": "sample string 4",
  "VatIdentifier": "sample string 5",
  "Email": "sample string 6",
  "WebURL": "sample string 7",
  "Phone": "sample string 8",
  "Addressee": "sample string 9",
  "Street": "sample string 10",
  "PostalCode": "sample string 11",
  "Place": {
    "ID": 1,
    "Name": "sample string 2",
    "PostalCode": "sample string 3",
    "LocalityID": 1
  },
  "Country": {
    "ID": 1,
    "Name": "sample string 2",
    "Code": "sample string 3"
  },
  "RegionCode": "sample string 12"
}

application/xml, text/xml

Sample:
<BusinessContact xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Web.Models.View.Business">
  <Addressee xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Web.Models.View.Base">sample string 9</Addressee>
  <Country xmlns:d2p1="http://schemas.datacontract.org/2004/07/ShopworldApi.Web.Models.View.Location" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Web.Models.View.Base">
    <d2p1:Code>sample string 3</d2p1:Code>
    <d2p1:ID>1</d2p1:ID>
    <d2p1:Name>sample string 2</d2p1:Name>
  </Country>
  <Place xmlns:d2p1="http://schemas.datacontract.org/2004/07/ShopworldApi.Web.Models.View.Location" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Web.Models.View.Base">
    <d2p1:ID>1</d2p1:ID>
    <d2p1:LocalityID>1</d2p1:LocalityID>
    <d2p1:Name>sample string 2</d2p1:Name>
    <d2p1:PostalCode>sample string 3</d2p1:PostalCode>
  </Place>
  <PostalCode xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Web.Models.View.Base">sample string 11</PostalCode>
  <RegionCode xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Web.Models.View.Base">sample string 12</RegionCode>
  <Street xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Web.Models.View.Base">sample string 10</Street>
  <Email xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Web.Models.View.Base">sample string 6</Email>
  <Phone xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Web.Models.View.Base">sample string 8</Phone>
  <WebURL xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Web.Models.View.Base">sample string 7</WebURL>
  <Alias xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Web.Models.View.Base">sample string 2</Alias>
  <Name xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Web.Models.View.Base">sample string 3</Name>
  <Surnames xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Web.Models.View.Base">sample string 4</Surnames>
  <VatIdentifier xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Web.Models.View.Base">sample string 5</VatIdentifier>
  <ID>1</ID>
</BusinessContact>