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

  • currency | required

    string

    Currency symbol for product value.

    Example: Three letters format ie: PLN, EUR, USD.

  • pricegross | required

    float

    Gross value of products

  • weightgross | required

    float

    Gross weight of products

  • lang

    string

    Language of result. ISO 2 Letter Language Codes

    Example: en, pl, cs

  • shipmentid

    integer

    Shipment type ID

  • shipmentname

    string

    Shipment type name

  • shipmentdescription

    string

    Shipment type description

  • estimateddeliverytime

    string

    Estimated delivery time as localized text

  • tag

    string

    Internal shipment type tag

  • pickuphour

    string

    Hour and minutes when courier will pickup packages from the warehouse (local time hh:MM)

  • pickuphourunix

    integer

    Unix time for pickup hour

  • available

    boolean (1 = true, 0 = false)

    Information whether the shipment type can be selected for given options

  • unavailablereason

    string

    Localized reason why package cannot be selected

  • minprice

    float

    Min. allowed price for shipment type. If 0 - does not apply.

  • maxprice

    float

    Max. allowed price for shipment type. If 0 - unlimited.

  • maxlength

    float

    Max. allowed length for shipment type in cm (longest side). If 0 - unlimited.

  • maxsizex

    float

    Max. allowed dimension for side X in cm. If 0 - unlimited.

  • maxsizey

    float

    Max. allowed dimension for side Y in cm. If 0 - unlimited.

  • maxsizez

    float

    Max. allowed dimension for side Z in cm. If 0 - unlimited.

  • mincapacity

    float

    Min. allowed capacity for shipment type. If 0 - unlimited.

  • maxcapacity

    float

    Max. allowed capacity for shipment type. If 0 - unlimited.

  • price

    string

    Price (net)

  • pricenoformat

    float

    Price (net) - without rounding and currency string

  • pricegross

    string

    Price (gross)

  • pricegrossnoformat

    float

    Price (gross) - without rounding and currency string

  • packagepricenoformat

    float

    Price (net) for packaging

  • packagepricegrossnoformat

    float

    Price (gross) for packaging

  • payment

    object[]

    Array with available payments

    Nested fields:

    • paymentid

      integer

      Payment type ID

    • name

      string

      Payment type name

    • description

      string

      Payment type description

    • tag

      string

      Internal payment type tag

    • price

      string

      Price (net) in selected currency

    • pricenoformat

      float

      Price (net) - without rounding and currency string

    • pricegross

      string

      Price (gross)

    • pricegrossnoformat

      float

      Price (gross) - without rounding and currency string

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 PLN",
        "price": "160,14 PLN",
        "payment": [
            {
                "name": "PayPal",
                "description": "",
                "paymentid": 1,
                "pricenoformat": 14.52,
                "pricegrossnoformat": 17.8596,
                "price": "14,52 PLN",
                "pricegross": "17,86 PLN",
                "rate": 1.23
            },
            {
                "name": "Bank transfer",
                "description": "",
                "paymentid": 5,
                "pricenoformat": 0,
                "pricegrossnoformat": 0,
                "price": "0,00 PLN",
                "pricegross": "0,00 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 PLN",
        "price": "63,00 PLN",
        "payment": [
            {
                "name": "PayPal",
                "description": "",
                "paymentid": 1,
                "pricenoformat": 7.35,
                "pricegrossnoformat": 9.0405,
                "price": "7,35 PLN",
                "pricegross": "9,04 PLN",
                "rate": 1.23
            },
            {
                "name": "Bank transfer",
                "description": "",
                "paymentid": 5,
                "pricenoformat": 0,
                "pricegrossnoformat": 0,
                "price": "0,00 PLN",
                "pricegross": "0,00 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 PLN",
        "price": "147,13 PLN",
        "payment": [
            {
                "name": "PayPal",
                "description": "",
                "paymentid": 1,
                "pricenoformat": 13.56,
                "pricegrossnoformat": 16.6788,
                "price": "13,56 PLN",
                "pricegross": "16,68 PLN",
                "rate": 1.23
            },
            {
                "name": "Bank transfer",
                "description": "",
                "paymentid": 5,
                "pricenoformat": 0,
                "pricegrossnoformat": 0,
                "price": "0,00 PLN",
                "pricegross": "0,00 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 PLN",
        "price": "110,75 PLN",
        "payment": [
            {
                "name": "PayPal",
                "description": "",
                "paymentid": 1,
                "pricenoformat": 10.88,
                "pricegrossnoformat": 13.3824,
                "price": "10,88 PLN",
                "pricegross": "13,38 PLN",
                "rate": 1.23
            },
            {
                "name": "Bank transfer",
                "description": "",
                "paymentid": 5,
                "pricenoformat": 0,
                "pricegrossnoformat": 0,
                "price": "0,00 PLN",
                "pricegross": "0,00 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>