Contributors:
Ecommerce Shipping Options API
Create, Retrieve, Update and Delete Ecommerce Shipping Options via the public API endpoint as well as return external shipping providers and settings.
GET Ecommerce External Shipping Services List
Retrieves a list of External Shipping Providers as a JSON response based on your provided query parameters.
/api/v2/admin/shipping-options/provider-services
Data / Response:
{
"ShippingProviderType" : "string"
}
[
{
"Id": "19688",
"Code": "INT_PARCEL_COR_OWN_PACKAGING",
"DisplayName": "Courier (international)",
"Description": null,
"Type": "AustraliaPost"
},
{
"Id": "19689",
"Code": "INT_PARCEL_EXP_OWN_PACKAGING",
"DisplayName": "Express (international)",
"Description": null,
"Type": "AustraliaPost"
}
]
GET Ecommerce External Shipping Settings List
Retrieves a list of External Shipping Provider Settings as a JSON response based on your provided query parameters.
/api/v2/admin/shipping-options/provider-settings
Data / Response:
{
"ShippingProviderType" : "string"
}
{
}
//Object with fields for the specified ShippingProviderType
GET Ecommerce Shipping Options List
Retrieves a list of Shipping Options as a JSON response based on your provided query parameters.
/api/v2/admin/shipping-options
Data / Response:
{
"Where" : {},
"Order_By" : "Id",
"Offset" : 0,
"Limit" : 100,
}
{
"Items": [
{
"Id": 0,
"Name": "string",
"Price": 0,
"IsEnabled": true,
"CurrencyCountry": "string",
"Currency": "string",
"Country": "string",
"Type": 0,
"TaxId": 0,
"TaxNeverApplies": true,
"ChosenShippingProviderServices": [
0
],
"ProviderSettings": "string",
"ShippingSettings": {
"Services": [
{
"Id": 0,
"Code": "string",
"DisplayName": "string",
"Description": "string",
"Type": 0
}
],
"AccountTypes": [
{
"DisplayName": "string",
"Value": "string"
}
],
"DeliveryConfirmations": [
{
"DisplayName": "string",
"Value": "string"
}
],
"PackageType": [
{
"DisplayName": "string",
"Value": "string"
}
]
},
"Settings": {
"HandlingCharge": 0,
"AdditionalPerItemHandlingCharge": 0,
"MinWeight": 0,
"MaxWeight": 0,
"MinWidth": 0,
"MaxWidth": 0,
"MinHeight": 0,
"MaxHeight": 0,
"MinDepth": 0,
"MaxDepth": 0,
"MinOrderPrice": 0,
"MaxOrderPrice": 0,
"AllowedCustomersTypes": [
0
],
"LimitDeliveryFollowingCountries": [
"string"
],
"ExcludeShippingForCatalogs": [
0
]
}
}
],
"TotalItemsCount": 0
}
POST Ecommerce Shipping Option Create
Creates a new Shipping Option based on the provided data.
/api/v2/admin/shipping-options
Data / Response:
{
"Name": "string",
"Price": 0,
"IsEnabled": true,
"Currency": "string",
"Country": "string",
"Type": "string",
"TaxId": 0,
"TaxNeverApplies": true,
"ChosenShippingProviderServices": [
0
],
"ProviderSettings": "string",
"Settings": {
"HandlingCharge": 0,
"AdditionalPerItemHandlingCharge": 0,
"MinWeight": 0,
"MaxWeight": 0,
"MinWidth": 0,
"MaxWidth": 0,
"MinHeight": 0,
"MaxHeight": 0,
"MinDepth": 0,
"MaxDepth": 0,
"MinOrderPrice": 0,
"MaxOrderPrice": 0,
"AllowedCustomersTypes": [
0
],
"LimitDeliveryFollowingCountries": [
"string"
],
"ExcludeShippingForCatalogs": [
0
]
}
}
{
"Id": 0,
"Name": "string",
"Price": 0,
"IsEnabled": true,
"CurrencyCountry": "string",
"Currency": "string",
"Country": "string",
"Type": 0,
"TaxId": 0,
"TaxNeverApplies": true,
"ChosenShippingProviderServices": [
0
],
"ProviderSettings": "string",
"ShippingSettings": {
"Services": [
{
"Id": 0,
"Code": "string",
"DisplayName": "string",
"Description": "string",
"Type": 0
}
],
"AccountTypes": [
{
"DisplayName": "string",
"Value": "string"
}
],
"DeliveryConfirmations": [
{
"DisplayName": "string",
"Value": "string"
}
],
"PackageType": [
{
"DisplayName": "string",
"Value": "string"
}
]
},
"Settings": {
"HandlingCharge": 0,
"AdditionalPerItemHandlingCharge": 0,
"MinWeight": 0,
"MaxWeight": 0,
"MinWidth": 0,
"MaxWidth": 0,
"MinHeight": 0,
"MaxHeight": 0,
"MinDepth": 0,
"MaxDepth": 0,
"MinOrderPrice": 0,
"MaxOrderPrice": 0,
"AllowedCustomersTypes": [
0
],
"LimitDeliveryFollowingCountries": [
"string"
],
"ExcludeShippingForCatalogs": [
0
]
}
}
GET Ecommerce Shipping Option Item
Retrieves a single Shipping Option based on the ID passed in the endpoint URL.
/api/v2/admin/shipping-options/{id}
Data / Response:
N/A
{
"Id": 0,
"Name": "string",
"Price": 0,
"IsEnabled": true,
"CurrencyCountry": "string",
"Currency": "string",
"Country": "string",
"Type": 0,
"TaxId": 0,
"TaxNeverApplies": true,
"ChosenShippingProviderServices": [
0
],
"ProviderSettings": "string",
"ShippingSettings": {
"Services": [
{
"Id": 0,
"Code": "string",
"DisplayName": "string",
"Description": "string",
"Type": 0
}
],
"AccountTypes": [
{
"DisplayName": "string",
"Value": "string"
}
],
"DeliveryConfirmations": [
{
"DisplayName": "string",
"Value": "string"
}
],
"PackageType": [
{
"DisplayName": "string",
"Value": "string"
}
]
},
"Settings": {
"HandlingCharge": 0,
"AdditionalPerItemHandlingCharge": 0,
"MinWeight": 0,
"MaxWeight": 0,
"MinWidth": 0,
"MaxWidth": 0,
"MinHeight": 0,
"MaxHeight": 0,
"MinDepth": 0,
"MaxDepth": 0,
"MinOrderPrice": 0,
"MaxOrderPrice": 0,
"AllowedCustomersTypes": [
0
],
"LimitDeliveryFollowingCountries": [
"string"
],
"ExcludeShippingForCatalogs": [
0
]
}
}
PUT Ecommerce Shipping Option Update
Updates a single Shipping Option based on the ID passed in the endpoint URL and data provided.
/api/v2/admin/shipping-options/{id}
Data / Response:
{
"Name": "string",
"Price": 0,
"IsEnabled": true,
"Currency": "string",
"Country": "string",
"Type": "string",
"TaxId": 0,
"TaxNeverApplies": true,
"ChosenShippingProviderServices": [
0
],
"ProviderSettings": "string",
"Settings": {
"HandlingCharge": 0,
"AdditionalPerItemHandlingCharge": 0,
"MinWeight": 0,
"MaxWeight": 0,
"MinWidth": 0,
"MaxWidth": 0,
"MinHeight": 0,
"MaxHeight": 0,
"MinDepth": 0,
"MaxDepth": 0,
"MinOrderPrice": 0,
"MaxOrderPrice": 0,
"AllowedCustomersTypes": [
0
],
"LimitDeliveryFollowingCountries": [
"string"
],
"ExcludeShippingForCatalogs": [
0
]
}
}
{
"Id": 0,
"Name": "string",
"Price": 0,
"IsEnabled": true,
"CurrencyCountry": "string",
"Currency": "string",
"Country": "string",
"Type": 0,
"TaxId": 0,
"TaxNeverApplies": true,
"ChosenShippingProviderServices": [
0
],
"ProviderSettings": "string",
"ShippingSettings": {
"Services": [
{
"Id": 0,
"Code": "string",
"DisplayName": "string",
"Description": "string",
"Type": 0
}
],
"AccountTypes": [
{
"DisplayName": "string",
"Value": "string"
}
],
"DeliveryConfirmations": [
{
"DisplayName": "string",
"Value": "string"
}
],
"PackageType": [
{
"DisplayName": "string",
"Value": "string"
}
]
},
"Settings": {
"HandlingCharge": 0,
"AdditionalPerItemHandlingCharge": 0,
"MinWeight": 0,
"MaxWeight": 0,
"MinWidth": 0,
"MaxWidth": 0,
"MinHeight": 0,
"MaxHeight": 0,
"MinDepth": 0,
"MaxDepth": 0,
"MinOrderPrice": 0,
"MaxOrderPrice": 0,
"AllowedCustomersTypes": [
0
],
"LimitDeliveryFollowingCountries": [
"string"
],
"ExcludeShippingForCatalogs": [
0
]
}
}
DELETE Ecommerce Shipping Option Delete
Deletes a single Shipping Option based on the ID passed in the endpoint URL.
/api/v2/admin/shipping-options/{id}
Data / Response:
N/A
Status 204