POST api/GetLocations_V1

Get All Locations informations

Request Information

URI Parameters

None.

Body Parameters

Webservice Key provided by 2ship support

string

Request Formats

application/json, text/json

Sample:

"sample string 1"

application/xml, text/xml

Sample:

<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'System.Web.Http.ModelBinding.JQueryMvcFormUrlEncodedFormatter' to write type 'System.String'.

Response Information

Resource Description

WS_Repository.Models.Responses.Location.LocationReply

Name	Description	Type	Additional information
Locations	Array of Locations linked to your user	Collection of WS_Repository.Models.Responses.Location.Location	None.

Response Formats

application/json, text/json

Sample:

{
  "Locations": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Address": {
        "ContactName": "sample string 1",
        "CompanyName": "sample string 2",
        "Country": "sample string 3",
        "State": "sample string 4",
        "City": "sample string 5",
        "PostalCode": "sample string 6",
        "Address1": "sample string 7",
        "Address2": "sample string 8",
        "Address3": "sample string 9",
        "Telephone": "sample string 10",
        "Email": "sample string 11",
        "IsResidential": true
      },
      "RestrictInboundCarriers": true,
      "UseLocationFees": true,
      "UseForCrossDock": true,
      "UseForConsolidation": true,
      "UseForDeconsolidation": true,
      "InboundCarriersAccepted": [
        {
          "CarrierId": 1,
          "CarrierName": "sample string 2"
        },
        {
          "CarrierId": 1,
          "CarrierName": "sample string 2"
        }
      ],
      "LocationFees": {
        "CrossDockFees": {
          "CostType": 0,
          "CostByRanges": [
            {
              "Start": 1.0,
              "End": 2.0,
              "Value": 3.0
            },
            {
              "Start": 1.0,
              "End": 2.0,
              "Value": 3.0
            }
          ]
        },
        "ConsolidationFees": {
          "CostType": 0,
          "CostByRanges": [
            {
              "Start": 1.0,
              "End": 2.0,
              "Value": 3.0
            },
            {
              "Start": 1.0,
              "End": 2.0,
              "Value": 3.0
            }
          ]
        },
        "DeconsolidationFees": {
          "CostType": 0,
          "CostByRanges": [
            {
              "Start": 1.0,
              "End": 2.0,
              "Value": 3.0
            },
            {
              "Start": 1.0,
              "End": 2.0,
              "Value": 3.0
            }
          ]
        }
      },
      "LocationHubs": {
        "HubCode": "sample string 1",
        "HubName": "sample string 2"
      }
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "Address": {
        "ContactName": "sample string 1",
        "CompanyName": "sample string 2",
        "Country": "sample string 3",
        "State": "sample string 4",
        "City": "sample string 5",
        "PostalCode": "sample string 6",
        "Address1": "sample string 7",
        "Address2": "sample string 8",
        "Address3": "sample string 9",
        "Telephone": "sample string 10",
        "Email": "sample string 11",
        "IsResidential": true
      },
      "RestrictInboundCarriers": true,
      "UseLocationFees": true,
      "UseForCrossDock": true,
      "UseForConsolidation": true,
      "UseForDeconsolidation": true,
      "InboundCarriersAccepted": [
        {
          "CarrierId": 1,
          "CarrierName": "sample string 2"
        },
        {
          "CarrierId": 1,
          "CarrierName": "sample string 2"
        }
      ],
      "LocationFees": {
        "CrossDockFees": {
          "CostType": 0,
          "CostByRanges": [
            {
              "Start": 1.0,
              "End": 2.0,
              "Value": 3.0
            },
            {
              "Start": 1.0,
              "End": 2.0,
              "Value": 3.0
            }
          ]
        },
        "ConsolidationFees": {
          "CostType": 0,
          "CostByRanges": [
            {
              "Start": 1.0,
              "End": 2.0,
              "Value": 3.0
            },
            {
              "Start": 1.0,
              "End": 2.0,
              "Value": 3.0
            }
          ]
        },
        "DeconsolidationFees": {
          "CostType": 0,
          "CostByRanges": [
            {
              "Start": 1.0,
              "End": 2.0,
              "Value": 3.0
            },
            {
              "Start": 1.0,
              "End": 2.0,
              "Value": 3.0
            }
          ]
        }
      },
      "LocationHubs": {
        "HubCode": "sample string 1",
        "HubName": "sample string 2"
      }
    }
  ]
}

application/xml, text/xml

Sample:

