getAvailableDeliveryOptions

Method returns list of available delivery options for input parameters, along with pricing or warnings. Prices will be returned in currency, that is assigned to account, not the one in input request.

Usage URL: https://magboss.pl/api/getAvailableDeliveryOptions.json?key=YOURAPIKEY

Query params

(put those in your URL, e.g. ?id=123)

country | required
string
Country iso code.
Example: Two letters format ie: DE, PL, GB, US
{"name":"country","propertyName":"country","type":{"format":null},"description":"Country iso code.","example":"Two letters format ie: DE, PL, GB, US","required":true,"children":[]}
currency | required
string
Currency symbol for product value.
Example: Three letters format ie: PLN, EUR, USD.
{"name":"currency","propertyName":"currency","type":{"format":null},"description":"Currency symbol for product value.","example":"Three letters format ie: PLN, EUR, USD.","required":true,"children":[]}
pricegross | required
float
Gross value of products
{"name":"pricegross","propertyName":"priceGross","type":{"format":null},"description":"Gross value of products","example":null,"required":true,"children":[]}
weightgross | required
float
Gross weight of products
{"name":"weightgross","propertyName":"weightGross","type":{"format":null},"description":"Gross weight of products","example":null,"required":true,"children":[]}
lang
string
Language of result. ISO 2 Letter Language Codes ie
Example: en, pl, cs
{"name":"lang","propertyName":"lang","type":{"format":null},"description":"Language of result. ISO 2 Letter Language Codes ie","example":"en, pl, cs","required":false,"children":[]}

shipmentid
integer
Shipment type ID
{"name":"shipmentid","propertyName":"shipmentId","type":{"format":null},"description":"Shipment type ID","example":null,"required":false,"children":[]}
shipmentname
string
Shipment type name
{"name":"shipmentname","propertyName":"shipmentName","type":{"format":null},"description":"Shipment type name","example":null,"required":false,"children":[]}
shipmentdescription
string
Shipment type description
{"name":"shipmentdescription","propertyName":"shipmentDescription","type":{"format":null},"description":"Shipment type description","example":null,"required":false,"children":[]}
estimateddeliverytime
string
Estimated delivery time as localized text
{"name":"estimateddeliverytime","propertyName":"estimatedDeliveryTime","type":{"format":null},"description":"Estimated delivery time as localized text","example":null,"required":false,"children":[]}
tag
string
Internal shipment type tag
{"name":"tag","propertyName":"tag","type":{"format":null},"description":"Internal shipment type tag","example":null,"required":false,"children":[]}
pickuphour
string
Hour and minutes when courier will pickup packages from the warehouse (local time hh:MM)
{"name":"pickuphour","propertyName":"pickupHour","type":{"format":null},"description":"Hour and minutes when courier will pickup packages from the warehouse (local time hh:MM)","example":null,"required":false,"children":[]}
pickuphourunix
integer
Unix time for pickup hour
{"name":"pickuphourunix","propertyName":"pickupHourUnix","type":{"format":null},"description":"Unix time for pickup hour","example":null,"required":false,"children":[]}
available
boolean (1 = true, 0 = false)
Information whether the shipment type can be selected for given options
{"name":"available","propertyName":"available","type":{"format":"1 = true, 0 = false"},"description":"Information whether the shipment type can be selected for given options","example":null,"required":false,"children":[]}
unavailablereason
string
Localized reason why package cannot be selected
{"name":"unavailablereason","propertyName":"unavailableReason","type":{"format":null},"description":"Localized reason why package cannot be selected","example":null,"required":false,"children":[]}
minprice
float
Min. allowed price for shipment type. If 0 - does not apply.
{"name":"minprice","propertyName":"minPrice","type":{"format":null},"description":"Min. allowed price for shipment type. If 0 - does not apply.","example":null,"required":false,"children":[]}
maxprice
float
Max. allowed price for shipment type. If 0 - unlimited.
{"name":"maxprice","propertyName":"maxPrice","type":{"format":null},"description":"Max. allowed price for shipment type. If 0 - unlimited.","example":null,"required":false,"children":[]}
maxlength
float
Max. allowed length for shipment type. If 0 - unlimited.
{"name":"maxlength","propertyName":"maxLength","type":{"format":null},"description":"Max. allowed length for shipment type. If 0 - unlimited.","example":null,"required":false,"children":[]}
mincapacity
float
Min. allowed capacity for shipment type. If 0 - unlimited.
{"name":"mincapacity","propertyName":"minCapacity","type":{"format":null},"description":"Min. allowed capacity for shipment type. If 0 - unlimited.","example":null,"required":false,"children":[]}
maxcapacity
float
Max. allowed capacity for shipment type. If 0 - unlimited.
{"name":"maxcapacity","propertyName":"maxCapacity","type":{"format":null},"description":"Max. allowed capacity for shipment type. If 0 - unlimited.","example":null,"required":false,"children":[]}
price
string
Price (net)
{"name":"price","propertyName":"price","type":{"format":null},"description":"Price (net)","example":null,"required":false,"children":[]}
pricenoformat
float
Price (net) - without rounding and currency string
{"name":"pricenoformat","propertyName":"priceNoFormat","type":{"format":null},"description":"Price (net) - without rounding and currency string","example":null,"required":false,"children":[]}
pricegross
string
Price (gross)
{"name":"pricegross","propertyName":"priceGross","type":{"format":null},"description":"Price (gross)","example":null,"required":false,"children":[]}
pricegrossnoformat
float
Price (gross) - without rounding and currency string
{"name":"pricegrossnoformat","propertyName":"priceGrossNoFormat","type":{"format":null},"description":"Price (gross) - without rounding and currency string","example":null,"required":false,"children":[]}
packagepricenoformat
float
Price (net) for packaging
{"name":"packagepricenoformat","propertyName":"packagePriceNoFormat","type":{"format":null},"description":"Price (net) for packaging","example":null,"required":false,"children":[]}
packagepricegrossnoformat
float
Price (gross) for packaging
{"name":"packagepricegrossnoformat","propertyName":"packagePriceGrossNoFormat","type":{"format":null},"description":"Price (gross) for packaging","example":null,"required":false,"children":[]}
payment
object[]
Array with available payments
- paymentid
  integer
  Payment type ID
  {"name":"paymentid","propertyName":"paymentId","type":{"format":null},"description":"Payment type ID","example":null,"required":false,"children":[]}
