Show/hide List Operations Expand Operations

API

POST /api/list beta

Requesting a list of barcodes

Documentation
Sandbox

Parameters

Parameter	Type	Required?	Description
list	object (ListType)	true
list[user]	integer	true	User ID
list[api_key]	string	true	API key
list[list]	string	true	List number

Return

Parameter	Type	Versions	Description
200 - Barcode list found
code	integer	*	Status code
message	string	*	Message.
barCodes	array	*	List of barcodes.

Status Codes

Status Code	Description
200	Barcode list found
400	Invalid data provided
403	Invalid credentials
404	No Barcodes found
415	Unsupported media type
500	Accepted, but server failed to fulfill request

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/combine-ps27 beta

Requesting a combined PS 27 document download link

Documentation
Sandbox

Parameters

Parameter	Type	Required?	Description
combine_ps27	object (CombinePs27Type)	true
combine_ps27[user]	integer	true	User ID
combine_ps27[api_key]	string	true	API key
combine_ps27[barcodes][]	array of strings	true	Array of package address barcodes. Required if packageIds not provided
combine_ps27[packageIds][]	array of strings	true	Array of package ID's. Required if barcodes not provided

Return

Parameter	Type	Versions	Description
201 - Download link created successfully
code	integer	*	Status code
message	string	*	Message.
link	string	*	Download link.

Status Codes

Status Code	Description
201	Download link created successfully
400	Invalid data provided
403	Invalid credentials
415	Unsupported media type
500	Accepted, but server failed to fulfill request

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/documents beta

Requesting a Package document download link

Parameters

Parameter	Type	Required?	Format	Description
document	object (DocumentType)	true
document[user]	string	true		User ID
document[api_key]	string	true		API key
document[package]	string	true		Package ID. Required if document[barcode] is not present. Can't use both
document[barcode]	string	true		Barcode. Required if document[package] is not present. Can't use both
document[documentType]	choice	true	["Accompanying documents","Address labels","Recipient labels","Envelope labels","CN22","Return labels"]	Document type
document[documentPrintType]	choice	false	["A4"]	Document print type
document[addressLabelType]	choice	false	["Addressee","Sender"]	Address label type, Default: Addressee, ignored if not needed
document[addressLabelLayout]	choice	false	["3x8","2x8"]	Address label layout, Default: 3x8, ignored if not needed
document[addressLabelDimensions]	choice	false	["70x35","70x37","105x35","105x37"]	Address label dimensions, Default: 70x35, ignored if not needed
document[addressLabelInitialColumn]	choice	false	[1,2,3]	Address label initial column, Default: 1, ignored if not needed
document[addressLabelInitialRow]	choice	false	[1,2,3,4,5,6,7,8]	Address label initial row, Default: 1, ignored if not needed
document[recipientLabelDimensions]	choice	false	["80x30","80x40","50x40","40x50"]	Recipient label dimensions, Default: 80x30, ignored if not needed
document[envelopeLabelDimensions]	choice	false	["DL (110x220mm)","C6 (114x162mm)","C5 (162x229mm)","C4 (229x324mm)"]	Envelope label dimensions, Default: DL (110x220mm), ignored if not needed
document[envelopeLabelPrintSenderAddress]	boolean	false		Envelope label - whether to print sender's address, Default: false, ignored if not needed

Return

Parameter	Type	Versions	Description
200 - Not reachable in this project
code	integer	*	Response code.
message	string	*	Message.
link	string	*	Download link.

Status Codes

Status Code	Description
200	Not reachable in this project
201	Download link created successfully
202	Accepted, but request processing still in progress
400	Invalid root data element
422	Root element OK, invalid data
501	Accepted, but server failed to fulfill request

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/packages beta

Creating a new Package

Parameters