<LocationReply xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WS_Repository.Models.Responses.Location">
  <Locations>
    <Location>
      <Address>
        <Address1>sample string 7</Address1>
        <Address2>sample string 8</Address2>
        <Address3>sample string 9</Address3>
        <City>sample string 5</City>
        <CompanyName>sample string 2</CompanyName>
        <ContactName>sample string 1</ContactName>
        <Country>sample string 3</Country>
        <Email>sample string 11</Email>
        <IsResidential>true</IsResidential>
        <PostalCode>sample string 6</PostalCode>
        <State>sample string 4</State>
        <Telephone>sample string 10</Telephone>
      </Address>
      <Id>1</Id>
      <InboundCarriersAccepted>
        <CarrierToLocation>
          <CarrierId>1</CarrierId>
          <CarrierName>sample string 2</CarrierName>
        </CarrierToLocation>
        <CarrierToLocation>
          <CarrierId>1</CarrierId>
          <CarrierName>sample string 2</CarrierName>
        </CarrierToLocation>
      </InboundCarriersAccepted>
      <LocationFees>
        <ConsolidationFees>
          <CostByRanges>
            <CostByRange>
              <End>2</End>
              <Start>1</Start>
              <Value>3</Value>
            </CostByRange>
            <CostByRange>
              <End>2</End>
              <Start>1</Start>
              <Value>3</Value>
            </CostByRange>
          </CostByRanges>
          <CostType>FlatCost</CostType>
        </ConsolidationFees>
        <CrossDockFees>
          <CostByRanges>
            <CostByRange>
              <End>2</End>
              <Start>1</Start>
              <Value>3</Value>
            </CostByRange>
            <CostByRange>
              <End>2</End>
              <Start>1</Start>
              <Value>3</Value>
            </CostByRange>
          </CostByRanges>
          <CostType>FlatCost</CostType>
        </CrossDockFees>
        <DeconsolidationFees>
          <CostByRanges>
            <CostByRange>
              <End>2</End>
              <Start>1</Start>
              <Value>3</Value>
            </CostByRange>
            <CostByRange>
              <End>2</End>
              <Start>1</Start>
              <Value>3</Value>
            </CostByRange>
          </CostByRanges>
          <CostType>FlatCost</CostType>
        </DeconsolidationFees>
      </LocationFees>
      <LocationHubs>
        <HubCode>sample string 1</HubCode>
        <HubName>sample string 2</HubName>
      </LocationHubs>
      <Name>sample string 2</Name>
      <RestrictInboundCarriers>true</RestrictInboundCarriers>
      <UseForConsolidation>true</UseForConsolidation>
      <UseForCrossDock>true</UseForCrossDock>
      <UseForDeconsolidation>true</UseForDeconsolidation>
      <UseLocationFees>true</UseLocationFees>
    </Location>
    <Location>
      <Address>
        <Address1>sample string 7</Address1>
        <Address2>sample string 8</Address2>
        <Address3>sample string 9</Address3>
        <City>sample string 5</City>
        <CompanyName>sample string 2</CompanyName>
        <ContactName>sample string 1</ContactName>
        <Country>sample string 3</Country>
        <Email>sample string 11</Email>
        <IsResidential>true</IsResidential>
        <PostalCode>sample string 6</PostalCode>
        <State>sample string 4</State>
        <Telephone>sample string 10</Telephone>
      </Address>
      <Id>1</Id>
      <InboundCarriersAccepted>
        <CarrierToLocation>
          <CarrierId>1</CarrierId>
          <CarrierName>sample string 2</CarrierName>
        </CarrierToLocation>
        <CarrierToLocation>
          <CarrierId>1</CarrierId>
          <CarrierName>sample string 2</CarrierName>
        </CarrierToLocation>
      </InboundCarriersAccepted>
      <LocationFees>
        <ConsolidationFees>
          <CostByRanges>
            <CostByRange>
              <End>2</End>
              <Start>1</Start>
              <Value>3</Value>
            </CostByRange>
            <CostByRange>
              <End>2</End>
              <Start>1</Start>
              <Value>3</Value>
            </CostByRange>
          </CostByRanges>
          <CostType>FlatCost</CostType>
        </ConsolidationFees>
        <CrossDockFees>
          <CostByRanges>
            <CostByRange>
              <End>2</End>
              <Start>1</Start>
              <Value>3</Value>
            </CostByRange>
            <CostByRange>
              <End>2</End>
              <Start>1</Start>
              <Value>3</Value>
            </CostByRange>
          </CostByRanges>
          <CostType>FlatCost</CostType>
        </CrossDockFees>
        <DeconsolidationFees>
          <CostByRanges>
            <CostByRange>
              <End>2</End>
              <Start>1</Start>
              <Value>3</Value>
            </CostByRange>
            <CostByRange>
              <End>2</End>
              <Start>1</Start>
              <Value>3</Value>
            </CostByRange>
          </CostByRanges>
          <CostType>FlatCost</CostType>
        </DeconsolidationFees>
      </LocationFees>
      <LocationHubs>
        <HubCode>sample string 1</HubCode>
        <HubName>sample string 2</HubName>
      </LocationHubs>
      <Name>sample string 2</Name>
      <RestrictInboundCarriers>true</RestrictInboundCarriers>
      <UseForConsolidation>true</UseForConsolidation>
      <UseForCrossDock>true</UseForCrossDock>
      <UseForDeconsolidation>true</UseForDeconsolidation>
      <UseLocationFees>true</UseLocationFees>
    </Location>
  </Locations>
</LocationReply>