getShipmentTypes

Method returns list of shipment types.

Usage URL: https://magboss.pl/api/getShipmentTypes.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":[]}
id
integer or integer[]
Internal identifier of shipment type.
More than one value can be specified after comma (,) separator.
{"name":"id","propertyName":"id","type":{"format":null},"description":"Internal identifier of shipment type.\nMore than one value can be specified after comma (,) separator.","example":null,"required":false,"children":[]}
modified
datetime (YYYY-MM-DD HH:MM:SS)
Return all shipment types modified after the modified param. That is highly recommended when you want to update your local database.
{"name":"modified","propertyName":"modified","type":{"format":"YYYY-MM-DD HH:MM:SS"},"description":"Return all shipment types modified after the <strong>modified<\/strong> param. That is highly <strong>recommended<\/strong> when you want to update your local database.","example":null,"required":false,"children":[]}
name
string
Name of the shipment type.
Example: 'box' will return all shipment types that contain box in the `name` field.
{"name":"name","propertyName":"name","type":{"format":null},"description":"Name of the shipment type.","example":"'box' will return all shipment types that contain <strong>box<\/strong> in the `name` field.","required":false,"children":[]}
weight
float
Returns all shipment types that can carry specified weight. Unit is in kg.
{"name":"weight","propertyName":"weight","type":{"format":null},"description":"Returns all shipment types that can carry specified weight. Unit is in kg.","example":null,"required":false,"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":[]}

id
integer
Shipment type internal identifier.
{"name":"id","propertyName":"id","type":{"format":null},"description":"Shipment type internal identifier.","example":null,"required":false,"children":[]}
modified
datetime (YYYY-MM-DD HH:MM:SS)
When shipment type was last modified
{"name":"modified","propertyName":"modified","type":{"format":"YYYY-MM-DD HH:MM:SS"},"description":"When shipment type was last modified","example":null,"required":false,"children":[]}
name
string
Shipment type name.
{"name":"name","propertyName":"name","type":{"format":null},"description":"Shipment type name.","example":null,"required":false,"children":[]}
description
string
Shipment type description.
{"name":"description","propertyName":"description","type":{"format":null},"description":"Shipment type description.","example":null,"required":false,"children":[]}
logo
string
File name of logo.
{"name":"logo","propertyName":"logo","type":{"format":null},"description":"File name of logo.","example":null,"required":false,"children":[]}
trackingurl
string
URL of website where customers can track their package status.
{"name":"trackingurl","propertyName":"trackingUrl","type":{"format":null},"description":"URL of website where customers can track their package status.","example":null,"required":false,"children":[]}
maxweight
float
Max allowable weight for this shipment type. Returns 0 if country code was not specified.
{"name":"maxweight","propertyName":"maxWeight","type":{"format":null},"description":"Max allowable weight for this shipment type. Returns 0 if country code was not specified.","example":null,"required":false,"children":[]}

Example URL: https://magboss.pl/api/getShipmentTypes.json?key=YOURAPIKEY&lang=en&id=34,37

[
    {
        "id": 34,
        "modified": "2018-09-26 10:20:13",
        "name": "FEDEX (Express)",
        "description": "Ekspresowa dostawa \"od drzwi do drzwi\" dokument\u00f3w i towar\u00f3w podlegaj\u0105cych ocleniu o wadze do 68 kg z okre\u015blonym czasem dor\u0119czenia, obejmuj\u0105ca odpraw\u0119 celn\u0105.\n\nDor\u0119czanie przesy\u0142ek na terenie wi\u0119kszo\u015bci kraj\u00f3w Europy Zachodniej nast\u0119pnego dnia.",
        "logo": "no-image",
        "trackingurl": "https:\/\/www.fedex.com\/fedextrack\/?tracknumbers=[number]&locale=en_GB",
        "minorders": 0,
        "maxweight": 0
    },
    {
        "id": 37,
        "modified": "2018-09-28 12:10:44",
        "name": "InPost - Paczkomaty",
        "description": null,
        "logo": "https://core.magboss.pl\/image.php?name=575949e85f5d4d1382e11d5219848839-nowt.png",
        "trackingurl": "https:\/\/twoj.inpost.pl\/pl\/znajdz-przesylke?parcel=[number]",
        "minorders": 0,
        "maxweight": 0
    }
]

Example URL: https://magboss.pl/api/getShipmentTypes.xml?key=YOURAPIKEY&lang=en&id=34,37

<?xml version="1.0" encoding="utf-8"?>
<root>
	<item>
		<id>34</id>
		<modified>2018-09-26 10:20:13</modified>
		<name>FEDEX (Express)</name>
		<description>Ekspresowa dostawa &quot;od drzwi do drzwi&quot; dokumentów i towarów podlegających ocleniu o wadze do 68 kg z określonym czasem doręczenia, obejmująca odprawę celną.

Doręczanie przesyłek na terenie większości krajów Europy Zachodniej następnego dnia.</description>
		<logo>no-image</logo>
		<trackingurl>https://www.fedex.com/fedextrack/?tracknumbers=[number]&amp;locale=en_GB</trackingurl>
		<minorders>0</minorders>
		<maxweight>0</maxweight>
	</item>
	<item>
		<id>37</id>
		<modified>2018-09-28 12:10:44</modified>
		<name>InPost - Paczkomaty</name>
		<description></description>
		<logo>https://core.magboss.pl/image.php?name=575949e85f5d4d1382e11d5219848839-nowt.png</logo>
		<trackingurl>https://twoj.inpost.pl/pl/znajdz-przesylke?parcel=[number]</trackingurl>
		<minorders>0</minorders>
		<maxweight>0</maxweight>
	</item>
</root>