- name
  string
  Payment type name
  {"name":"name","propertyName":"name","type":{"format":null},"description":"Payment type name","example":null,"required":false,"children":[]}
- description
  string
  Payment type description
  {"name":"description","propertyName":"description","type":{"format":null},"description":"Payment type description","example":null,"required":false,"children":[]}
- tag
  string
  Internal payment type tag
  {"name":"tag","propertyName":"tag","type":{"format":null},"description":"Internal payment type tag","example":null,"required":false,"children":[]}
- price
  string
  Price (net) in selected currency
  {"name":"price","propertyName":"price","type":{"format":null},"description":"Price (net) in selected currency","example":null,"required":false,"children":[]}
- pricenoformat
  float
  Price (net) - without rounding and currency string
  {"name":"pricenoformat","propertyName":"priceNoFormat","type":{"format":null},"description":"Price (net) - without rounding and currency string","example":null,"required":false,"children":[]}
- pricegross
  string
  Price (gross)
  {"name":"pricegross","propertyName":"priceGross","type":{"format":null},"description":"Price (gross)","example":null,"required":false,"children":[]}
- pricegrossnoformat
  float
  Price (gross) - without rounding and currency string
  {"name":"pricegrossnoformat","propertyName":"priceGrossNoFormat","type":{"format":null},"description":"Price (gross) - without rounding and currency string","example":null,"required":false,"children":[]}
{"name":"payment","propertyName":"payment","type":{"format":null},"description":"Array with available payments","example":null,"required":false,"children":[{"name":"paymentid","propertyName":"paymentId","type":{"format":null},"description":"Payment type ID","example":null,"required":false,"children":[]},{"name":"name","propertyName":"name","type":{"format":null},"description":"Payment type name","example":null,"required":false,"children":[]},{"name":"description","propertyName":"description","type":{"format":null},"description":"Payment type description","example":null,"required":false,"children":[]},{"name":"tag","propertyName":"tag","type":{"format":null},"description":"Internal payment type tag","example":null,"required":false,"children":[]},{"name":"price","propertyName":"price","type":{"format":null},"description":"Price (net) in selected currency","example":null,"required":false,"children":[]},{"name":"pricenoformat","propertyName":"priceNoFormat","type":{"format":null},"description":"Price (net) - without rounding and currency string","example":null,"required":false,"children":[]},{"name":"pricegross","propertyName":"priceGross","type":{"format":null},"description":"Price (gross)","example":null,"required":false,"children":[]},{"name":"pricegrossnoformat","propertyName":"priceGrossNoFormat","type":{"format":null},"description":"Price (gross) - without rounding and currency string","example":null,"required":false,"children":[]}]}

