Skip to main content

Add new shipping methods

Add new shipping methods

Authorizations:Token
Request Body Schema:
Method object that needs to be added
freebooleanWhether the method is free or not
method_idintegerA unique ID of the method
processorstringProcessor class name
carrierstringCarrier of the method (for instance, "UPS" or "USPS")
codestringUnique code of shipping method (within processor space)
enabledbooleanWhether the method is enabled or disabled
positionintegerA position of the method among other registered methods
shipping_markupsArrayShipping rates (relation)
taxClassobject
idintegerID
positionintegerPosition
addedbooleanAdded status
moduleNamestringSpecific module family name
fromMarketplacebooleanFlag: 1 - method has been got from marketplace, 0 - method has been added after distr or module installation
iconURLstringIcon URL (used for methods from marketplace)
tableTypestringTable type
handlingFeestringHandling fee (surcharge) for online methods
handlingFeeTypestringHandling fee type(absolute or percent)

Responses

200Success
Response schema:
Success
freebooleanWhether the method is free or not
method_idintegerA unique ID of the method
processorstringProcessor class name
carrierstringCarrier of the method (for instance, "UPS" or "USPS")
codestringUnique code of shipping method (within processor space)
enabledbooleanWhether the method is enabled or disabled
positionintegerA position of the method among other registered methods
shipping_markupsArrayShipping rates (relation)
taxClassobject
idintegerID
positionintegerPosition
addedbooleanAdded status
moduleNamestringSpecific module family name
fromMarketplacebooleanFlag: 1 - method has been got from marketplace, 0 - method has been added after distr or module installation
iconURLstringIcon URL (used for methods from marketplace)
tableTypestringTable type
handlingFeestringHandling fee (surcharge) for online methods
handlingFeeTypestringHandling fee type(absolute or percent)