Shipping Zones

Manage geographic shipping zones for delivery services. Group countries and regions to apply specific shipping methods and rates based on destination.

Basic CRUD Actions

Get Shipping Zones listing

View on Postman

Get a list of all shipping zones.

JavaScript

let shippingZones = await Client.API.Core.ShippingZones.all();

TypeScript

import { Response, ShippingZones } from "@tscommerce/sdk-typescript"

Client.API.Core.ShippingZones.all().then((response:Response<ShippingZones>) => {
    response.resource.forEach((zone) => {
        console.log(zone.id, zone.name, zone.countries);
    });
});

PHP

$shippingZones = $client->API->Core->ShippingZones->all();

Create new Shipping Zone

View on Postman

Create a new geographic shipping zone.

JavaScript

const payload = {
    name: 'European Union',
    countries: ['IT', 'FR', 'DE', 'ES'],
    enabled: true
};
let shippingZone = await Client.API.Core.ShippingZones.create(payload);

TypeScript

import { Response, ShippingZone, CreateShippingZonePayload } from "@tscommerce/sdk-typescript"

const payload:CreateShippingZonePayload = {
    name: 'European Union',
    countries: ['IT', 'FR', 'DE', 'ES'],
    enabled: true
};

Client.API.Core.ShippingZones.create(payload).then((response:Response<ShippingZone>) => {
    console.log('Created shipping zone:', response.resource);
});

PHP

$payload = [
    'name' => 'European Union',
    'countries' => ['IT', 'FR', 'DE', 'ES'],
    'enabled' => true
];
$shippingZone = $client->API->Core->ShippingZones->create($payload);

Get Shipping Zone

View on Postman

Get an existing shipping zone by ID.

JavaScript

const shippingZoneId = 123;
let shippingZone = await Client.API.Core.ShippingZones.read(shippingZoneId);

TypeScript

import { Response, ShippingZone } from "@tscommerce/sdk-typescript"

const shippingZoneId:ShippingZone['id'] = 123;
Client.API.Core.ShippingZones.read(shippingZoneId).then((response:Response<ShippingZone>) => {
    console.log('Shipping zone:', response.resource);
});

PHP

$shippingZoneId = 123;
$shippingZone = $client->API->Core->ShippingZones->read($shippingZoneId);

Update Shipping Zone

View on Postman

Update an existing shipping zone.

JavaScript

const shippingZoneId = 123;
const payload = {
    countries: ['IT', 'FR', 'DE', 'ES', 'PT']
};
let shippingZone = await Client.API.Core.ShippingZones.update(shippingZoneId, payload);

TypeScript

import { Response, ShippingZone, UpdateShippingZonePayload } from "@tscommerce/sdk-typescript"

const shippingZoneId:ShippingZone['id'] = 123;
const payload:UpdateShippingZonePayload = {
    countries: ['IT', 'FR', 'DE', 'ES', 'PT']
};

Client.API.Core.ShippingZones.update(shippingZoneId, payload).then((response:Response<ShippingZone>) => {
    console.log('Updated shipping zone:', response.resource);
});

PHP

$shippingZoneId = 123;
$payload = ['countries' => ['IT', 'FR', 'DE', 'ES', 'PT']];
$shippingZone = $client->API->Core->ShippingZones->update($shippingZoneId, $payload);

Delete Shipping Zone

View on Postman

Delete a shipping zone.

JavaScript

const shippingZoneId = 123;
Client.API.Core.ShippingZones.delete(shippingZoneId);

TypeScript

import { Response, ShippingZone } from "@tscommerce/sdk-typescript"

const shippingZoneId:ShippingZone['id'] = 123;
Client.API.Core.ShippingZones.delete(shippingZoneId).then((response:Response) => {
    console.log('Shipping zone deleted successfully');
});

PHP

$shippingZoneId = 123;
$client->API->Core->ShippingZones->delete($shippingZoneId);

Bulk Actions

Bulk delete Shipping Zones

View on Postman

Delete multiple shipping zones at once.

JavaScript

const shippingZoneIds = [123, 456, 789];
Client.API.Core.ShippingZones.bulkDelete({ ids: shippingZoneIds });

TypeScript

import { Response, BulkDeleteShippingZonePayload } from "@tscommerce/sdk-typescript"

const payload:BulkDeleteShippingZonePayload = {
    ids: [123, 456, 789]
};

Client.API.Core.ShippingZones.bulkDelete(payload).then((response:Response) => {
    console.log('Shipping zones deleted successfully');
});

PHP

$payload = ['ids' => [123, 456, 789]];
$client->API->Core->ShippingZones->bulkDelete($payload);