Parameter	Type	Required?	Format	Description
package_create	object (PackageCreateType)	true
package_create[user]	string	true		User ID
package_create[api_key]	string	true		API key
package_create[source]	string	false		Source (client) name
package_create[version]	string	false		Source (client) version
package_create[addresses][] OR package_create[noAddresses][]	array of objects (PackageAddressType OR PackageContentType)	true		For key "addresses" Array of package addresses. For key "noAddresses" Array of package contents. Key "noAddresses" only allowed for contract users!
package_create[addresses][][sequenceNumber]	integer	false		Sequence number in the combined list of shipments
package_create[addresses][][countryCode]	choice	true	[ LV(LATVIA), AF(AFGHANISTAN), AL(ALBANIA), DZ(ALGERIA), AI(ANGUILLA), AO(ANGOLA), AG(ANTIGUA AND BARBUDA), AE(UNITED ARAB EMIRATES), AR(ARGENTINA), AM(ARMENIA), AW(ARUBA), US(USA), AU(AUSTRALIA), AT(AUSTRIA), AZ(AZERBAIJAN), BS(BAHAMAS), BH(BAHRAIN), BY(BELARUS), BD(BANGLADESH), BB(BARBADOS), BE(BELGIUM), BZ(BELIZE), BJ(BENIN), BM(BERMUDA ISLANDS), BO(BOLIVIA), BA(BOSNIA AND HERZEGOVINA), BW(BOTSWANA), BR(BRAZIL), VG(BRITISH VIRGIN ISLANDS), BN(BRUNEI DARUSSALAM), BG(BULGARIA), BF(BURKINA FASO), BI(BURUNDI), BT(BHUTAN), TD(CHAD), CZ(CZECH REPUBLIC), CF(CENTRAL AFRICAN REP.), CL(CHILE), DK(DENMARK), ZA(SOUTH AFRICA), DM(DOMINICA), DO(DOMINICAN REP.), DJ(DJIBOUTI), EG(EGYPT), EC(ECUADOR), GQ(EQUATORIAL GUINEA), ER(ERITREA), ET(ETHIOPIA), FO(FAROE ISLANDS), FJ(FIJI), PH(PHILIPPINES), FK(FALKLAND ISLANDS), FR(FRANCE), GF(FRENCH GUIANA), PF(FRENCH POLYNESIA), GA(GABON), GY(GUYANA), GM(GAMBIA), GH(GHANA), GI(GIBRALTAR), GD(GRENADA), GL(GREENLAND), GR(GREECE), GE(GEORGIA), GP(GUADELOUPE), GT(GUATEMALA), GN(GUINEA), GW(GUINEA-BISSAU), HT(HAITI), HN(HONDURAS), HK(HONG KONG), HR(CROATIA), EE(ESTONIA), IN(INDIA), ID(INDONESIA), IQ(IRAQ), IR(IRAN), IE(IRELAND), IS(ICELAND), IT(ITALY), IL(ISRAEL), JM(JAMAICA), JP(JAPAN), NC(NEW CALEDONIA), NZ(NEW ZEALAND), YE(YEMEN), JO(JORDAN), CV(CAPE VERDE), KY(CAYMAN ISLANDS), KH(CAMBODIA), CM(CAMEROON), CA(CANADA), QA(QATAR), KZ(KAZAKHSTAN), KE(KENYA), CN(CHINA), CY(CYPRUS), KG(KYRGYZSTAN), KI(KIRIBATI), CO(COLOMBIA), KM(COMOROS), CG(CONGO), CD(CONGO (DEM. REP.)), KR(KOREA (REP.)), KP(DPR KOREA), CR(COSTA RICA), CI(COTE D'IVOIRE), RU(RUSSIA), CU(CUBA), KW(KUWAIT), LA(LAO PDR), LS(LESOTHO), LB(LEBANON), LR(LIBERIA), LY(LIBYA), GB(GREAT BRITAIN), LT(LITHUANIA), LI(LIECHTENSTEIN), LU(LUXEMBOURG), MG(MADAGASCAR), YT(MAYOTTE), MO(MACAO, CHINA), MK(NORTH MACEDONIA), MY(MALAYSIA), MW(MALAWI), MV(MALDIVES), ML(MALI), MT(MALTA), MA(MOROCCO), MQ(MARTINIQUE), MU(MAURITIUS), MR(MAURITANIA), MX(MEXICO), ME(MONTENEGRO), MM(MYANMAR), MD(MOLDOVA), MC(MONACO), MN(MONGOLIA), MS(MONTSERRAT), MZ(MOZAMBIQUE), NA(NAMIBIA), NR(NAURU), NP(NEPAL), NL(NETHERLANDS), NE(NIGER), NG(NIGERIA), NI(NICARAGUA), NO(NORWAY), OM(OMAN), PK(PAKISTAN), PA(PANAMA), PG(PAPUA NEW GUINEA), PY(PARAGUAY), PE(PERU), PN(PITCAIRN), PL(POLAND), PT(PORTUGAL), RE(RÉUNION), RW(RWANDA), RO(ROMANIA), SV(EL SALVADOR), ST(SAO TOME AND PRINCIPE), SA(SAUDI ARABIA), SC(SEYCHELLES), SN(SENEGAL), PM(ST PIERRE AND MIQUELON), KN(ST KITTS AND NEVIS), LC(SAINT LUCIA), VC(SAINT VINCENT AND THE GRENADINES), RS(SERBIA), SG(SINGAPORE), SY(SYRIA), SL(SIERRA LEONE), SK(SLOVAKIA), SI(SLOVENIA), SO(SOMALIA), FI(FINLAND), ES(SPAIN), LK(SRI LANKA), SD(SUDAN), SR(SURINAME), SZ(SWAZILAND), CH(SWITZERLAND), SH(ST HELENA), TJ(TAJIKISTAN), TH(THAILAND), TZ(TANZANIA), TC(TURKS AND CAICOS ISLANDS), TG(TOGO), TO(TONGA), TT(TRINIDAD AND TOBAGO), TN(TUNISIA), TR(TURKEY), TM(TURKMENISTAN), TV(TUVALU), UG(UGANDA), UA(UKRAINE), HU(HUNGARY), UY(URUGUAY), UZ(UZBEKISTAN), DE(GERMANY), VU(VANUATU), VA(VATICAN), VE(VENEZUELA), VN(VIETNAM), WF(WALLIS AND FUTUNA ISLANDS), SB(SOLOMON ISLANDS), ZM(ZAMBIA), SE(SWEDEN), TW(TAIWAN), AD(ANDORRA), CW(CURAÇAO), SM(SAN MARINO), XI(NORTHERN IRELAND (GREAT BRITAIN)), GU(GUAM), AX(Aland Islands), BQ(BONAIRE), JE(Jersey), GG(GUERNSEY), CK(COOK ISLANDS), MH(MARSHALL ISLANDS), IM(Isle of Man), NU(NIUE ISLAND), NF(Norfolk Island), PW(Palau), PS(Palestine, State of), PR(PUERTO RICO), SX(Sint Maarten (Dutch part)), SJ(Svalbard and Jan Mayen), TK(Tokelau), CX(Christmas Island), ZW(ZIMBABWE), 10(THE AZORES (PORTUGAL)), 11(MADEIRA (PORTUGAL)), 12(BALEARIC ISLANDS (SPAIN)), 19(CANARY ISLANDS), 22(MELILLA (SPAIN)), 25(CEUTA (SPAIN)), 27(HAWAII (US)), VI(VIRGIN ISLANDS (US)), TF(FRENCH SOUTHERN AND ANTARCTIC LANDS), BL(SAINT BARTHELEMY (FRANCE)), XK(KOSOVA), FM(FEDERATED STATES OF MICRONESIA), MF(SAINT-MARTIN (FRANCE)), MP(COMMONWEALTH OF THE NORTHERN MARIANA ISLANDS), TL(TIMORA-LESTE), GS(SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS), IO(British Indian Ocean Territory), SS(South Sudan), AS(American Samoa), ]	Country code
package_create[addresses][][freeformAddressLine1]	string	true		Freeform address line 1 (65 characters max)
package_create[addresses][][freeformAddressLine2]	string	true		Freeform address line 2 (65 characters max)
package_create[addresses][][postCode]	string	true		Postal code
package_create[addresses][][name] OR package_create[addresses][][company]	string	true		Name OR Company name
package_create[addresses][][phone]	string	false		Phone number
package_create[addresses][][email]	string	false		E-mail address
package_create[addresses][][contentType]	choice	false	["Gift","Documents","Returned goods","Other"]	Type of postal item contents (usually required for international shipments)
package_create[addresses][][userPackageWeight]	float	true		Package weight (usually required for international shipments)
package_create[addresses][][contentItems][]	array of objects (ContentItemType)	false		Array of package content items for this address (usually required for international shipments)
package_create[addresses][][contentItems][][name]	string	false		Item name
package_create[addresses][][contentItems][][quantity]	string	false		Quantity
package_create[addresses][][contentItems][][weight]	float	false		Weight (g)
package_create[addresses][][contentItems][][value]	float	false		Value (€)
package_create[addresses][][contentItems][][hsCode]	string	false		HS tariff No.
package_create[addresses][][contentItems][][country]	choice	false	[ LV(LATVIA), AF(AFGHANISTAN), AL(ALBANIA), DZ(ALGERIA), AI(ANGUILLA), AO(ANGOLA), AG(ANTIGUA AND BARBUDA), AE(UNITED ARAB EMIRATES), AR(ARGENTINA), AM(ARMENIA), AW(ARUBA), US(USA), AU(AUSTRALIA), AT(AUSTRIA), AZ(AZERBAIJAN), BS(BAHAMAS), BH(BAHRAIN), BY(BELARUS), BD(BANGLADESH), BB(BARBADOS), BE(BELGIUM), BZ(BELIZE), BJ(BENIN), BM(BERMUDA ISLANDS), BO(BOLIVIA), BA(BOSNIA AND HERZEGOVINA), BW(BOTSWANA), BR(BRAZIL), VG(BRITISH VIRGIN ISLANDS), BN(BRUNEI DARUSSALAM), BG(BULGARIA), BF(BURKINA FASO), BI(BURUNDI), BT(BHUTAN), TD(CHAD), CZ(CZECH REPUBLIC), CF(CENTRAL AFRICAN REP.), CL(CHILE), DK(DENMARK), ZA(SOUTH AFRICA), DM(DOMINICA), DO(DOMINICAN REP.), DJ(DJIBOUTI), EG(EGYPT), EC(ECUADOR), GQ(EQUATORIAL GUINEA), ER(ERITREA), ET(ETHIOPIA), FO(FAROE ISLANDS), FJ(FIJI), PH(PHILIPPINES), FK(FALKLAND ISLANDS), FR(FRANCE), GF(FRENCH GUIANA), PF(FRENCH POLYNESIA), GA(GABON), GY(GUYANA), GM(GAMBIA), GH(GHANA), GI(GIBRALTAR), GD(GRENADA), GL(GREENLAND), GR(GREECE), GE(GEORGIA), GP(GUADELOUPE), GT(GUATEMALA), GN(GUINEA), GW(GUINEA-BISSAU), HT(HAITI), HN(HONDURAS), HK(HONG KONG), HR(CROATIA), EE(ESTONIA), IN(INDIA), ID(INDONESIA), IQ(IRAQ), IR(IRAN), IE(IRELAND), IS(ICELAND), IT(ITALY), IL(ISRAEL), JM(JAMAICA), JP(JAPAN), NC(NEW CALEDONIA), NZ(NEW ZEALAND), YE(YEMEN), JO(JORDAN), CV(CAPE VERDE), KY(CAYMAN ISLANDS), KH(CAMBODIA), CM(CAMEROON), CA(CANADA), QA(QATAR), KZ(KAZAKHSTAN), KE(KENYA), CN(CHINA), CY(CYPRUS), KG(KYRGYZSTAN), KI(KIRIBATI), CO(COLOMBIA), KM(COMOROS), CG(CONGO), CD(CONGO (DEM. REP.)), KR(KOREA (REP.)), KP(DPR KOREA), CR(COSTA RICA), CI(COTE D'IVOIRE), RU(RUSSIA), CU(CUBA), KW(KUWAIT), LA(LAO PDR), LS(LESOTHO), LB(LEBANON), LR(LIBERIA), LY(LIBYA), GB(GREAT BRITAIN), LT(LITHUANIA), LI(LIECHTENSTEIN), LU(LUXEMBOURG), MG(MADAGASCAR), YT(MAYOTTE), MO(MACAO, CHINA), MK(NORTH MACEDONIA), MY(MALAYSIA), MW(MALAWI), MV(MALDIVES), ML(MALI), MT(MALTA), MA(MOROCCO), MQ(MARTINIQUE), MU(MAURITIUS), MR(MAURITANIA), MX(MEXICO), ME(MONTENEGRO), MM(MYANMAR), MD(MOLDOVA), MC(MONACO), MN(MONGOLIA), MS(MONTSERRAT), MZ(MOZAMBIQUE), NA(NAMIBIA), NR(NAURU), NP(NEPAL), NL(NETHERLANDS), NE(NIGER), NG(NIGERIA), NI(NICARAGUA), NO(NORWAY), OM(OMAN), PK(PAKISTAN), PA(PANAMA), PG(PAPUA NEW GUINEA), PY(PARAGUAY), PE(PERU), PN(PITCAIRN), PL(POLAND), PT(PORTUGAL), RE(RÉUNION), RW(RWANDA), RO(ROMANIA), SV(EL SALVADOR), ST(SAO TOME AND PRINCIPE), SA(SAUDI ARABIA), SC(SEYCHELLES), SN(SENEGAL), PM(ST PIERRE AND MIQUELON), KN(ST KITTS AND NEVIS), LC(SAINT LUCIA), VC(SAINT VINCENT AND THE GRENADINES), RS(SERBIA), SG(SINGAPORE), SY(SYRIA), SL(SIERRA LEONE), SK(SLOVAKIA), SI(SLOVENIA), SO(SOMALIA), FI(FINLAND), ES(SPAIN), LK(SRI LANKA), SD(SUDAN), SR(SURINAME), SZ(SWAZILAND), CH(SWITZERLAND), SH(ST HELENA), TJ(TAJIKISTAN), TH(THAILAND), TZ(TANZANIA), TC(TURKS AND CAICOS ISLANDS), TG(TOGO), TO(TONGA), TT(TRINIDAD AND TOBAGO), TN(TUNISIA), TR(TURKEY), TM(TURKMENISTAN), TV(TUVALU), UG(UGANDA), UA(UKRAINE), HU(HUNGARY), UY(URUGUAY), UZ(UZBEKISTAN), DE(GERMANY), VU(VANUATU), VA(VATICAN), VE(VENEZUELA), VN(VIETNAM), WF(WALLIS AND FUTUNA ISLANDS), SB(SOLOMON ISLANDS), ZM(ZAMBIA), SE(SWEDEN), TW(TAIWAN), AD(ANDORRA), CW(CURAÇAO), SM(SAN MARINO), XI(NORTHERN IRELAND (GREAT BRITAIN)), GU(GUAM), AX(Aland Islands), BQ(BONAIRE), JE(Jersey), GG(GUERNSEY), CK(COOK ISLANDS), MH(MARSHALL ISLANDS), IM(Isle of Man), NU(NIUE ISLAND), NF(Norfolk Island), PW(Palau), PS(Palestine, State of), PR(PUERTO RICO), SX(Sint Maarten (Dutch part)), SJ(Svalbard and Jan Mayen), TK(Tokelau), CX(Christmas Island), ZW(ZIMBABWE), 10(THE AZORES (PORTUGAL)), 11(MADEIRA (PORTUGAL)), 12(BALEARIC ISLANDS (SPAIN)), 19(CANARY ISLANDS), 22(MELILLA (SPAIN)), 25(CEUTA (SPAIN)), 27(HAWAII (US)), VI(VIRGIN ISLANDS (US)), TF(FRENCH SOUTHERN AND ANTARCTIC LANDS), BL(SAINT BARTHELEMY (FRANCE)), XK(KOSOVA), FM(FEDERATED STATES OF MICRONESIA), MF(SAINT-MARTIN (FRANCE)), MP(COMMONWEALTH OF THE NORTHERN MARIANA ISLANDS), TL(TIMORA-LESTE), GS(SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS), IO(British Indian Ocean Territory), SS(South Sudan), AS(American Samoa), ]	Country of origin
package_create[addresses][][commercial]	boolean	false		Add if package contents are commercial items
package_create[addresses][][returnable]	boolean	false		Additional service - add return label to package documents if return is available for "countryCode" Default: false Ignored if not used
package_create[addresses][][returnDays]	integer	false		Number of days that the return service will be available Default: defined in user profile Ignored if not returnable
package_create[addresses][][returnServices]	choice	false *	["AD", "AK", "AN", "AP"]	Return services * Required for local returns
package_create[addresses][][returnSmsCode]	boolean	false		Return code must be specified in the SMS * For local returns Default: false
package_create[noAddresses][][code]	choice	true	country code [ LV(LATVIA), AF(AFGHANISTAN), AL(ALBANIA), DZ(ALGERIA), AI(ANGUILLA), AO(ANGOLA), AG(ANTIGUA AND BARBUDA), AE(UNITED ARAB EMIRATES), AR(ARGENTINA), AM(ARMENIA), AW(ARUBA), US(USA), AU(AUSTRALIA), AT(AUSTRIA), AZ(AZERBAIJAN), BS(BAHAMAS), BH(BAHRAIN), BY(BELARUS), BD(BANGLADESH), BB(BARBADOS), BE(BELGIUM), BZ(BELIZE), BJ(BENIN), BM(BERMUDA ISLANDS), BO(BOLIVIA), BA(BOSNIA AND HERZEGOVINA), BW(BOTSWANA), BR(BRAZIL), VG(BRITISH VIRGIN ISLANDS), BN(BRUNEI DARUSSALAM), BG(BULGARIA), BF(BURKINA FASO), BI(BURUNDI), BT(BHUTAN), TD(CHAD), CZ(CZECH REPUBLIC), CF(CENTRAL AFRICAN REP.), CL(CHILE), DK(DENMARK), ZA(SOUTH AFRICA), DM(DOMINICA), DO(DOMINICAN REP.), DJ(DJIBOUTI), EG(EGYPT), EC(ECUADOR), GQ(EQUATORIAL GUINEA), ER(ERITREA), ET(ETHIOPIA), FO(FAROE ISLANDS), FJ(FIJI), PH(PHILIPPINES), FK(FALKLAND ISLANDS), FR(FRANCE), GF(FRENCH GUIANA), PF(FRENCH POLYNESIA), GA(GABON), GY(GUYANA), GM(GAMBIA), GH(GHANA), GI(GIBRALTAR), GD(GRENADA), GL(GREENLAND), GR(GREECE), GE(GEORGIA), GP(GUADELOUPE), GT(GUATEMALA), GN(GUINEA), GW(GUINEA-BISSAU), HT(HAITI), HN(HONDURAS), HK(HONG KONG), HR(CROATIA), EE(ESTONIA), IN(INDIA), ID(INDONESIA), IQ(IRAQ), IR(IRAN), IE(IRELAND), IS(ICELAND), IT(ITALY), IL(ISRAEL), JM(JAMAICA), JP(JAPAN), NC(NEW CALEDONIA), NZ(NEW ZEALAND), YE(YEMEN), JO(JORDAN), CV(CAPE VERDE), KY(CAYMAN ISLANDS), KH(CAMBODIA), CM(CAMEROON), CA(CANADA), QA(QATAR), KZ(KAZAKHSTAN), KE(KENYA), CN(CHINA), CY(CYPRUS), KG(KYRGYZSTAN), KI(KIRIBATI), CO(COLOMBIA), KM(COMOROS), CG(CONGO), CD(CONGO (DEM. REP.)), KR(KOREA (REP.)), KP(DPR KOREA), CR(COSTA RICA), CI(COTE D'IVOIRE), RU(RUSSIA), CU(CUBA), KW(KUWAIT), LA(LAO PDR), LS(LESOTHO), LB(LEBANON), LR(LIBERIA), LY(LIBYA), GB(GREAT BRITAIN), LT(LITHUANIA), LI(LIECHTENSTEIN), LU(LUXEMBOURG), MG(MADAGASCAR), YT(MAYOTTE), MO(MACAO, CHINA), MK(NORTH MACEDONIA), MY(MALAYSIA), MW(MALAWI), MV(MALDIVES), ML(MALI), MT(MALTA), MA(MOROCCO), MQ(MARTINIQUE), MU(MAURITIUS), MR(MAURITANIA), MX(MEXICO), ME(MONTENEGRO), MM(MYANMAR), MD(MOLDOVA), MC(MONACO), MN(MONGOLIA), MS(MONTSERRAT), MZ(MOZAMBIQUE), NA(NAMIBIA), NR(NAURU), NP(NEPAL), NL(NETHERLANDS), NE(NIGER), NG(NIGERIA), NI(NICARAGUA), NO(NORWAY), OM(OMAN), PK(PAKISTAN), PA(PANAMA), PG(PAPUA NEW GUINEA), PY(PARAGUAY), PE(PERU), PN(PITCAIRN), PL(POLAND), PT(PORTUGAL), RE(RÉUNION), RW(RWANDA), RO(ROMANIA), SV(EL SALVADOR), ST(SAO TOME AND PRINCIPE), SA(SAUDI ARABIA), SC(SEYCHELLES), SN(SENEGAL), PM(ST PIERRE AND MIQUELON), KN(ST KITTS AND NEVIS), LC(SAINT LUCIA), VC(SAINT VINCENT AND THE GRENADINES), RS(SERBIA), SG(SINGAPORE), SY(SYRIA), SL(SIERRA LEONE), SK(SLOVAKIA), SI(SLOVENIA), SO(SOMALIA), FI(FINLAND), ES(SPAIN), LK(SRI LANKA), SD(SUDAN), SR(SURINAME), SZ(SWAZILAND), CH(SWITZERLAND), SH(ST HELENA), TJ(TAJIKISTAN), TH(THAILAND), TZ(TANZANIA), TC(TURKS AND CAICOS ISLANDS), TG(TOGO), TO(TONGA), TT(TRINIDAD AND TOBAGO), TN(TUNISIA), TR(TURKEY), TM(TURKMENISTAN), TV(TUVALU), UG(UGANDA), UA(UKRAINE), HU(HUNGARY), UY(URUGUAY), UZ(UZBEKISTAN), DE(GERMANY), VU(VANUATU), VA(VATICAN), VE(VENEZUELA), VN(VIETNAM), WF(WALLIS AND FUTUNA ISLANDS), SB(SOLOMON ISLANDS), ZM(ZAMBIA), SE(SWEDEN), TW(TAIWAN), AD(ANDORRA), CW(CURAÇAO), SM(SAN MARINO), XI(NORTHERN IRELAND (GREAT BRITAIN)), GU(GUAM), AX(Aland Islands), BQ(BONAIRE), JE(Jersey), GG(GUERNSEY), CK(COOK ISLANDS), MH(MARSHALL ISLANDS), IM(Isle of Man), NU(NIUE ISLAND), NF(Norfolk Island), PW(Palau), PS(Palestine, State of), PR(PUERTO RICO), SX(Sint Maarten (Dutch part)), SJ(Svalbard and Jan Mayen), TK(Tokelau), CX(Christmas Island), ZW(ZIMBABWE), 10(THE AZORES (PORTUGAL)), 11(MADEIRA (PORTUGAL)), 12(BALEARIC ISLANDS (SPAIN)), 19(CANARY ISLANDS), 22(MELILLA (SPAIN)), 25(CEUTA (SPAIN)), 27(HAWAII (US)), VI(VIRGIN ISLANDS (US)), TF(FRENCH SOUTHERN AND ANTARCTIC LANDS), BL(SAINT BARTHELEMY (FRANCE)), XK(KOSOVA), FM(FEDERATED STATES OF MICRONESIA), MF(SAINT-MARTIN (FRANCE)), MP(COMMONWEALTH OF THE NORTHERN MARIANA ISLANDS), TL(TIMORA-LESTE), GS(SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS), IO(British Indian Ocean Territory), SS(South Sudan), AS(American Samoa), ] lv post code ["LV-1001", "LV-1002", "LV-1003", "LV-1004", "LV-1005", "LV-1006", "LV-1007", "LV-1009", "LV-1010", "LV-1011", "LV-1012", "LV-1013", "LV-1014", "LV-1015", "LV-1016", "LV-1017", "LV-1019", "LV-1021", "LV-1023", "LV-1024", "LV-1025", "LV-1026", "LV-1027", "LV-1028", "LV-1029", "LV-1030", "LV-1034", "LV-1035", "LV-1038", "LV-1039", "LV-1044", "LV-1045", "LV-1046", "LV-1048", "LV-1050", "LV-1051", "LV-1053", "LV-1055", "LV-1057", "LV-1058", "LV-1063", "LV-1064", "LV-1067", "LV-1069", "LV-1073", "LV-1076", "LV-1079", "LV-1082", "LV-1083", "LV-1084", "LV-2101", "LV-2107", "LV-2111", "LV-2112", "LV-2128", "LV-2130", "LV-2166", "LV-2167", "LV-2008", "LV-2010", "LV-2011", "LV-2012", "LV-2015", "LV-2016", "LV-2103", "LV-2105", "LV-2108", "LV-2113", "LV-2114", "LV-2117", "LV-2118", "LV-2119", "LV-2121", "LV-2123", "LV-2124", "LV-2125", "LV-2127", "LV-2133", "LV-2135", "LV-2136", "LV-2137", "LV-2140", "LV-2141", "LV-2142", "LV-2144", "LV-2145", "LV-2150", "LV-2151", "LV-2152", "LV-2154", "LV-2160", "LV-2161", "LV-2162", "LV-2163", "LV-2164", "LV-2169", "LV-2170", "LV-3001", "LV-3002", "LV-3003", "LV-3004", "LV-3005", "LV-3007", "LV-3008", "LV-3018", "LV-3101", "LV-3104", "LV-3201", "LV-3301", "LV-3401", "LV-3402", "LV-3403", "LV-3405", "LV-3407", "LV-3411", "LV-3412", "LV-3414", "LV-3416", "LV-3430", "LV-3601", "LV-3602", "LV-3604", "LV-3605", "LV-3701", "LV-3801", "LV-3862", "LV-3901", "LV-4001", "LV-4101", "LV-4102", "LV-4103", "LV-4201", "LV-4301", "LV-4401", "LV-4501", "LV-4601", "LV-4604", "LV-4701", "LV-4801", "LV-5001", "LV-5003", "LV-5015", "LV-5041", "LV-5101", "LV-5201", "LV-5202", "LV-5204", "LV-5206", "LV-5301", "LV-5401", "LV-5404", "LV-5405", "LV-5410", "LV-5412", "LV-5413", "LV-5414", "LV-5415", "LV-5417", "LV-5418", "LV-5420", "LV-5422", "LV-5601", "LV-5701", "LV-3011", "LV-3014", "LV-3016", "LV-3017", "LV-3020", "LV-3021", "LV-3022", "LV-3023", "LV-3024", "LV-3026", "LV-3028", "LV-3031", "LV-3034", "LV-3036", "LV-3037", "LV-3040", "LV-3042", "LV-3043", "LV-3045", "LV-3110", "LV-3113", "LV-3118", "LV-3119", "LV-3120", "LV-3122", "LV-3123", "LV-3124", "LV-3128", "LV-3129", "LV-3131", "LV-3132", "LV-3133", "LV-3134", "LV-3135", "LV-3137", "LV-3139", "LV-3140", "LV-3142", "LV-3145", "LV-3146", "LV-3147", "LV-3148", "LV-3251", "LV-3253", "LV-3257", "LV-3258", "LV-3260", "LV-3261", "LV-3262", "LV-3264", "LV-3270", "LV-3275", "LV-3280", "LV-3281", "LV-3283", "LV-3284", "LV-3285", "LV-3287", "LV-3291", "LV-3292", "LV-3294", "LV-3297", "LV-3298", "LV-3306", "LV-3307", "LV-3309", "LV-3310", "LV-3312", "LV-3313", "LV-3314", "LV-3317", "LV-3319", "LV-3320", "LV-3321", "LV-3322", "LV-3323", "LV-3324", "LV-3325", "LV-3326", "LV-3328", "LV-3329", "LV-3330", "LV-3332", "LV-3333", "LV-3431", "LV-3433", "LV-3434", "LV-3435", "LV-3436", "LV-3438", "LV-3440", "LV-3441", "LV-3442", "LV-3443", "LV-3444", "LV-3445", "LV-3446", "LV-3447", "LV-3452", "LV-3453", "LV-3455", "LV-3456", "LV-3457", "LV-3461", "LV-3463", "LV-3466", "LV-3473", "LV-3474", "LV-3475", "LV-3476", "LV-3477", "LV-3480", "LV-3482", "LV-3484", "LV-3485", "LV-3486", "LV-3487", "LV-3612", "LV-3613", "LV-3614", "LV-3615", "LV-3617", "LV-3619", "LV-3620", "LV-3621", "LV-3623", "LV-3624", "LV-3626", "LV-3627", "LV-3708", "LV-3709", "LV-3710", "LV-3711", "LV-3713", "LV-3714", "LV-3716", "LV-3717", "LV-3718", "LV-3719", "LV-3721", "LV-3722", "LV-3723", "LV-3724", "LV-3725", "LV-3729", "LV-3730", "LV-3731", "LV-3732", "LV-3851", "LV-3852", "LV-3853", "LV-3861", "LV-3871", "LV-3873", "LV-3875", "LV-3876", "LV-3880", "LV-3882", "LV-3883", "LV-3890", "LV-3891", "LV-3892", "LV-3893", "LV-3894", "LV-3895", "LV-3896", "LV-3897", "LV-3898", "LV-3899", "LV-3905", "LV-3906", "LV-3907", "LV-3908", "LV-3910", "LV-3913", "LV-3914", "LV-3915", "LV-3917", "LV-3918", "LV-3921", "LV-3924", "LV-3925", "LV-3926", "LV-3927", "LV-3929", "LV-3930", "LV-3931", "LV-3932", "LV-3933", "LV-3936", "LV-4004", "LV-4010", "LV-4011", "LV-4012", "LV-4013", "LV-4020", "LV-4022", "LV-4023", "LV-4025", "LV-4033", "LV-4035", "LV-4043", "LV-4050", "LV-4052", "LV-4054", "LV-4061", "LV-4063", "LV-4064", "LV-4068", "LV-4108", "LV-4110", "LV-4112", "LV-4113", "LV-4116", "LV-4118", "LV-4119", "LV-4122", "LV-4123", "LV-4125", "LV-4126", "LV-4128", "LV-4129", "LV-4131", "LV-4132", "LV-4133", "LV-4136", "LV-4139", "LV-4141", "LV-4143", "LV-4144", "LV-4146", "LV-4151", "LV-4152", "LV-4154", "LV-4206", "LV-4208", "LV-4210", "LV-4211", "LV-4213", "LV-4215", "LV-4216", "LV-4219", "LV-4220", "LV-4222", "LV-4223", "LV-4224", "LV-4227", "LV-4228", "LV-4232", "LV-4234", "LV-4240", "LV-4241", "LV-4242", "LV-4244", "LV-4245", "LV-4247", "LV-4248", "LV-4332", "LV-4333", "LV-4335", "LV-4336", "LV-4337", "LV-4339", "LV-4340", "LV-4341", "LV-4342", "LV-4344", "LV-4345", "LV-4348", "LV-4350", "LV-4351", "LV-4352", "LV-4354", "LV-4355", "LV-4358", "LV-4359", "LV-4405", "LV-4406", "LV-4409", "LV-4410", "LV-4412", "LV-4415", "LV-4416", "LV-4417", "LV-4420", "LV-4421", "LV-4424", "LV-4425", "LV-4426", "LV-4428", "LV-4429", "LV-4561", "LV-4562", "LV-4566", "LV-4567", "LV-4570", "LV-4571", "LV-4572", "LV-4573", "LV-4574", "LV-4576", "LV-4577", "LV-4580", "LV-4582", "LV-4583", "LV-4584", "LV-4585", "LV-4586", "LV-4587", "LV-4590", "LV-4591", "LV-4592", "LV-4594", "LV-4595", "LV-4611", "LV-4612", "LV-4614", "LV-4615", "LV-4616", "LV-4617", "LV-4618", "LV-4619", "LV-4621", "LV-4622", "LV-4623", "LV-4625", "LV-4626", "LV-4627", "LV-4628", "LV-4630", "LV-4631", "LV-4633", "LV-4634", "LV-4635", "LV-4636", "LV-4638", "LV-4640", "LV-4641", "LV-4642", "LV-4643", "LV-4645", "LV-4647", "LV-4648", "LV-4649", "LV-4650", "LV-4652", "LV-4706", "LV-4707", "LV-4708", "LV-4711", "LV-4712", "LV-4713", "LV-4715", "LV-4716", "LV-4718", "LV-4723", "LV-4724", "LV-4726", "LV-4727", "LV-4728", "LV-4729", "LV-4730", "LV-4731", "LV-4733", "LV-4735", "LV-4824", "LV-4825", "LV-4826", "LV-4830", "LV-4833", "LV-4834", "LV-4835", "LV-4836", "LV-4837", "LV-4838", "LV-4840", "LV-4841", "LV-4844", "LV-4846", "LV-4847", "LV-4852", "LV-4853", "LV-4855", "LV-4860", "LV-4862", "LV-4863", "LV-4865", "LV-4870", "LV-4871", "LV-4873", "LV-4880", "LV-4884", "LV-5011", "LV-5012", "LV-5016", "LV-5020", "LV-5022", "LV-5033", "LV-5044", "LV-5045", "LV-5047", "LV-5052", "LV-5060", "LV-5062", "LV-5064", "LV-5065", "LV-5070", "LV-5071", "LV-5106", "LV-5108", "LV-5109", "LV-5110", "LV-5111", "LV-5112", "LV-5113", "LV-5115", "LV-5118", "LV-5120", "LV-5123", "LV-5124", "LV-5125", "LV-5128", "LV-5129", "LV-5130", "LV-5133", "LV-5134", "LV-5135", "LV-5208", "LV-5209", "LV-5210", "LV-5211", "LV-5212", "LV-5214", "LV-5215", "LV-5216", "LV-5217", "LV-5218", "LV-5220", "LV-5221", "LV-5222", "LV-5223", "LV-5224", "LV-5226", "LV-5228", "LV-5229", "LV-5230", "LV-5232", "LV-5236", "LV-5237", "LV-5238", "LV-5239", "LV-5304", "LV-5305", "LV-5311", "LV-5312", "LV-5315", "LV-5316", "LV-5318", "LV-5320", "LV-5323", "LV-5325", "LV-5326", "LV-5327", "LV-5328", "LV-5329", "LV-5330", "LV-5331", "LV-5333", "LV-5334", "LV-5335", "LV-5337", "LV-5438", "LV-5439", "LV-5440", "LV-5441", "LV-5442", "LV-5443", "LV-5444", "LV-5447", "LV-5449", "LV-5450", "LV-5451", "LV-5456", "LV-5458", "LV-5459", "LV-5460", "LV-5461", "LV-5462", "LV-5463", "LV-5465", "LV-5469", "LV-5470", "LV-5471", "LV-5473", "LV-5474", "LV-5477", "LV-5481", "LV-5651", "LV-5652", "LV-5653", "LV-5655", "LV-5656", "LV-5660", "LV-5662", "LV-5664", "LV-5666", "LV-5668", "LV-5671", "LV-5674", "LV-5676", "LV-5677", "LV-5680", "LV-5681", "LV-5685", "LV-5687", "LV-5692", "LV-5695", "LV-5696", "LV-5697", "LV-5698", "LV-5704", "LV-5705", "LV-5706", "LV-5707", "LV-5709", "LV-5711", "LV-5716", "LV-5717", "LV-5719", "LV-5722", "LV-5725", "LV-5726", "LV-5729", "LV-5730", "LV-5732", "LV-5733", "LV-5735", "LV-5736", "LV-5737", "LV-5739", "LV-5740", "LV-5742", "LV-5745", "LV-5748", "LV-5750", "LV-5751", "LV-5752" ]	Valid country code or if package_create[ap] mark is provided valid LV post code
package_create[noAddresses][][weightTo]	integer	true		Weight limit
package_create[noAddresses][][count]	integer	true		Package count
package_create[type]	choice	true	["Letters","Goods"]	Type of postal item
package_create[weightTo]	choice	false	["20","100","500","1000","2000","3000","4000","5000","6000","7000","8000","9000","10000","11000","12000","13000","14000","15000","16000","17000","18000","19000","20000","21000","22000","23000","24000","25000","26000","27000","28000","29000","30000"]	Weight upper limit (allowed values depend on package addresses and type)
package_create[postageType]	choice	true	["Insured","Registered","Ordinary","Tracked"]	Postage type (allowed values depend on package addresses, type, weight, delivery class)
package_create[itemType]	choice	true	["Letter","Parcel"]	Postal item type (allowed values depend on package addresses, type, weight, delivery class, postage type)
package_create[adviceOfDelivery]	boolean	false		Additional service - add if a written confirmation that the addressee has received the postal item is required Default: false Ignored if not used
package_create[cashOnDelivery]	boolean	false		Additional service - add if it is neccessary to receive cash-on-delivery from the addressee. The addressee receives the item only after paying the COD amount you have specified. This amount may not exceed the insurance amount of the postal item Default: false Ignored if not used
package_create[confirmationOfContents]	boolean	false		Additional service - add if it is neccessary for a postal worker to confirm the contents of the postal item Default: false Ignored if not used
package_create[fragile]	boolean	false		Additional service - add if parcel is fragile and special care is needed throughout the delivery. Pack the parcel according to its weight, shape and content to ensure its preservation during the transportation. Otherwise, a postal worker can refuse accepting the particular item Default: false Ignored if not used
package_create[insurance]	string	false		Amount, for which to insure the postal item (allowed max insurance depends on package addresses, item type, postage type)
package_create[cashOnDeliverySum]	float	false		Amount of cash-on-delivery (required if additional service "cash-on-delivery" has been added. Cannot be greater than insurance amount) Default: 0 Ignored if not used
package_create[comment]	string	false		Comment (allowed only if specific package documents are applicable)
package_create[paymentMethod]	choice	false	["Unpaid","Paid with postmarking machine"]	Payment method (allowed only if specific package documents are applicable)
package_create[ipt]	boolean	false		Special rates mark for cross border packages (allowed only if specific package rates are applicable)
package_create[apiz]	boolean	false		Special balanced rates mark for simple domestic shipments (allowed only if specific rates are applicable)

Return

Parameter	Type	Versions	Description
200 - Not reachable in this project
code	integer	*	Response code.
message	string	*	Message.
packageId	integer	*	Package ID.
addressBarcodes	array	*	Array of address IDs.
documents	array	*	Array of available document forms.

Status Codes

Status Code	Description
200	Not reachable in this project
201	New package created successfully, document request links returned
400	Invalid root data element
422	Root element OK, invalid data

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/packages/info beta

Requesting Package information

Parameters

Parameter	Type	Required?	Description
package_info	object (PackageInfoType)	true
package_info[user]	string	true	User ID
package_info[api_key]	string	true	API key
package_info[barcode]	string	true	Package barcode

Return

Parameter	Type	Versions	Description
200 - Package found
countryCode	string	*	Country code.
postCode	string	*	Postal code.
freeformAddressLine1	string	*	Freeform address line 1.
freeformAddressLine2	string	*	Freeform address line 2.
name	string	*	Name.
company	string	*	Company.
barcode	string	*	Barcode.
returnBarcode	string	*	Return label barcode.
comment	string	*	Comment.
contentType	string	*	Type of postal item contents (usually required for international shipments).
contentItems	array of objects (PackageContentItems)	*	Array of package content items for this address (usually required for international shipments).
contentItems[name]	string	*	Item name.
contentItems[value]	float	*	Value (€).
contentItems[weight]	float	*	Weight (g).
contentItems[quantity]	integer	*	Quantity.
contentItems[hsCode]	string	*	HS tariff No.
contentItems[country]	string	*	Country of origin.
type	string	*	Type of postal item.
deliveryClass	string	*	Delivery class.
postageType	string	*	Postage type (values depend on package addresses, type, weight, delivery class).
itemType	string	*	Postal item type (values depend on package addresses, type, weight, delivery class, postage type).

Status Codes

Status Code	Description
200	Package found
403	Invalid credentials
404	No Package found
422	Invalid request data
500	Accepted, but server failed to fulfill request

POST /api/return-label beta

Creating a new Return label

Parameters

Parameter	Type	Required?	Format	Description
return_label	object (ReturnLabelCreateType)	true
return_label[user]	string	true		User ID
return_label[api_key]	string	true		API key
return_label[contractNumber]	string	false *		Contract number * Required for IBRS and local returns
return_label[shipmentType]	choice	true	["V", "R", "I", "T"]	Shipment type V - ordinary R - registered I - insured T - tracked
return_label[shipmentName]	choice	true	["P", "KP", "KD"]	Shipment name P - parcel KP - letter (items) KD - letter (documents)
return_label[weight]	float	false		Total weight (g)
return_label[returnDays]	choice	true	[7, 14, 30, 90]	Return days
return_label[services]	choice	false *	["AD", "AK", "AN", "AP"]	Return services * Required for local returns
return_label[smsCode]	boolean	false *		Return code must be specified in the SMS * Required for local returns
return_label[contentItems][]	array of objects (ContentItemType)	false		Array of package content items for this address (usually required for international shipments)
return_label[contentItems][][name]	string	false		Item name
return_label[contentItems][][quantity]	string	false		Quantity
return_label[contentItems][][weight]	float	false		Weight (g)
return_label[contentItems][][value]	float	false		Value (€)
return_label[contentItems][][hsCode]	string	false		HS tariff No.
return_label[contentItems][][country]	choice	false	["LV","AF","AL","DZ","AI","AO","AG","AE","AR","AM","AW","US","AU","AT","AZ","BS","BH","_B","BY","BD","BB","BE","BZ","BJ","BM","BO","BA","BW","BR","VG","BN","BG","BF","BI","BT","TD","CZ","CF","CL","DK","AC","ZA","DM","DO","DJ","EG","EC","GQ","ER","_E","ET","FO","FJ","PH","FK","FR","GF","PF","GA","GY","GM","GH","GI","GD","GL","GR","GE","GP","GT","GN","GW","HT","HN","HK","HR","EE","IN","ID","IQ","IR","IE","IS","IT","IL","JM","JP","NC","NZ","YE","JO","CV","KY","KH","CM","CA","QA","KZ","KE","CN","CY","KG","KI","CO","KM","CG","CD","KR","KP","CR","CI","RU","CU","KW","LA","LS","LB","LR","LY","GB","LT","LI","LU","MG","YT","MO","MK","MY","MW","MV","ML","MT","MA","MQ","MU","MR","MX","ME","MM","MD","MC","MN","MS","MZ","NA","NR","NP","NL","NE","NG","NI","NO","OM","PK","PA","PG","PY","_O","PE","PN","PL","PT","RE","RW","RO","SV","WS","ST","SA","SC","SN","PM","KN","LC","VC","RS","SG","SY","SL","SK","SI","SO","FI","ES","LK","SD","SR","SZ","CH","SH","TJ","TH","TZ","TC","TG","TO","TT","TA","TN","TR","TM","TV","UG","UA","HU","UY","UZ","DE","VU","VA","VE","VN","WF","SB","ZM","ZW","SE","_G","_N","SM","TL","TW","JE"]	Country of origin
return_label[sender]	object (ReturnLabelParticipantType)	true		Sender information
return_label[sender][name]	String	true		Name (40 characters max)
return_label[sender][phone]	String	false		Phone (20 characters max)
return_label[sender][email]	String	false		E-mail (30 characters max)
return_label[sender][freeformAddressLine1]	String	true		Freeform address line 1 (65 characters max)
return_label[sender][freeformAddressLine2]	String	false		Freeform address line 2 (65 characters max)
return_label[sender][country]	String	true		Country (2 characters max)
return_label[sender][postCode]	String	false		Postal code (9 characters max)
return_label[addressee]	object (ReturnLabelParticipantType)	true		Addressee information
return_label[addressee][name]	String	true		Name (40 characters max)
return_label[addressee][phone]	String	false		Phone (20 characters max)
return_label[addressee][email]	String	false		E-mail (30 characters max)
return_label[addressee][freeformAddressLine1]	String	true		Freeform address line 1 (65 characters max)
return_label[addressee][freeformAddressLine2]	String	false		Freeform address line 2 (65 characters max)
return_label[addressee][country]	String	true		Country (2 characters max)
return_label[addressee][postCode]	String	false		Postal code (9 characters max)

Return

Parameter	Type	Versions	Description
201 - Return label created
code	integer	*	Response code.
message	string	*	Message.
return_barcode	string	*	Return label barcode.
return_code	string	*	Return code (only for local returns)

Status Codes

Status Code	Description
200	Not reachable in this endpoint
201	New return label created successfully
206	Record created, but failed to load label. Barcode and label will not be available.
400	Invalid root data element
403	Invalid credentials
404	No Return label found
422	Root element OK, invalid data
500	Accepted, but server failed to fulfill request

POST /api/return-label/label beta

Requesting Return label (pdf)

Parameters

Parameter	Type	Required?	Description
return_label	object (ReturnLabelInfoType)	true
return_label[user]	string	true	User ID
return_label[api_key]	string	true	API key
return_label[barcode]	string	true	Return label barcode

Return

Parameter	Type	Versions	Description
200 - Return label found
attachment; filename=(filename).pdf	application/pdf	*	Generated return label (pdf).

Status Codes

Status Code	Description
200	Return label found
403	Invalid credentials
404	No Return label found
422	Invalid request data
500	Accepted, but server failed to fulfill request

GET /api/pack-station/package-collection/{collectionNumber} beta

Returning package collection info

Headers

Key	Value
Authorization	Bearer token

Parameters

Parameter	Type	Required?	Format	Description
collectionNumber	string	true	"MP00000000"	collection barcode (MP + 8 digits)

Return

Parameter	Type	Description
200 - package collection found
"sender": { "contractNumber": "string", "userInfo": { "type": "string", "firstName": "string", "lastName": "string", "email": "string", "telephone": "string", "legalForm": { "companyName": "string", "companyRegNr": "string" } }, "address": "string" }	object	Returns sender - contract number, user info and address. Possible user info types - individual and company.
orderListStatus	integer	Returns order list status. Possible cases: 0 - created 1 - processed 2 - partly processed 3 - auto-closed 4 - auto-closed on 5th day
orderListId	integer	returns order list ID
"receiver": { "name": "string", "address": "string" }	object	Returns receiver - name and address

Status Codes

Status Code	Description
200	Request successful
400	Invalid request data
401	Invalid credentials
404	Not found
500	Accepted, but server failed to fulfill request

POST /api/pack-station/insert-event beta

Requests insert event information

Headers

Key	Value
Authorization	Bearer token

Parameters

Parameter	Type	Required?	Format	Description
collectionNumber	string	true	"MP00000000"	collection barcode (MP + 8 digits)
packStationCode	string	true	"LV0000"	pack station code (LV + 4 digits)
createdAt	string	true	"Y-m-d H:i:s"	date and time of insert
lockerSizes	array	true	["XS","S","S2","M","L"]	locker size(s) where package collection was inserted in

Return

Status code: 204

Request successful, no content returned

Status Codes

Status Code	Description
204	Request successful. No content returned
400	Invalid request data
401	Invalid credentials
500	Accepted, but server failed to fulfill request

Mans Pasts 3 API

API

POST /api/list beta

Parameters

Return

200 - Barcode list found

Status Codes

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/combine-ps27 beta

Parameters

Return

201 - Download link created successfully

Status Codes

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/documents beta

Parameters

Return

200 - Not reachable in this project

Status Codes

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/packages beta

Parameters

Return

200 - Not reachable in this project

Status Codes

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/packages/info beta

Parameters

Return

200 - Package found

Status Codes

POST /api/return-label beta

Parameters

Return

201 - Return label created

Status Codes

POST /api/return-label/label beta

Parameters

Return

200 - Return label found

Status Codes

GET /api/pack-station/package-collection/{collectionNumber} beta

Headers

Parameters

Return

200 - package collection found

Status Codes

POST /api/pack-station/insert-event beta

Headers

Headers

Parameters

Return

Status Codes