GET
Retrieve shipping methods by conditions

_cnd[limit]
array 
Sets the offset (first item) and the limit (second item)
_cnd[orderBy]
array 
Sets sorting order field
default Success <XLite\Model\Shipping\Method>[] array
Sample response
[{"free":"boolean","method_id":"integer","processor":"string","carrier":"string","code":"string","enabled":"boolean","position":"integer","shipping_markups":"<XLite\\Model\\Shipping\\Markup>[] array","taxClass":"<XLite\\Model\\TaxClass>","added":"boolean","moduleName":"string","fromMarketplace":"boolean","iconURL":"string","tableType":"string","handlingFee":"string","handlingFeeType":"string"}]

GET
Retrieve shipping methods by id

id
integer Required
Id value of the Method object
default Success <XLite\Model\Shipping\Method>
Sample response
{"free":"boolean","method_id":"integer","processor":"string","carrier":"string","code":"string","enabled":"boolean","position":"integer","shipping_markups":"<XLite\\Model\\Shipping\\Markup>[] array","taxClass":"<XLite\\Model\\TaxClass>","added":"boolean","moduleName":"string","fromMarketplace":"boolean","iconURL":"string","tableType":"string","handlingFee":"string","handlingFeeType":"string"}
free
boolean
Whether the method is free or not
method_id
integer
A unique ID of the method
processor
string
Processor class name
carrier
string
Carrier of the method (for instance, "UPS" or "USPS")
code
string
Unique code of shipping method (within processor space)
enabled
boolean
Whether the method is enabled or disabled
position
integer
A position of the method among other registered methods
shipping_markups
[] array
Shipping rates (relation)
taxClass
added
boolean
Added status
moduleName
string
Specific module family name
fromMarketplace
boolean
Flag: 1 - method has been got from marketplace, 0 - method has been added after distr or module installation
iconURL
string
Icon URL (used for methods from marketplace)
tableType
string
Table type
handlingFee
string
Handling fee (surcharge) for online methods
handlingFeeType
string
Handling fee type(absolute or percent)

PUT
Update shipping methods by id

id
integer Required
Id value of the Method object
<XLite\Model\Shipping\Method>
free
boolean
Whether the method is free or not
method_id
integer
A unique ID of the method
processor
string
Processor class name
carrier
string
Carrier of the method (for instance, "UPS" or "USPS")
code
string
Unique code of shipping method (within processor space)
enabled
boolean
Whether the method is enabled or disabled
position
integer
A position of the method among other registered methods
shipping_markups
[] array
Shipping rates (relation)
taxClass
added
boolean
Added status
moduleName
string
Specific module family name
fromMarketplace
boolean
Flag: 1 - method has been got from marketplace, 0 - method has been added after distr or module installation
iconURL
string
Icon URL (used for methods from marketplace)
tableType
string
Table type
handlingFee
string
Handling fee (surcharge) for online methods
handlingFeeType
string
Handling fee type(absolute or percent)
default Success <XLite\Model\Shipping\Method>
Sample response
{"free":"boolean","method_id":"integer","processor":"string","carrier":"string","code":"string","enabled":"boolean","position":"integer","shipping_markups":"<XLite\\Model\\Shipping\\Markup>[] array","taxClass":"<XLite\\Model\\TaxClass>","added":"boolean","moduleName":"string","fromMarketplace":"boolean","iconURL":"string","tableType":"string","handlingFee":"string","handlingFeeType":"string"}
free
boolean
Whether the method is free or not
method_id
integer
A unique ID of the method
processor
string
Processor class name
carrier
string
Carrier of the method (for instance, "UPS" or "USPS")
code
string
Unique code of shipping method (within processor space)
enabled
boolean
Whether the method is enabled or disabled
position
integer
A position of the method among other registered methods
shipping_markups
[] array
Shipping rates (relation)
taxClass
added
boolean
Added status
moduleName
string
Specific module family name
fromMarketplace
boolean
Flag: 1 - method has been got from marketplace, 0 - method has been added after distr or module installation
iconURL
string
Icon URL (used for methods from marketplace)
tableType
string
Table type
handlingFee
string
Handling fee (surcharge) for online methods
handlingFeeType
string
Handling fee type(absolute or percent)

DELETE
Delete shipping methods by id

id
integer Required
Id value of the Method object
default Success <XLite\Model\Shipping\Method>
Sample response
{"free":"boolean","method_id":"integer","processor":"string","carrier":"string","code":"string","enabled":"boolean","position":"integer","shipping_markups":"<XLite\\Model\\Shipping\\Markup>[] array","taxClass":"<XLite\\Model\\TaxClass>","added":"boolean","moduleName":"string","fromMarketplace":"boolean","iconURL":"string","tableType":"string","handlingFee":"string","handlingFeeType":"string"}
free
boolean
Whether the method is free or not
method_id
integer
A unique ID of the method
processor
string
Processor class name
carrier
string
Carrier of the method (for instance, "UPS" or "USPS")
code
string
Unique code of shipping method (within processor space)
enabled
boolean
Whether the method is enabled or disabled
position
integer
A position of the method among other registered methods
shipping_markups
[] array
Shipping rates (relation)
taxClass
added
boolean
Added status
moduleName
string
Specific module family name
fromMarketplace
boolean
Flag: 1 - method has been got from marketplace, 0 - method has been added after distr or module installation
iconURL
string
Icon URL (used for methods from marketplace)
tableType
string
Table type
handlingFee
string
Handling fee (surcharge) for online methods
handlingFeeType
string
Handling fee type(absolute or percent)

POST
Add new shipping methods

<XLite\Model\Shipping\Method>
free
boolean
Whether the method is free or not
method_id
integer
A unique ID of the method
processor
string
Processor class name
carrier
string
Carrier of the method (for instance, "UPS" or "USPS")
code
string
Unique code of shipping method (within processor space)
enabled
boolean
Whether the method is enabled or disabled
position
integer
A position of the method among other registered methods
shipping_markups
[] array
Shipping rates (relation)
taxClass
added
boolean
Added status
moduleName
string
Specific module family name
fromMarketplace
boolean
Flag: 1 - method has been got from marketplace, 0 - method has been added after distr or module installation
iconURL
string
Icon URL (used for methods from marketplace)
tableType
string
Table type
handlingFee
string
Handling fee (surcharge) for online methods
handlingFeeType
string
Handling fee type(absolute or percent)
default Success <XLite\Model\Shipping\Method>
Sample response
{"free":"boolean","method_id":"integer","processor":"string","carrier":"string","code":"string","enabled":"boolean","position":"integer","shipping_markups":"<XLite\\Model\\Shipping\\Markup>[] array","taxClass":"<XLite\\Model\\TaxClass>","added":"boolean","moduleName":"string","fromMarketplace":"boolean","iconURL":"string","tableType":"string","handlingFee":"string","handlingFeeType":"string"}
free
boolean
Whether the method is free or not
method_id
integer
A unique ID of the method
processor
string
Processor class name
carrier
string
Carrier of the method (for instance, "UPS" or "USPS")
code
string
Unique code of shipping method (within processor space)
enabled
boolean
Whether the method is enabled or disabled
position
integer
A position of the method among other registered methods
shipping_markups
[] array
Shipping rates (relation)
taxClass
added
boolean
Added status
moduleName
string
Specific module family name
fromMarketplace
boolean
Flag: 1 - method has been got from marketplace, 0 - method has been added after distr or module installation
iconURL
string
Icon URL (used for methods from marketplace)
tableType
string
Table type
handlingFee
string
Handling fee (surcharge) for online methods
handlingFeeType
string
Handling fee type(absolute or percent)