Example URL: https://magboss.pl/api/getAvailableDeliveryOptions.json?key=YOURAPIKEY&lang=en&country=GB&currency=EUR&pricegross=45.22&weightgross=3.5

[
    {
        "shipmentname": "DHL (EXPRESSWORLDWIDE)",
        "shipmentdescription": "",
        "maxprice": 0,
        "tag": "dhl",
        "shipmentid": 17,
        "pickuphour": "13:00",
        "rate": 1.23,
        "pricenoformat": 160.14,
        "basepricegrossnoformat": 196.9722,
        "pricegrossnoformat": 196.9722,
        "pricegross": "196,97&nbsp;PLN",
        "price": "160,14&nbsp;PLN",
        "payment": [
            {
                "name": "PayPal",
                "description": "",
                "paymentid": 1,
                "pricenoformat": 14.52,
                "pricegrossnoformat": 17.8596,
                "price": "14,52&nbsp;PLN",
                "pricegross": "17,86&nbsp;PLN",
                "rate": 1.23
            },
            {
                "name": "Bank transfer",
                "description": "",
                "paymentid": 5,
                "pricenoformat": 0,
                "pricegrossnoformat": 0,
                "price": "0,00&nbsp;PLN",
                "pricegross": "0,00&nbsp;PLN",
                "rate": 1.23
            }
        ]
    },
    {
        "shipmentname": "GLS - european union",
        "shipmentdescription": "",
        "maxprice": 0,
        "tag": "",
        "shipmentid": 18,
        "pickuphour": "13:00",
        "rate": 1.23,
        "pricenoformat": 63,
        "basepricegrossnoformat": 77.49,
        "pricegrossnoformat": 77.49,
        "pricegross": "77,49&nbsp;PLN",
        "price": "63,00&nbsp;PLN",
        "payment": [
            {
                "name": "PayPal",
                "description": "",
                "paymentid": 1,
                "pricenoformat": 7.35,
                "pricegrossnoformat": 9.0405,
                "price": "7,35&nbsp;PLN",
                "pricegross": "9,04&nbsp;PLN",
                "rate": 1.23
            },
            {
                "name": "Bank transfer",
                "description": "",
                "paymentid": 5,
                "pricenoformat": 0,
                "pricegrossnoformat": 0,
                "price": "0,00&nbsp;PLN",
                "pricegross": "0,00&nbsp;PLN",
                "rate": 1.23
            }
        ]
    },
    {
        "shipmentname": "FEDEX (Express)",
        "shipmentdescription": "Delivery typically in 1 to 3 business days. Reach major cities in Europe by 10:30 am typically in two business days.",
        "maxprice": 0,
        "tag": "fedex_int",
        "shipmentid": 34,
        "pickuphour": "13:00",
        "rate": 1.23,
        "pricenoformat": 147.13,
        "basepricegrossnoformat": 180.9699,
        "pricegrossnoformat": 180.9699,
        "pricegross": "180,97&nbsp;PLN",
        "price": "147,13&nbsp;PLN",
        "payment": [
            {
                "name": "PayPal",
                "description": "",
                "paymentid": 1,
                "pricenoformat": 13.56,
                "pricegrossnoformat": 16.6788,
                "price": "13,56&nbsp;PLN",
                "pricegross": "16,68&nbsp;PLN",
                "rate": 1.23
            },
            {
                "name": "Bank transfer",
                "description": "",
                "paymentid": 5,
                "pricenoformat": 0,
                "pricegrossnoformat": 0,
                "price": "0,00&nbsp;PLN",
                "pricegross": "0,00&nbsp;PLN",
                "rate": 1.23
            }
        ]
    },
    {
        "shipmentname": "UPS - Express Saver",
        "shipmentdescription": "",
        "maxprice": 0,
        "tag": "ups",
        "shipmentid": 36,
        "pickuphour": "13:00",
        "rate": 1.23,
        "pricenoformat": 110.75,
        "basepricegrossnoformat": 136.2225,
        "pricegrossnoformat": 136.2225,
        "pricegross": "136,22&nbsp;PLN",
        "price": "110,75&nbsp;PLN",
        "payment": [
            {
                "name": "PayPal",
                "description": "",
                "paymentid": 1,
                "pricenoformat": 10.88,
                "pricegrossnoformat": 13.3824,
                "price": "10,88&nbsp;PLN",
                "pricegross": "13,38&nbsp;PLN",
                "rate": 1.23
            },
            {
                "name": "Bank transfer",
                "description": "",
                "paymentid": 5,
                "pricenoformat": 0,
                "pricegrossnoformat": 0,
                "price": "0,00&nbsp;PLN",
                "pricegross": "0,00&nbsp;PLN",
                "rate": 1.23
            }
        ]
    }
]

