GET api/ShipmentOuts/OptimizedLocationList?countryCode={countryCode}

Returns the list that shows states, and optimized warehouse locations to send the package from.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
countryCode

Country code of the destination country

string

Required

Body Parameters

None.

Response Information

Resource Description

ResponseApiInfoOfListOfOptimizedLocationForStatesList
NameDescriptionTypeAdditional information
data

Collection of OptimizedLocationForStatesList

None.

UpdateResult

UPDATECODE

None.

isErrorOnRequest

boolean

None.

errorMessage

string

None.

errorMessages

Collection of ErrorInfo

None.

warningMessages

Collection of ErrorInfo

None.

isSuccess

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "isSuccess": true,
  "data": [
    {
      "StateCode": "sample string 1",
      "LocationID": "ALL",
      "IsCustomLocation": true
    },
    {
      "StateCode": "sample string 1",
      "LocationID": "ALL",
      "IsCustomLocation": true
    }
  ],
  "UpdateResult": "CREATE",
  "isErrorOnRequest": true,
  "errorMessage": null,
  "errorMessages": [],
  "warningMessages": []
}

application/xml, text/xml

Sample:
<xml xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <isSuccess>true</isSuccess>
  <UpdateResult>CREATE</UpdateResult>
  <isErrorOnRequest>true</isErrorOnRequest>
  <errorMessages />
  <warningMessages />
  <data>
    <OptimizedLocationForStatesList>
      <StateCode>sample string 1</StateCode>
      <LocationID>ALL</LocationID>
      <IsCustomLocation>true</IsCustomLocation>
    </OptimizedLocationForStatesList>
    <OptimizedLocationForStatesList>
      <StateCode>sample string 1</StateCode>
      <LocationID>ALL</LocationID>
      <IsCustomLocation>true</IsCustomLocation>
    </OptimizedLocationForStatesList>
  </data>
</xml>