POST api/Order/VerifyShippingAddress?providerId={providerId}

Request Information

URI Parameters

Name	Description	Type	Additional information
providerId		integer	Required

Body Parameters

ShipAddress

Name	Type	Additional information
AddressBookID	integer	None.
ProviderID	integer	None.
ShopperID	integer	None.
AddressName	string	None.
ContactPerson	string	None.
AddressLine1	string	None.
AddressLine2	string	None.
City	string	None.
StateCode	string	None.
CountryCode	string	None.
ZipCode	string	None.
PhoneNumber	string	None.
FaxNumber	string	None.
Email	string	None.
StateName	string	None.
CountryName	string	None.
County	string	None.
AddressBookType	byte	None.
DefaultWarehouse	boolean	None.

Request Formats

application/json, text/json, text/html

Sample:

{
  "AddressBookID": 1,
  "ProviderID": 1,
  "ShopperID": 1,
  "AddressName": "sample string 1",
  "ContactPerson": "sample string 2",
  "AddressLine1": "sample string 3",
  "AddressLine2": "sample string 4",
  "City": "sample string 5",
  "StateCode": "sample string 6",
  "CountryCode": "sample string 7",
  "ZipCode": "sample string 8",
  "PhoneNumber": "sample string 9",
  "FaxNumber": "sample string 10",
  "Email": "sample string 11",
  "StateName": "sample string 12",
  "CountryName": "sample string 13",
  "County": "sample string 14",
  "AddressBookType": 64,
  "DefaultWarehouse": true
}

application/xml, text/xml

Sample:

<ShipAddress xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SellersCommerce.ViewModels.Orders">
  <AddressBookID>1</AddressBookID>
  <AddressBookType>64</AddressBookType>
  <AddressLine1>sample string 3</AddressLine1>
  <AddressLine2>sample string 4</AddressLine2>
  <AddressName>sample string 1</AddressName>
  <City>sample string 5</City>
  <ContactPerson>sample string 2</ContactPerson>
  <CountryCode>sample string 7</CountryCode>
  <CountryName>sample string 13</CountryName>
  <County>sample string 14</County>
  <DefaultWarehouse>true</DefaultWarehouse>
  <Email>sample string 11</Email>
  <FaxNumber>sample string 10</FaxNumber>
  <PhoneNumber>sample string 9</PhoneNumber>
  <ProviderID>1</ProviderID>
  <ShopperID>1</ShopperID>
  <StateCode>sample string 6</StateCode>
  <StateName>sample string 12</StateName>
  <ZipCode>sample string 8</ZipCode>
</ShipAddress>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ShippingVerificationResponse

Name	Type	Additional information
IsAddressVerified	boolean	None.
IsValidAddress	boolean	None.
TaxJurisdictionCode	string	None.
Status	string	None.
ResponseMessage	APIRequestTracking	None.
VerificationClient	string	None.
Messages	Collection of string	None.

Response Formats

application/json, text/json, text/html

Sample:

{
  "IsAddressVerified": true,
  "IsValidAddress": true,
  "TaxJurisdictionCode": "sample string 3",
  "Status": "sample string 4",
  "ResponseMessage": {
    "APIRequestTrackingID": 1,
    "RequestBody": "sample string 2",
    "Client": "sample string 3",
    "DateRequested": "1/22/2025",
    "Status": "sample string 5",
    "ResponseBody": "sample string 6",
    "ProviderID": 7,
    "RequestTime": "1/22/2025",
    "ResponseTime": "1/22/2025"
  },
  "VerificationClient": "sample string 5",
  "Messages": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<ShippingVerificationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SellersCommerce.Shipping.ShippingValidations">
  <IsAddressVerified>true</IsAddressVerified>
  <IsValidAddress>true</IsValidAddress>
  <Messages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Messages>
  <ResponseMessage xmlns:d2p1="http://schemas.datacontract.org/2004/07/SellersCommerce.Entities.Commerce">
    <d2p1:APIRequestTrackingID>1</d2p1:APIRequestTrackingID>
    <d2p1:Client>sample string 3</d2p1:Client>
    <d2p1:DateRequested>2025-01-22T13:59:49.270896+00:00</d2p1:DateRequested>
    <d2p1:ProviderID>7</d2p1:ProviderID>
    <d2p1:RequestBody>sample string 2</d2p1:RequestBody>
    <d2p1:RequestTime>2025-01-22T13:59:49.270896+00:00</d2p1:RequestTime>
    <d2p1:ResponseBody>sample string 6</d2p1:ResponseBody>
    <d2p1:ResponseTime>2025-01-22T13:59:49.270896+00:00</d2p1:ResponseTime>
    <d2p1:Status>sample string 5</d2p1:Status>
  </ResponseMessage>
  <Status>sample string 4</Status>
  <TaxJurisdictionCode>sample string 3</TaxJurisdictionCode>
  <VerificationClient>sample string 5</VerificationClient>
</ShippingVerificationResponse>