Cmdlets for BigCommerce

Build 24.0.9060

ShippingMethods

Lists all shipping methods.

Table Specific Information

Select

The cmdlet uses the BigCommerce API to process WHERE clause conditions built with the following columns and operators:

  • Id supports the '=' comparison.
  • ZoneId supports the '=' comparison.

The rest of the filter is executed client-side within the cmdlet.

For example, the following query is processed server-side:

SELECT * FROM ShippingMethods

SELECT * FROM ShippingMethods WHERE ZoneId = 1

SELECT * FROM ShippingMethods WHERE ZoneId = 1 and Id = 1

Insert

To insert a new ShippingMethod, Name, Type, Settings and ZoneId are required to be inserted along with it. Settings has to be passed as a JSON Object.

INSERT INTO ShippingMethods (Name, Type, Enabled, ZoneId, HandlingFeesFixedSurcharge, Settings) VALUES ('Flat Rate 2', 'perorder', true, 1, 0, '{ "rate" : 7 }')

Update

To update a ShippingMethod, Name, Type, Settings, ZoneId and Id are required.
UPDATE ShippingMethods Set Name = 'Flat Rate 1', Type = 'perorder', Settings = '{ "rate" : 7 }', HandlingFeesPercentageSurcharge = 1 WHERE Id = 9 and ZoneId = 1

Delete

To delete a shipping method, Id and ZoneId are required.
DELETE FROM ShippingMethods WHERE Id = 9 and ZoneId = 1

Columns

Name Type ReadOnly References Description
Id [KEY] Integer True

Shipping Method Id.

Name String False

Shipping Method name.

Type String False

Shipping Method type.

Enabled Boolean False

Minimum subtotal of the free shipping.

HandlingFeesPercentageSurcharge Decimal False

Percentage surcharge of the handling fee.

HandlingFeesFixedSurcharge Decimal False

Fixed surcharge of the handling fee.

IsFallback Boolean True

Whether or not this shipping zone is the fallback if all others are not valid for the order.

Settings String False

Shipping method settings.

ZoneId Integer True

The Shipping Zone Id

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060