Example URL: https://magboss.pl/api/getAvailableDeliveryOptions.xml?key=YOURAPIKEY&lang=en&country=GB&currency=EUR&pricegross=45.22&weightgross=3.5

<?xml version="1.0" encoding="utf-8"?>
<root>
	<item>
		<shipmentname>DHL (EXPRESSWORLDWIDE)</shipmentname>
		<shipmentdescription></shipmentdescription>
		<maxprice>0</maxprice>
		<tag>dhl</tag>
		<shipmentid>17</shipmentid>
		<pickuphour>13:00</pickuphour>
		<rate>1.23</rate>
		<pricenoformat>160.14</pricenoformat>
		<basepricegrossnoformat>196.9722</basepricegrossnoformat>
		<pricegrossnoformat>196.9722</pricegrossnoformat>
		<pricegross>196,97&amp;nbsp;PLN</pricegross>
		<price>160,14&amp;nbsp;PLN</price>
		<payment>
			<item>
				<name>PayPal</name>
				<description></description>
				<paymentid>1</paymentid>
				<pricenoformat>14.52</pricenoformat>
				<pricegrossnoformat>17.8596</pricegrossnoformat>
				<price>14,52&amp;nbsp;PLN</price>
				<pricegross>17,86&amp;nbsp;PLN</pricegross>
				<rate>1.23</rate>
			</item>
			<item>
				<name>Bank transfer</name>
				<description></description>
				<paymentid>5</paymentid>
				<pricenoformat>0</pricenoformat>
				<pricegrossnoformat>0</pricegrossnoformat>
				<price>0,00&amp;nbsp;PLN</price>
				<pricegross>0,00&amp;nbsp;PLN</pricegross>
				<rate>1.23</rate>
			</item>
		</payment>
	</item>
	<item>
		<shipmentname>GLS - european union</shipmentname>
		<shipmentdescription></shipmentdescription>
		<maxprice>0</maxprice>
		<tag></tag>
		<shipmentid>18</shipmentid>
		<pickuphour>13:00</pickuphour>
		<rate>1.23</rate>
		<pricenoformat>63</pricenoformat>
		<basepricegrossnoformat>77.49</basepricegrossnoformat>
		<pricegrossnoformat>77.49</pricegrossnoformat>
		<pricegross>77,49&amp;nbsp;PLN</pricegross>
		<price>63,00&amp;nbsp;PLN</price>
		<payment>
			<item>
				<name>PayPal</name>
				<description></description>
				<paymentid>1</paymentid>
				<pricenoformat>7.35</pricenoformat>
				<pricegrossnoformat>9.0405</pricegrossnoformat>
				<price>7,35&amp;nbsp;PLN</price>
				<pricegross>9,04&amp;nbsp;PLN</pricegross>
				<rate>1.23</rate>
			</item>
			<item>
				<name>Bank transfer</name>
				<description></description>
				<paymentid>5</paymentid>
				<pricenoformat>0</pricenoformat>
				<pricegrossnoformat>0</pricegrossnoformat>
				<price>0,00&amp;nbsp;PLN</price>
				<pricegross>0,00&amp;nbsp;PLN</pricegross>
				<rate>1.23</rate>
			</item>
		</payment>
	</item>
	<item>
		<shipmentname>FEDEX (Express)</shipmentname>
		<shipmentdescription>Delivery typically in 1 to 3 business days. Reach major cities in Europe by 10:30 am typically in two business days.</shipmentdescription>
		<maxprice>0</maxprice>
		<tag>fedex_int</tag>
		<shipmentid>34</shipmentid>
		<pickuphour>13:00</pickuphour>
		<rate>1.23</rate>
		<pricenoformat>147.13</pricenoformat>
		<basepricegrossnoformat>180.9699</basepricegrossnoformat>
		<pricegrossnoformat>180.9699</pricegrossnoformat>
		<pricegross>180,97&amp;nbsp;PLN</pricegross>
		<price>147,13&amp;nbsp;PLN</price>
		<payment>
			<item>
				<name>PayPal</name>
				<description></description>
				<paymentid>1</paymentid>
				<pricenoformat>13.56</pricenoformat>
				<pricegrossnoformat>16.6788</pricegrossnoformat>
				<price>13,56&amp;nbsp;PLN</price>
				<pricegross>16,68&amp;nbsp;PLN</pricegross>
				<rate>1.23</rate>
			</item>
			<item>
				<name>Bank transfer</name>
				<description></description>
				<paymentid>5</paymentid>
				<pricenoformat>0</pricenoformat>
				<pricegrossnoformat>0</pricegrossnoformat>
				<price>0,00&amp;nbsp;PLN</price>
				<pricegross>0,00&amp;nbsp;PLN</pricegross>
				<rate>1.23</rate>
			</item>
		</payment>
	</item>
	<item>
		<shipmentname>UPS - Express Saver</shipmentname>
		<shipmentdescription></shipmentdescription>
		<maxprice>0</maxprice>
		<tag>ups</tag>
		<shipmentid>36</shipmentid>
		<pickuphour>13:00</pickuphour>
		<rate>1.23</rate>
		<pricenoformat>110.75</pricenoformat>
		<basepricegrossnoformat>136.2225</basepricegrossnoformat>
		<pricegrossnoformat>136.2225</pricegrossnoformat>
		<pricegross>136,22&amp;nbsp;PLN</pricegross>
		<price>110,75&amp;nbsp;PLN</price>
		<payment>
			<item>
				<name>PayPal</name>
				<description></description>
				<paymentid>1</paymentid>
				<pricenoformat>10.88</pricenoformat>
				<pricegrossnoformat>13.3824</pricegrossnoformat>
				<price>10,88&amp;nbsp;PLN</price>
				<pricegross>13,38&amp;nbsp;PLN</pricegross>
				<rate>1.23</rate>
			</item>
			<item>
				<name>Bank transfer</name>
				<description></description>
				<paymentid>5</paymentid>
				<pricenoformat>0</pricenoformat>
				<pricegrossnoformat>0</pricegrossnoformat>
				<price>0,00&amp;nbsp;PLN</price>
				<pricegross>0,00&amp;nbsp;PLN</pricegross>
				<rate>1.23</rate>
			</item>
		</payment>
	</item>
</root>