POST Logistics/ShippingZone

GetShippingZones

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ID	integer	None.
Lang	string	None.
StoreID	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "ID": 1,
  "Lang": "sample string 2",
  "StoreID": 3
}

application/xml, text/xml

Sample:

<GetShippingZoneRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Logistics">
  <Lang xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">sample string 2</Lang>
  <StoreID xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">3</StoreID>
  <ID>1</ID>
</GetShippingZoneRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ShippingZone

Name	Description	Type	Additional information
ID		integer	None.
StoreID		integer	None.
Name		string	None.
Disabled		date	None.
Priority	Sets the priority when more than zone coincides with the destination address	integer	None.
InvoiceRequired	Shippings to this zone require an Invoice	boolean	None.
Locations	Locations included in this zone	Collection of ShippingZoneLocation	None.

Response Formats

application/json, text/json

Sample:

{
  "ID": 1,
  "StoreID": 2,
  "Name": "sample string 3",
  "Disabled": "2025-12-06T05:42:13.8378828+01:00",
  "Priority": 4,
  "InvoiceRequired": true,
  "Locations": [
    {
      "ID": 1,
      "ZoneID": 2,
      "LocationID": 3,
      "TypeID": 4,
      "Excluded": true
    },
    {
      "ID": 1,
      "ZoneID": 2,
      "LocationID": 3,
      "TypeID": 4,
      "Excluded": true
    }
  ]
}

application/xml, text/xml

Sample:

<ShippingZone xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Logistics">
  <Disabled>2025-12-06T05:42:13.8378828+01:00</Disabled>
  <ID>1</ID>
  <InvoiceRequired>true</InvoiceRequired>
  <Locations>
    <ShippingZoneLocation>
      <Excluded>true</Excluded>
      <ID>1</ID>
      <LocationID>3</LocationID>
      <TypeID>4</TypeID>
      <ZoneID>2</ZoneID>
    </ShippingZoneLocation>
    <ShippingZoneLocation>
      <Excluded>true</Excluded>
      <ID>1</ID>
      <LocationID>3</LocationID>
      <TypeID>4</TypeID>
      <ZoneID>2</ZoneID>
    </ShippingZoneLocation>
  </Locations>
  <Name>sample string 3</Name>
  <Priority>4</Priority>
  <StoreID>2</StoreID>
</ShippingZone>