Open API v2 / eCommerce / eCommerce Shipping Options
eCommerce Shipping Options
→
Every request needs a bearer token: Authorization: Bearer <token>. Base URL https://your-site.webinone.com. New to field types? See the type reference.
Retrieves a list of shipping options by using a "where" filtering
Parameters
Wherestring · query
JSON filter expression. Combine operators ($eq, $contains, $gt, $in, …) with $and / $or.
Order_Bystring · query
Sort field. Prefix with - for descending; comma-separate for tie-breakers.
Semantic_Querystring · query
Natural-language search, ranked by relevance.
Min_Scorenumber · query
Lowest relevance score to include when using Semantic_Query.
Offsetinteger · query
Number of items to skip before returning results. Defaults to 0.
Limitinteger · query
Maximum number of items to return. Defaults to 100.
Response
Idinteger
Internal system ID of the service. Read-only.
Namestring · nullable
The descriptive name of the shipping option that will be displayed in the shopping cart shipping dropdown.
Pricenumber
A per order value representing the starting/base price of the shipping option (further values as per below 'Settings' may be calculated along with this price).
IsEnabledboolean
Is this method active for customer selection.
CurrencyCountrystring · nullable
The currency-and-country market this shipping option is offered in.
Currencystring · nullable
The currency setting in which the shipping option is to be used.
Countrystring · nullable
The currency setting in which the shipping option is to be used.
Typeenum
Numeric identifier of the service category. Possible values: UserDefined, AustraliaPost, FedEx, UPS, USPS, DHL, CanadaPost, NewZealandPost.Possible values: UserDefinedAustraliaPostFedExUPSUSPSDHLCanadaPostNewZealandPost
TaxIdinteger
The tax ID that is applied to the shipping cost.
TaxNeverAppliesboolean
When checked, tax calculations will not be applied to this Shipping Option within the eCommerce system.
ChosenShippingProviderServicesarray of integers
When checked, tax calculations will not be applied to this Shipping Option within the eCommerce system.
ProviderSettingsobject · nullable
Additional serialized settings (usually a JSON or XML string).
ShippingSettingsobject
Rules and restrictions that govern when this option appears in the cart and how its cost is calculated, such as handling charges, weight and size limits, order-value ranges, and allowed customer types and countries.
Servicesarray of objects
This is an array of specific delivery types.
Idinteger
Internal system ID of the service. Read-only.
Codestring · nullable
Technical code (e.g. Dhl_express or np_warehouse) that is sent to the provider's API.
DisplayNamestring · nullable
Display name of the shipping settings service, shown to users.
Descriptionstring · nullable
Description of conditions.
Typeinteger
Numeric identifier of the service category.
AccountTypesarray of objects
This is an array of specific delivery types.
DisplayNamestring · nullable
Display name of the base display, shown to users.
Valuestring · nullable
The packaging dimensions identifier used for cost calculation.
DeliveryConfirmationsarray of objects
Methods of verifying that the customer has received the goods.
DisplayNamestring · nullable
Display name of the base display, shown to users.
Valuestring · nullable
The packaging dimensions identifier used for cost calculation.
PackageTypearray of objects
Allowed shipment formats.
DisplayNamestring · nullable
Display name of the base display, shown to users.
Valuestring · nullable
The packaging dimensions identifier used for cost calculation.
Settingsobject
This is a set of rules and restrictions that determine when and how a shipping method appears in the cart.
HandlingChargenumber
This is a fixed amount for processing the entire order.
AdditionalPerItemHandlingChargenumber
This is an additional fee for each unit of goods in the order.
MinWeightnumber
Physical limitations of the package (weight and dimensions) under which this method is available.
MaxWeightnumber
Physical limitations of the package (weight and dimensions) under which this method is available.
MinWidthnumber
Physical limitations of the package (weight and dimensions) under which this method is available.
MaxWidthnumber
Physical limitations of the package (weight and dimensions) under which this method is available.
MinHeightnumber
Physical limitations of the package (weight and dimensions) under which this method is available.
MaxHeightnumber
Physical limitations of the package (weight and dimensions) under which this method is available.
MinDepthnumber
Physical limitations of the package (weight and dimensions) under which this method is available.
MaxDepthnumber
Physical limitations of the package (weight and dimensions) under which this method is available.
MinOrderPricenumber
Cart value range.
MaxOrderPricenumber
Cart value range.
AllowedCustomersTypesarray of integers
An array of customer group IDs (for example, only for "B2B" or "VIP").
LimitDeliveryFollowingCountriesarray of strings
List of country codes to which delivery is made by this method.
ExcludeShippingForCatalogsarray of integers
List of product category IDs for which this method is not available.
curl "https://your-site.webinone.com/api/v2/admin/shipping-options" \ -H "Authorization: Bearer <token>"
await fetch("https://your-site.webinone.com/api/v2/admin/shipping-options", { method: "GET", headers: { "Authorization": "Bearer <token>" } });
import requests requests.get( "https://your-site.webinone.com/api/v2/admin/shipping-options", headers={"Authorization": "Bearer <token>"} )
$client = new GuzzleHttp\Client(); $response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/shipping-options', [ 'headers' => [ 'Authorization' => 'Bearer <token>' ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Get, "https://your-site.webinone.com/api/v2/admin/shipping-options"); request.Headers.Add("Authorization", "Bearer <token>"); var response = await client.SendAsync(request);
Response · 200
{
"Items": [
{
"Id": 1,
"Name": "Example",
"Price": 0,
"IsEnabled": false,
"CurrencyCountry": "USD",
"Currency": "USD",
"Country": "string",
"Type": "UserDefined",
"TaxId": 1,
"TaxNeverApplies": false,
"ChosenShippingProviderServices": [
0
],
"ProviderSettings": "string",
"ShippingSettings": {
"Services": [
{
"Id": 1,
"Code": "string",
"DisplayName": "Example",
"Description": "string",
"Type": 0
}
],
"AccountTypes": [
{
"DisplayName": "Example",
"Value": "string"
}
],
"DeliveryConfirmations": [
{
"DisplayName": "Example",
"Value": "string"
}
],
"PackageType": [
{
"DisplayName": "Example",
"Value": "string"
}
]
},
"Settings": {
"HandlingCharge": 0,
"AdditionalPerItemHandlingCharge": 0,
"MinWeight": 10,
"MaxWeight": 10,
"MinWidth": 0,
"MaxWidth": 0,
"MinHeight": 0,
"MaxHeight": 0,
"MinDepth": 0,
"MaxDepth": 0,
"MinOrderPrice": 0,
"MaxOrderPrice": 0,
"AllowedCustomersTypes": [
0
],
"LimitDeliveryFollowingCountries": [
"string"
],
"ExcludeShippingForCatalogs": [
0
]
}
}
],
"TotalItemsCount": 0
}Creates a new shipping option
Body parameters
Namestringrequired
The descriptive name of the shipping option that will be displayed in the shopping cart shipping dropdown.
Pricenumber
A per order value representing the starting/base price of the shipping option (further values as per below 'Settings' may be calculated along with this price).
IsEnabledboolean
Is this method active for customer selection.
Currencystring · nullable
The currency setting in which the shipping option is to be used.
Countrystring · nullable
The currency setting in which the shipping option is to be used.
Typeenum
Provider type. Possible values: UserDefined, AustraliaPost, FedEx, UPS, USPS, DHL, CanadaPost, NewZealandPost.Possible values: UserDefinedAustraliaPostFedExUPSUSPSDHLCanadaPostNewZealandPost
TaxIdinteger
The tax ID that is applied to the shipping cost.
TaxNeverAppliesboolean
When checked, tax calculations will not be applied to this Shipping Option within the eCommerce system. Available for all types except User Defined.
ChosenShippingProviderServicesarray of integers
When checked, tax calculations will not be applied to this Shipping Option within the eCommerce system. Available for all types except User Defined.
ProviderSettingsobject · nullable
Additional serialized settings (usually a JSON or XML string).
Settingsobject
This is a set of rules and restrictions that determine when and how a shipping method appears in the cart.
HandlingChargenumber
This is a fixed amount for processing the entire order.
AdditionalPerItemHandlingChargenumber
This is an additional fee for each unit of goods in the order.
MinWeightnumber
Physical limitations of the package (weight and dimensions) under which this method is available.
MaxWeightnumber
Physical limitations of the package (weight and dimensions) under which this method is available.
MinWidthnumber
Physical limitations of the package (weight and dimensions) under which this method is available.
MaxWidthnumber
Physical limitations of the package (weight and dimensions) under which this method is available.
MinHeightnumber
Physical limitations of the package (weight and dimensions) under which this method is available.
MaxHeightnumber
Physical limitations of the package (weight and dimensions) under which this method is available.
MinDepthnumber
Physical limitations of the package (weight and dimensions) under which this method is available.
MaxDepthnumber
Physical limitations of the package (weight and dimensions) under which this method is available.
MinOrderPricenumber
Cart value range.
MaxOrderPricenumber
Cart value range.
AllowedCustomersTypesarray of integers
An array of customer group IDs (for example, only for "B2B" or "VIP").
LimitDeliveryFollowingCountriesarray of strings
List of country codes to which delivery is made by this method.
ExcludeShippingForCatalogsarray of integers
List of product category IDs for which this method is not available.
Response
Idinteger
Internal system ID of the service. Read-only.
Namestring · nullable
The descriptive name of the shipping option that will be displayed in the shopping cart shipping dropdown.
Pricenumber
A per order value representing the starting/base price of the shipping option (further values as per below 'Settings' may be calculated along with this price).
IsEnabledboolean
Is this method active for customer selection.
CurrencyCountrystring · nullable
The currency-and-country market this shipping option is offered in.
Currencystring · nullable
The currency setting in which the shipping option is to be used.
Countrystring · nullable
The currency setting in which the shipping option is to be used.
Typeenum
Numeric identifier of the service category. Possible values: UserDefined, AustraliaPost, FedEx, UPS, USPS, DHL, CanadaPost, NewZealandPost.Possible values: UserDefinedAustraliaPostFedExUPSUSPSDHLCanadaPostNewZealandPost
TaxIdinteger
The tax ID that is applied to the shipping cost.
TaxNeverAppliesboolean
When checked, tax calculations will not be applied to this Shipping Option within the eCommerce system.
ChosenShippingProviderServicesarray of integers
When checked, tax calculations will not be applied to this Shipping Option within the eCommerce system.
ProviderSettingsobject · nullable
Additional serialized settings (usually a JSON or XML string).
ShippingSettingsobject
Rules and restrictions that govern when this option appears in the cart and how its cost is calculated, such as handling charges, weight and size limits, order-value ranges, and allowed customer types and countries.
Servicesarray of objects
This is an array of specific delivery types.
Idinteger
Internal system ID of the service. Read-only.
Codestring · nullable
Technical code (e.g. Dhl_express or np_warehouse) that is sent to the provider's API.
DisplayNamestring · nullable
Display name of the shipping settings service, shown to users.
Descriptionstring · nullable
Description of conditions.
Typeinteger
Numeric identifier of the service category.
AccountTypesarray of objects
This is an array of specific delivery types.
DisplayNamestring · nullable
Display name of the base display, shown to users.
Valuestring · nullable
The packaging dimensions identifier used for cost calculation.
DeliveryConfirmationsarray of objects
Methods of verifying that the customer has received the goods.
DisplayNamestring · nullable
Display name of the base display, shown to users.
Valuestring · nullable
The packaging dimensions identifier used for cost calculation.
PackageTypearray of objects
Allowed shipment formats.
DisplayNamestring · nullable
Display name of the base display, shown to users.
Valuestring · nullable
The packaging dimensions identifier used for cost calculation.
Settingsobject
This is a set of rules and restrictions that determine when and how a shipping method appears in the cart.
HandlingChargenumber
This is a fixed amount for processing the entire order.
AdditionalPerItemHandlingChargenumber
This is an additional fee for each unit of goods in the order.
MinWeightnumber
Physical limitations of the package (weight and dimensions) under which this method is available.
MaxWeightnumber
Physical limitations of the package (weight and dimensions) under which this method is available.
MinWidthnumber
Physical limitations of the package (weight and dimensions) under which this method is available.
MaxWidthnumber
Physical limitations of the package (weight and dimensions) under which this method is available.
MinHeightnumber
Physical limitations of the package (weight and dimensions) under which this method is available.
MaxHeightnumber
Physical limitations of the package (weight and dimensions) under which this method is available.
MinDepthnumber
Physical limitations of the package (weight and dimensions) under which this method is available.
MaxDepthnumber
Physical limitations of the package (weight and dimensions) under which this method is available.
MinOrderPricenumber
Cart value range.
MaxOrderPricenumber
Cart value range.
AllowedCustomersTypesarray of integers
An array of customer group IDs (for example, only for "B2B" or "VIP").
LimitDeliveryFollowingCountriesarray of strings
List of country codes to which delivery is made by this method.
ExcludeShippingForCatalogsarray of integers
List of product category IDs for which this method is not available.
curl -X POST "https://your-site.webinone.com/api/v2/admin/shipping-options" \ -H "Authorization: Bearer <token>" \ -H "Content-Type: application/json" \ -d '{"Name":"Example","Price":0,"IsEnabled":false,"Currency":"USD","Country":"string","Type":"UserDefined","TaxId":1,"TaxNeverApplies":false,"ChosenShippingProviderServices":[0],"ProviderSettings":"string","Settings":{"HandlingCharge":0,"AdditionalPerItemHandlingCharge":0,"MinWeight":10,"MaxWeight":10,"MinWidth":0,"MaxWidth":0,"MinHeight":0,"MaxHeight":0,"MinDepth":0,"MaxDepth":0,"MinOrderPrice":0,"MaxOrderPrice":0,"AllowedCustomersTypes":[0],"LimitDeliveryFollowingCountries":["string"],"ExcludeShippingForCatalogs":[0]}}'
await fetch("https://your-site.webinone.com/api/v2/admin/shipping-options", { method: "POST", headers: { "Authorization": "Bearer <token>", "Content-Type": "application/json" }, body: JSON.stringify({ "Name": "Example", "Price": 0, "IsEnabled": false, "Currency": "USD", "Country": "string", "Type": "UserDefined", "TaxId": 1, "TaxNeverApplies": false, "ChosenShippingProviderServices": [ 0 ], "ProviderSettings": "string", "Settings": { "HandlingCharge": 0, "AdditionalPerItemHandlingCharge": 0, "MinWeight": 10, "MaxWeight": 10, "MinWidth": 0, "MaxWidth": 0, "MinHeight": 0, "MaxHeight": 0, "MinDepth": 0, "MaxDepth": 0, "MinOrderPrice": 0, "MaxOrderPrice": 0, "AllowedCustomersTypes": [ 0 ], "LimitDeliveryFollowingCountries": [ "string" ], "ExcludeShippingForCatalogs": [ 0 ] } }) });
import requests requests.post( "https://your-site.webinone.com/api/v2/admin/shipping-options", headers={"Authorization": "Bearer <token>"}, json={ "Name": "Example", "Price": 0, "IsEnabled": False, "Currency": "USD", "Country": "string", "Type": "UserDefined", "TaxId": 1, "TaxNeverApplies": False, "ChosenShippingProviderServices": [0], "ProviderSettings": "string", "Settings": { "HandlingCharge": 0, "AdditionalPerItemHandlingCharge": 0, "MinWeight": 10, "MaxWeight": 10, "MinWidth": 0, "MaxWidth": 0, "MinHeight": 0, "MaxHeight": 0, "MinDepth": 0, "MaxDepth": 0, "MinOrderPrice": 0, "MaxOrderPrice": 0, "AllowedCustomersTypes": [0], "LimitDeliveryFollowingCountries": ["string"], "ExcludeShippingForCatalogs": [0] } } )
$client = new GuzzleHttp\Client(); $response = $client->request('POST', 'https://your-site.webinone.com/api/v2/admin/shipping-options', [ 'headers' => [ 'Authorization' => 'Bearer <token>', 'Content-Type' => 'application/json' ], 'json' => [ 'Name' => 'Example', 'Price' => 0, 'IsEnabled' => false, 'Currency' => 'USD', 'Country' => 'string', 'Type' => 'UserDefined', 'TaxId' => 1, 'TaxNeverApplies' => false, 'ChosenShippingProviderServices' => [0], 'ProviderSettings' => 'string', 'Settings' => [ 'HandlingCharge' => 0, 'AdditionalPerItemHandlingCharge' => 0, 'MinWeight' => 10, 'MaxWeight' => 10, 'MinWidth' => 0, 'MaxWidth' => 0, 'MinHeight' => 0, 'MaxHeight' => 0, 'MinDepth' => 0, 'MaxDepth' => 0, 'MinOrderPrice' => 0, 'MaxOrderPrice' => 0, 'AllowedCustomersTypes' => [0], 'LimitDeliveryFollowingCountries' => ['string'], 'ExcludeShippingForCatalogs' => [0] ] ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Post, "https://your-site.webinone.com/api/v2/admin/shipping-options"); request.Headers.Add("Authorization", "Bearer <token>"); request.Content = new StringContent( "{\"Name\":\"Example\",\"Price\":0,\"IsEnabled\":false,\"Currency\":\"USD\",\"Country\":\"string\",\"Type\":\"UserDefined\",\"TaxId\":1,\"TaxNeverApplies\":false,\"ChosenShippingProviderServices\":[0],\"ProviderSettings\":\"string\",\"Settings\":{\"HandlingCharge\":0,\"AdditionalPerItemHandlingCharge\":0,\"MinWeight\":10,\"MaxWeight\":10,\"MinWidth\":0,\"MaxWidth\":0,\"MinHeight\":0,\"MaxHeight\":0,\"MinDepth\":0,\"MaxDepth\":0,\"MinOrderPrice\":0,\"MaxOrderPrice\":0,\"AllowedCustomersTypes\":[0],\"LimitDeliveryFollowingCountries\":[\"string\"],\"ExcludeShippingForCatalogs\":[0]}}", Encoding.UTF8, "application/json"); var response = await client.SendAsync(request);
Response · 200
{
"Id": 1,
"Name": "Example",
"Price": 0,
"IsEnabled": false,
"CurrencyCountry": "USD",
"Currency": "USD",
"Country": "string",
"Type": "UserDefined",
"TaxId": 1,
"TaxNeverApplies": false,
"ChosenShippingProviderServices": [
0
],
"ProviderSettings": "string",
"ShippingSettings": {
"Services": [
{
"Id": 1,
"Code": "string",
"DisplayName": "Example",
"Description": "string",
"Type": 0
}
],
"AccountTypes": [
{
"DisplayName": "Example",
"Value": "string"
}
],
"DeliveryConfirmations": [
{
"DisplayName": "Example",
"Value": "string"
}
],
"PackageType": [
{
"DisplayName": "Example",
"Value": "string"
}
]
},
"Settings": {
"HandlingCharge": 0,
"AdditionalPerItemHandlingCharge": 0,
"MinWeight": 10,
"MaxWeight": 10,
"MinWidth": 0,
"MaxWidth": 0,
"MinHeight": 0,
"MaxHeight": 0,
"MinDepth": 0,
"MaxDepth": 0,
"MinOrderPrice": 0,
"MaxOrderPrice": 0,
"AllowedCustomersTypes": [
0
],
"LimitDeliveryFollowingCountries": [
"string"
],
"ExcludeShippingForCatalogs": [
0
]
}
}Retrieves a single shipping option
Parameters
idinteger · pathrequired
Shipping option id.
Response
Idinteger
Internal system ID of the service. Read-only.
Namestring · nullable
The descriptive name of the shipping option that will be displayed in the shopping cart shipping dropdown.
Pricenumber
A per order value representing the starting/base price of the shipping option (further values as per below 'Settings' may be calculated along with this price).
IsEnabledboolean
Is this method active for customer selection.
CurrencyCountrystring · nullable
The currency-and-country market this shipping option is offered in.
Currencystring · nullable
The currency setting in which the shipping option is to be used.
Countrystring · nullable
The currency setting in which the shipping option is to be used.
Typeenum
Numeric identifier of the service category. Possible values: UserDefined, AustraliaPost, FedEx, UPS, USPS, DHL, CanadaPost, NewZealandPost.Possible values: UserDefinedAustraliaPostFedExUPSUSPSDHLCanadaPostNewZealandPost
TaxIdinteger
The tax ID that is applied to the shipping cost.
TaxNeverAppliesboolean
When checked, tax calculations will not be applied to this Shipping Option within the eCommerce system.
ChosenShippingProviderServicesarray of integers
When checked, tax calculations will not be applied to this Shipping Option within the eCommerce system.
ProviderSettingsobject · nullable
Additional serialized settings (usually a JSON or XML string).
ShippingSettingsobject
Rules and restrictions that govern when this option appears in the cart and how its cost is calculated, such as handling charges, weight and size limits, order-value ranges, and allowed customer types and countries.
Servicesarray of objects
This is an array of specific delivery types.
Idinteger
Internal system ID of the service. Read-only.
Codestring · nullable
Technical code (e.g. Dhl_express or np_warehouse) that is sent to the provider's API.
DisplayNamestring · nullable
Display name of the shipping settings service, shown to users.
Descriptionstring · nullable
Description of conditions.
Typeinteger
Numeric identifier of the service category.
AccountTypesarray of objects
This is an array of specific delivery types.
DisplayNamestring · nullable
Display name of the base display, shown to users.
Valuestring · nullable
The packaging dimensions identifier used for cost calculation.
DeliveryConfirmationsarray of objects
Methods of verifying that the customer has received the goods.
DisplayNamestring · nullable
Display name of the base display, shown to users.
Valuestring · nullable
The packaging dimensions identifier used for cost calculation.
PackageTypearray of objects
Allowed shipment formats.
DisplayNamestring · nullable
Display name of the base display, shown to users.
Valuestring · nullable
The packaging dimensions identifier used for cost calculation.
Settingsobject
This is a set of rules and restrictions that determine when and how a shipping method appears in the cart.
HandlingChargenumber
This is a fixed amount for processing the entire order.
AdditionalPerItemHandlingChargenumber
This is an additional fee for each unit of goods in the order.
MinWeightnumber
Physical limitations of the package (weight and dimensions) under which this method is available.
MaxWeightnumber
Physical limitations of the package (weight and dimensions) under which this method is available.
MinWidthnumber
Physical limitations of the package (weight and dimensions) under which this method is available.
MaxWidthnumber
Physical limitations of the package (weight and dimensions) under which this method is available.
MinHeightnumber
Physical limitations of the package (weight and dimensions) under which this method is available.
MaxHeightnumber
Physical limitations of the package (weight and dimensions) under which this method is available.
MinDepthnumber
Physical limitations of the package (weight and dimensions) under which this method is available.
MaxDepthnumber
Physical limitations of the package (weight and dimensions) under which this method is available.
MinOrderPricenumber
Cart value range.
MaxOrderPricenumber
Cart value range.
AllowedCustomersTypesarray of integers
An array of customer group IDs (for example, only for "B2B" or "VIP").
LimitDeliveryFollowingCountriesarray of strings
List of country codes to which delivery is made by this method.
ExcludeShippingForCatalogsarray of integers
List of product category IDs for which this method is not available.
curl "https://your-site.webinone.com/api/v2/admin/shipping-options/1" \ -H "Authorization: Bearer <token>"
await fetch("https://your-site.webinone.com/api/v2/admin/shipping-options/1", { method: "GET", headers: { "Authorization": "Bearer <token>" } });
import requests requests.get( "https://your-site.webinone.com/api/v2/admin/shipping-options/1", headers={"Authorization": "Bearer <token>"} )
$client = new GuzzleHttp\Client(); $response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/shipping-options/1', [ 'headers' => [ 'Authorization' => 'Bearer <token>' ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Get, "https://your-site.webinone.com/api/v2/admin/shipping-options/1"); request.Headers.Add("Authorization", "Bearer <token>"); var response = await client.SendAsync(request);
Response · 200
{
"Id": 1,
"Name": "Example",
"Price": 0,
"IsEnabled": false,
"CurrencyCountry": "USD",
"Currency": "USD",
"Country": "string",
"Type": "UserDefined",
"TaxId": 1,
"TaxNeverApplies": false,
"ChosenShippingProviderServices": [
0
],
"ProviderSettings": "string",
"ShippingSettings": {
"Services": [
{
"Id": 1,
"Code": "string",
"DisplayName": "Example",
"Description": "string",
"Type": 0
}
],
"AccountTypes": [
{
"DisplayName": "Example",
"Value": "string"
}
],
"DeliveryConfirmations": [
{
"DisplayName": "Example",
"Value": "string"
}
],
"PackageType": [
{
"DisplayName": "Example",
"Value": "string"
}
]
},
"Settings": {
"HandlingCharge": 0,
"AdditionalPerItemHandlingCharge": 0,
"MinWeight": 10,
"MaxWeight": 10,
"MinWidth": 0,
"MaxWidth": 0,
"MinHeight": 0,
"MaxHeight": 0,
"MinDepth": 0,
"MaxDepth": 0,
"MinOrderPrice": 0,
"MaxOrderPrice": 0,
"AllowedCustomersTypes": [
0
],
"LimitDeliveryFollowingCountries": [
"string"
],
"ExcludeShippingForCatalogs": [
0
]
}
}Updates an existing shipping option
Parameters
idinteger · pathrequired
Existent shipping option id.
Body parameters
Namestringrequired
The descriptive name of the shipping option that will be displayed in the shopping cart shipping dropdown.
Pricenumber
A per order value representing the starting/base price of the shipping option (further values as per below 'Settings' may be calculated along with this price).
IsEnabledboolean
Is this method active for customer selection.
Currencystring · nullable
The currency setting in which the shipping option is to be used.
Countrystring · nullable
The currency setting in which the shipping option is to be used.
Typeenum
Provider type. Possible values: UserDefined, AustraliaPost, FedEx, UPS, USPS, DHL, CanadaPost, NewZealandPost.Possible values: UserDefinedAustraliaPostFedExUPSUSPSDHLCanadaPostNewZealandPost
TaxIdinteger
The tax ID that is applied to the shipping cost.
TaxNeverAppliesboolean
When checked, tax calculations will not be applied to this Shipping Option within the eCommerce system. Available for all types except User Defined.
ChosenShippingProviderServicesarray of integers
When checked, tax calculations will not be applied to this Shipping Option within the eCommerce system. Available for all types except User Defined.
ProviderSettingsobject · nullable
Additional serialized settings (usually a JSON or XML string).
Settingsobject
This is a set of rules and restrictions that determine when and how a shipping method appears in the cart.
HandlingChargenumber
This is a fixed amount for processing the entire order.
AdditionalPerItemHandlingChargenumber
This is an additional fee for each unit of goods in the order.
MinWeightnumber
Physical limitations of the package (weight and dimensions) under which this method is available.
MaxWeightnumber
Physical limitations of the package (weight and dimensions) under which this method is available.
MinWidthnumber
Physical limitations of the package (weight and dimensions) under which this method is available.
MaxWidthnumber
Physical limitations of the package (weight and dimensions) under which this method is available.
MinHeightnumber
Physical limitations of the package (weight and dimensions) under which this method is available.
MaxHeightnumber
Physical limitations of the package (weight and dimensions) under which this method is available.
MinDepthnumber
Physical limitations of the package (weight and dimensions) under which this method is available.
MaxDepthnumber
Physical limitations of the package (weight and dimensions) under which this method is available.
MinOrderPricenumber
Cart value range.
MaxOrderPricenumber
Cart value range.
AllowedCustomersTypesarray of integers
An array of customer group IDs (for example, only for "B2B" or "VIP").
LimitDeliveryFollowingCountriesarray of strings
List of country codes to which delivery is made by this method.
ExcludeShippingForCatalogsarray of integers
List of product category IDs for which this method is not available.
Response
Idinteger
Internal system ID of the service. Read-only.
Namestring · nullable
The descriptive name of the shipping option that will be displayed in the shopping cart shipping dropdown.
Pricenumber
A per order value representing the starting/base price of the shipping option (further values as per below 'Settings' may be calculated along with this price).
IsEnabledboolean
Is this method active for customer selection.
CurrencyCountrystring · nullable
The currency-and-country market this shipping option is offered in.
Currencystring · nullable
The currency setting in which the shipping option is to be used.
Countrystring · nullable
The currency setting in which the shipping option is to be used.
Typeenum
Numeric identifier of the service category. Possible values: UserDefined, AustraliaPost, FedEx, UPS, USPS, DHL, CanadaPost, NewZealandPost.Possible values: UserDefinedAustraliaPostFedExUPSUSPSDHLCanadaPostNewZealandPost
TaxIdinteger
The tax ID that is applied to the shipping cost.
TaxNeverAppliesboolean
When checked, tax calculations will not be applied to this Shipping Option within the eCommerce system.
ChosenShippingProviderServicesarray of integers
When checked, tax calculations will not be applied to this Shipping Option within the eCommerce system.
ProviderSettingsobject · nullable
Additional serialized settings (usually a JSON or XML string).
ShippingSettingsobject
Rules and restrictions that govern when this option appears in the cart and how its cost is calculated, such as handling charges, weight and size limits, order-value ranges, and allowed customer types and countries.
Servicesarray of objects
This is an array of specific delivery types.
Idinteger
Internal system ID of the service. Read-only.
Codestring · nullable
Technical code (e.g. Dhl_express or np_warehouse) that is sent to the provider's API.
DisplayNamestring · nullable
Display name of the shipping settings service, shown to users.
Descriptionstring · nullable
Description of conditions.
Typeinteger
Numeric identifier of the service category.
AccountTypesarray of objects
This is an array of specific delivery types.
DisplayNamestring · nullable
Display name of the base display, shown to users.
Valuestring · nullable
The packaging dimensions identifier used for cost calculation.
DeliveryConfirmationsarray of objects
Methods of verifying that the customer has received the goods.
DisplayNamestring · nullable
Display name of the base display, shown to users.
Valuestring · nullable
The packaging dimensions identifier used for cost calculation.
PackageTypearray of objects
Allowed shipment formats.
DisplayNamestring · nullable
Display name of the base display, shown to users.
Valuestring · nullable
The packaging dimensions identifier used for cost calculation.
Settingsobject
This is a set of rules and restrictions that determine when and how a shipping method appears in the cart.
HandlingChargenumber
This is a fixed amount for processing the entire order.
AdditionalPerItemHandlingChargenumber
This is an additional fee for each unit of goods in the order.
MinWeightnumber
Physical limitations of the package (weight and dimensions) under which this method is available.
MaxWeightnumber
Physical limitations of the package (weight and dimensions) under which this method is available.
MinWidthnumber
Physical limitations of the package (weight and dimensions) under which this method is available.
MaxWidthnumber
Physical limitations of the package (weight and dimensions) under which this method is available.
MinHeightnumber
Physical limitations of the package (weight and dimensions) under which this method is available.
MaxHeightnumber
Physical limitations of the package (weight and dimensions) under which this method is available.
MinDepthnumber
Physical limitations of the package (weight and dimensions) under which this method is available.
MaxDepthnumber
Physical limitations of the package (weight and dimensions) under which this method is available.
MinOrderPricenumber
Cart value range.
MaxOrderPricenumber
Cart value range.
AllowedCustomersTypesarray of integers
An array of customer group IDs (for example, only for "B2B" or "VIP").
LimitDeliveryFollowingCountriesarray of strings
List of country codes to which delivery is made by this method.
ExcludeShippingForCatalogsarray of integers
List of product category IDs for which this method is not available.
curl -X PUT "https://your-site.webinone.com/api/v2/admin/shipping-options/1" \ -H "Authorization: Bearer <token>" \ -H "Content-Type: application/json" \ -d '{"Name":"Example","Price":0,"IsEnabled":false,"Currency":"USD","Country":"string","Type":"UserDefined","TaxId":1,"TaxNeverApplies":false,"ChosenShippingProviderServices":[0],"ProviderSettings":"string","Settings":{"HandlingCharge":0,"AdditionalPerItemHandlingCharge":0,"MinWeight":10,"MaxWeight":10,"MinWidth":0,"MaxWidth":0,"MinHeight":0,"MaxHeight":0,"MinDepth":0,"MaxDepth":0,"MinOrderPrice":0,"MaxOrderPrice":0,"AllowedCustomersTypes":[0],"LimitDeliveryFollowingCountries":["string"],"ExcludeShippingForCatalogs":[0]}}'
await fetch("https://your-site.webinone.com/api/v2/admin/shipping-options/1", { method: "PUT", headers: { "Authorization": "Bearer <token>", "Content-Type": "application/json" }, body: JSON.stringify({ "Name": "Example", "Price": 0, "IsEnabled": false, "Currency": "USD", "Country": "string", "Type": "UserDefined", "TaxId": 1, "TaxNeverApplies": false, "ChosenShippingProviderServices": [ 0 ], "ProviderSettings": "string", "Settings": { "HandlingCharge": 0, "AdditionalPerItemHandlingCharge": 0, "MinWeight": 10, "MaxWeight": 10, "MinWidth": 0, "MaxWidth": 0, "MinHeight": 0, "MaxHeight": 0, "MinDepth": 0, "MaxDepth": 0, "MinOrderPrice": 0, "MaxOrderPrice": 0, "AllowedCustomersTypes": [ 0 ], "LimitDeliveryFollowingCountries": [ "string" ], "ExcludeShippingForCatalogs": [ 0 ] } }) });
import requests requests.put( "https://your-site.webinone.com/api/v2/admin/shipping-options/1", headers={"Authorization": "Bearer <token>"}, json={ "Name": "Example", "Price": 0, "IsEnabled": False, "Currency": "USD", "Country": "string", "Type": "UserDefined", "TaxId": 1, "TaxNeverApplies": False, "ChosenShippingProviderServices": [0], "ProviderSettings": "string", "Settings": { "HandlingCharge": 0, "AdditionalPerItemHandlingCharge": 0, "MinWeight": 10, "MaxWeight": 10, "MinWidth": 0, "MaxWidth": 0, "MinHeight": 0, "MaxHeight": 0, "MinDepth": 0, "MaxDepth": 0, "MinOrderPrice": 0, "MaxOrderPrice": 0, "AllowedCustomersTypes": [0], "LimitDeliveryFollowingCountries": ["string"], "ExcludeShippingForCatalogs": [0] } } )
$client = new GuzzleHttp\Client(); $response = $client->request('PUT', 'https://your-site.webinone.com/api/v2/admin/shipping-options/1', [ 'headers' => [ 'Authorization' => 'Bearer <token>', 'Content-Type' => 'application/json' ], 'json' => [ 'Name' => 'Example', 'Price' => 0, 'IsEnabled' => false, 'Currency' => 'USD', 'Country' => 'string', 'Type' => 'UserDefined', 'TaxId' => 1, 'TaxNeverApplies' => false, 'ChosenShippingProviderServices' => [0], 'ProviderSettings' => 'string', 'Settings' => [ 'HandlingCharge' => 0, 'AdditionalPerItemHandlingCharge' => 0, 'MinWeight' => 10, 'MaxWeight' => 10, 'MinWidth' => 0, 'MaxWidth' => 0, 'MinHeight' => 0, 'MaxHeight' => 0, 'MinDepth' => 0, 'MaxDepth' => 0, 'MinOrderPrice' => 0, 'MaxOrderPrice' => 0, 'AllowedCustomersTypes' => [0], 'LimitDeliveryFollowingCountries' => ['string'], 'ExcludeShippingForCatalogs' => [0] ] ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Put, "https://your-site.webinone.com/api/v2/admin/shipping-options/1"); request.Headers.Add("Authorization", "Bearer <token>"); request.Content = new StringContent( "{\"Name\":\"Example\",\"Price\":0,\"IsEnabled\":false,\"Currency\":\"USD\",\"Country\":\"string\",\"Type\":\"UserDefined\",\"TaxId\":1,\"TaxNeverApplies\":false,\"ChosenShippingProviderServices\":[0],\"ProviderSettings\":\"string\",\"Settings\":{\"HandlingCharge\":0,\"AdditionalPerItemHandlingCharge\":0,\"MinWeight\":10,\"MaxWeight\":10,\"MinWidth\":0,\"MaxWidth\":0,\"MinHeight\":0,\"MaxHeight\":0,\"MinDepth\":0,\"MaxDepth\":0,\"MinOrderPrice\":0,\"MaxOrderPrice\":0,\"AllowedCustomersTypes\":[0],\"LimitDeliveryFollowingCountries\":[\"string\"],\"ExcludeShippingForCatalogs\":[0]}}", Encoding.UTF8, "application/json"); var response = await client.SendAsync(request);
Response · 200
{
"Id": 1,
"Name": "Example",
"Price": 0,
"IsEnabled": false,
"CurrencyCountry": "USD",
"Currency": "USD",
"Country": "string",
"Type": "UserDefined",
"TaxId": 1,
"TaxNeverApplies": false,
"ChosenShippingProviderServices": [
0
],
"ProviderSettings": "string",
"ShippingSettings": {
"Services": [
{
"Id": 1,
"Code": "string",
"DisplayName": "Example",
"Description": "string",
"Type": 0
}
],
"AccountTypes": [
{
"DisplayName": "Example",
"Value": "string"
}
],
"DeliveryConfirmations": [
{
"DisplayName": "Example",
"Value": "string"
}
],
"PackageType": [
{
"DisplayName": "Example",
"Value": "string"
}
]
},
"Settings": {
"HandlingCharge": 0,
"AdditionalPerItemHandlingCharge": 0,
"MinWeight": 10,
"MaxWeight": 10,
"MinWidth": 0,
"MaxWidth": 0,
"MinHeight": 0,
"MaxHeight": 0,
"MinDepth": 0,
"MaxDepth": 0,
"MinOrderPrice": 0,
"MaxOrderPrice": 0,
"AllowedCustomersTypes": [
0
],
"LimitDeliveryFollowingCountries": [
"string"
],
"ExcludeShippingForCatalogs": [
0
]
}
}Deletes an existing shipping option
Parameters
idinteger · pathrequired
Existent shipping option id.
curl -X DELETE "https://your-site.webinone.com/api/v2/admin/shipping-options/1" \ -H "Authorization: Bearer <token>"
await fetch("https://your-site.webinone.com/api/v2/admin/shipping-options/1", { method: "DELETE", headers: { "Authorization": "Bearer <token>" } });
import requests requests.delete( "https://your-site.webinone.com/api/v2/admin/shipping-options/1", headers={"Authorization": "Bearer <token>"} )
$client = new GuzzleHttp\Client(); $response = $client->request('DELETE', 'https://your-site.webinone.com/api/v2/admin/shipping-options/1', [ 'headers' => [ 'Authorization' => 'Bearer <token>' ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Delete, "https://your-site.webinone.com/api/v2/admin/shipping-options/1"); request.Headers.Add("Authorization", "Bearer <token>"); var response = await client.SendAsync(request);
Retrieves a list of countries
Response
Idstring · nullable
Internal system ID of the service. Read-only.
Countrystring · nullable
The currency setting in which the shipping option is to be used.
Abbreviationstring · nullable
Standard two-letter code for the country (for example, US or AU).
curl "https://your-site.webinone.com/api/v2/admin/shipping-options/countries" \ -H "Authorization: Bearer <token>"
await fetch("https://your-site.webinone.com/api/v2/admin/shipping-options/countries", { method: "GET", headers: { "Authorization": "Bearer <token>" } });
import requests requests.get( "https://your-site.webinone.com/api/v2/admin/shipping-options/countries", headers={"Authorization": "Bearer <token>"} )
$client = new GuzzleHttp\Client(); $response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/shipping-options/countries', [ 'headers' => [ 'Authorization' => 'Bearer <token>' ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Get, "https://your-site.webinone.com/api/v2/admin/shipping-options/countries"); request.Headers.Add("Authorization", "Bearer <token>"); var response = await client.SendAsync(request);
Response · 200
[
{
"Id": "string",
"Country": "string",
"Abbreviation": "string"
}
]Retrieves a list of external shipping provider services
Parameters
Typestring · queryrequired
Type.
Response
Idinteger
Internal system ID of the service. Read-only.
Codestring · nullable
Technical code (e.g. Dhl_express or np_warehouse) that is sent to the provider's API.
DisplayNamestring · nullable
Display name of the shipping option provider service, shown to users.
Descriptionstring · nullable
Description of conditions.
Typeenum
Numeric identifier of the service category. Possible values: UserDefined, AustraliaPost, FedEx, UPS, USPS, DHL, CanadaPost, NewZealandPost.Possible values: UserDefinedAustraliaPostFedExUPSUSPSDHLCanadaPostNewZealandPost
curl "https://your-site.webinone.com/api/v2/admin/shipping-options/provider-services" \ -H "Authorization: Bearer <token>"
await fetch("https://your-site.webinone.com/api/v2/admin/shipping-options/provider-services", { method: "GET", headers: { "Authorization": "Bearer <token>" } });
import requests requests.get( "https://your-site.webinone.com/api/v2/admin/shipping-options/provider-services", headers={"Authorization": "Bearer <token>"} )
$client = new GuzzleHttp\Client(); $response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/shipping-options/provider-services', [ 'headers' => [ 'Authorization' => 'Bearer <token>' ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Get, "https://your-site.webinone.com/api/v2/admin/shipping-options/provider-services"); request.Headers.Add("Authorization", "Bearer <token>"); var response = await client.SendAsync(request);
Response · 200
[
{
"Id": 1,
"Code": "string",
"DisplayName": "Example",
"Description": "string",
"Type": "UserDefined"
}
]Retrieves a list of shipping provider settings
Parameters
Typestring · queryrequired
Type.
Response
ProviderSettingsTemplateobject · nullable
Template describing the credential and configuration fields required by the selected integrated shipping provider, used to render the provider's settings form.
AccountTypesarray of objects
This is an array of specific delivery types.
DisplayNamestring · nullable
Display name of the base display, shown to users.
Valuestring · nullable
The packaging dimensions identifier used for cost calculation.
DeliveryConfirmationsarray of objects
Methods of verifying that the customer has received the goods.
DisplayNamestring · nullable
Display name of the base display, shown to users.
Valuestring · nullable
The packaging dimensions identifier used for cost calculation.
PackageTypearray of objects
Allowed shipment formats.
DisplayNamestring · nullable
Display name of the base display, shown to users.
Valuestring · nullable
The packaging dimensions identifier used for cost calculation.
curl "https://your-site.webinone.com/api/v2/admin/shipping-options/provider-settings" \ -H "Authorization: Bearer <token>"
await fetch("https://your-site.webinone.com/api/v2/admin/shipping-options/provider-settings", { method: "GET", headers: { "Authorization": "Bearer <token>" } });
import requests requests.get( "https://your-site.webinone.com/api/v2/admin/shipping-options/provider-settings", headers={"Authorization": "Bearer <token>"} )
$client = new GuzzleHttp\Client(); $response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/shipping-options/provider-settings', [ 'headers' => [ 'Authorization' => 'Bearer <token>' ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Get, "https://your-site.webinone.com/api/v2/admin/shipping-options/provider-settings"); request.Headers.Add("Authorization", "Bearer <token>"); var response = await client.SendAsync(request);
Response · 200
{
"ProviderSettingsTemplate": "string",
"AccountTypes": [
{
"DisplayName": "Example",
"Value": "string"
}
],
"DeliveryConfirmations": [
{
"DisplayName": "Example",
"Value": "string"
}
],
"PackageType": [
{
"DisplayName": "Example",
"Value": "string"
}
]
}