Documentation for POST api/order/Address/GeographicDrilldown

POST api/order/Address/GeographicDrilldown

Creates a Geographic Drilldown Record. Country and State are REQUIRED. AddressTypeID defaults to Both (1) if not provided.

Request Information

URI Parameters

None.

Body Parameters

The Geographic Drilldown parameters. REQUIRED: Country, State. OPTIONAL: City, County, PostalCode. AddressTypeID: Defaults to Both (1) if not provided - applies to both Billing and Shipping. Use Billing (2) or Shipping (3) for type-specific records.

GeographicDrilldownViewModel

Name	Description	Type	Additional information
country	REQUIRED: Country name (e.g., "USA")	string	Required
state	REQUIRED: State or province name	string	Required
city	Optional: City name	string	None.
county	Optional: County name	string	None.
postalCode	Optional: Postal code or ZIP code	string	None.
addressTypeID	Address Type ID: Both (1), Billing (2), or Shipping (3). Defaults to Both if not specified.	AddressTypeID	None.

Request Formats

application/xml, text/xml

Sample:

<GeographicDrilldownViewModel>
  <Country>sample string 1</Country>
  <State>sample string 2</State>
  <City>sample string 3</City>
  <County>sample string 4</County>
  <PostalCode>sample string 5</PostalCode>
  <AddressTypeID>Both</AddressTypeID>
</GeographicDrilldownViewModel>

application/json, text/json

Sample:

{
  "country": "sample string 1",
  "state": "sample string 2",
  "city": "sample string 3",
  "county": "sample string 4",
  "postalCode": "sample string 5",
  "addressTypeID": 1
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'FormUrlEncodedFormatter' to write type 'GeographicDrilldownViewModel'.

Response Information

Resource Description

An operation result indicating success or failure

IOperationResult

Name	Type	Additional information
IsSuccessful	boolean	None.
ValidationErrors	Dictionary of string [key] and string [value]	None.
Value	Object	None.

Response Formats

application/xml, text/xml

Sample:

<OperationResult>
  <IsSuccessful>False</IsSuccessful>
  <ValidationErrors />
  <Value />
</OperationResult>

application/json, text/json

Sample:

{
  "IsSuccessful": false,
  "ValidationErrors": {}
}