Shipping Methods

Manage delivery options and shipping methods for your store. Configure standard, express, and custom shipping services with pricing, delivery times, and availability rules.

Basic CRUD Actions

Get Shipping Methods listing

View on Postman

Get a list of all shipping methods.

JavaScript

let shippingMethods = await Client.API.Core.ShippingMethods.all();

TypeScript

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

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

PHP

$shippingMethods = $client->API->Core->ShippingMethods->all();

Create new Shipping Method

View on Postman

Create a new shipping option.

JavaScript

const payload = {
    name: 'Express Delivery',
    description: 'Next-day delivery service',
    price: 9.99,
    delivery_time: '1-2 business days'
};
let shippingMethod = await Client.API.Core.ShippingMethods.create(payload);

TypeScript

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

const payload:CreateShippingMethodPayload = {
    name: 'Express Delivery',
    description: 'Next-day delivery service',
    price: 9.99,
    delivery_time: '1-2 business days'
};

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

PHP

$payload = [
    'name' => 'Express Delivery',
    'description' => 'Next-day delivery service',
    'price' => 9.99,
    'delivery_time' => '1-2 business days'
];
$shippingMethod = $client->API->Core->ShippingMethods->create($payload);

Get Shipping Method

View on Postman

Get an existing shipping method by ID.

JavaScript

const shippingMethodId = 123;
let shippingMethod = await Client.API.Core.ShippingMethods.read(shippingMethodId);

TypeScript

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

const shippingMethodId:ShippingMethod['id'] = 123;
Client.API.Core.ShippingMethods.read(shippingMethodId).then((response:Response<ShippingMethod>) => {
    console.log('Shipping method:', response.resource);
});

PHP

$shippingMethodId = 123;
$shippingMethod = $client->API->Core->ShippingMethods->read($shippingMethodId);

Update Shipping Method

View on Postman

Update an existing shipping method.

JavaScript

const shippingMethodId = 123;
const payload = {
    price: 12.99
};
let shippingMethod = await Client.API.Core.ShippingMethods.update(shippingMethodId, payload);

TypeScript

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

const shippingMethodId:ShippingMethod['id'] = 123;
const payload:UpdateShippingMethodPayload = {
    price: 12.99
};

Client.API.Core.ShippingMethods.update(shippingMethodId, payload).then((response:Response<ShippingMethod>) => {
    console.log('Updated shipping method:', response.resource);
});

PHP

$shippingMethodId = 123;
$payload = ['price' => 12.99];
$shippingMethod = $client->API->Core->ShippingMethods->update($shippingMethodId, $payload);

Delete Shipping Method

View on Postman

Delete a shipping method.

JavaScript

const shippingMethodId = 123;
Client.API.Core.ShippingMethods.delete(shippingMethodId);

TypeScript

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

const shippingMethodId:ShippingMethod['id'] = 123;
Client.API.Core.ShippingMethods.delete(shippingMethodId).then((response:Response) => {
    console.log('Shipping method deleted successfully');
});

PHP

$shippingMethodId = 123;
$client->API->Core->ShippingMethods->delete($shippingMethodId);

Duplication

Duplicate Shipping Method

View on Postman

Create a copy of an existing shipping method.

JavaScript

const shippingMethodId = 123;
let duplicate = await Client.API.Core.ShippingMethods.duplicate(shippingMethodId);

TypeScript

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

const shippingMethodId:ShippingMethod['id'] = 123;
Client.API.Core.ShippingMethods.duplicate(shippingMethodId).then((response:Response<ShippingMethod>) => {
    console.log('Duplicated shipping method ID:', response.resource.id);
});

PHP

$shippingMethodId = 123;
$duplicate = $client->API->Core->ShippingMethods->duplicate($shippingMethodId);

Bulk Actions

Bulk delete Shipping Methods

View on Postman

Delete multiple shipping methods at once.

JavaScript

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

TypeScript

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

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

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

PHP

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

Search

Search Shipping Methods

View on Postman

Search shipping methods by name or attributes.

JavaScript

const query = 'express';
let results = await Client.API.Core.ShippingMethods.search({ query });

TypeScript

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

const payload:SearchShippingMethodsPayload = {
    query: 'express'
};

Client.API.Core.ShippingMethods.search(payload).then((response:Response<ShippingMethods>) => {
    response.resource.forEach((method) => {
        console.log(method.name, method.price);
    });
});

PHP

$payload = ['query' => 'express'];
$results = $client->API->Core->ShippingMethods->search($payload);