Brexit – requirements for export and import clearance after 01-01-2021

On January 1, 2021, all shipments sent to the UK will be subject to export and import clearance in the UK. Therefore, we are introducing new requirements for the data provided when generating labels. There will be a need to provide new additional values and add at least one product.

In order to carry out the clearance, it is required to provide the EORI number and the UK VAT number. To simplify the changes, these values should be provided once in the user profile in the Global24 system .

The new changes will be implemented on December 29, 2020 (so that goods cleared after January 1, 2021, at the border will already have all the necessary data).

New required values

At least one product is required

Example request

{
    "userName": "username",
    "password": "password",
    "CreateShipmentsRequest002": {
        "shipmentType": "Delivery",
        "carrierName": "GB-ROYALMAIL",
        "shipperAddress": {
            "additionalDescription": "description"
        },
        "receiverAddress": {
            "nameOrCompany": "Birmingham Hippodrome",
            "additionalDescription": "description",
            "address1": "Hurst Street",
            "address2": "Southside",
            "city": "Birmingham",
            "zipCode": "B5 4TB",
            "region": "",
            "country": "GB",
            "email": "test@email.com",
            "phone": "123456765",
            "taxId": "",
            "pickupId": null
        },
        "invoiceNumber": "TT100/12/01/001",
        "orderValue": 100.50,
        "currency": "EUR",
        "payerAddress": null,
        "items": [
            {
                "referenceID": "GoLabel0000",
                "referenceID2": "",
                "type": "RP",
                "weight": "2.50",
                "products": [
                    {
                        "name": "turbocharger v1.3",
                        "number": "458152587412584",
                        "quantity": "1",
                        "price": 80.50,
                        "tariffCode": "85044030",
                        "originCountry": "DE",
                        "imageUrl": null
                    }
                ]
            }
        ],
        "serviceLevel": {
            "service": "T48"
        },
        "shipmentDescription1": "description",
        "shipmentDescription2": ""
    }
}
									

1.1 CreateShipment

The method allows you to generate shipments. Shipments will be created only when all parcel data passes the verification process. If an error occurs and you cannot create shipments, the corresponding error message will be sent back to XML.

Address to send the request to:

• production: https://gorest.goglobal24.com/create-shipment
• test: http://test-gorest.goglobal24.com/create-shipment

I. Request structure

The authorization structure is required for all requests. There are two ways to go through authorization in the GoLabel REST API. The first is the password and the username, while the second is the user's password. This data is provided by GoLabel administrators.

"hash": "{YourHash}",
"userName": "{YourUsername}",
"password": "{YourPassword}",

The correct part of the request contains the most important information.

Example:

"shipmentType":"Delivery",

Example:

"carrierName":"GB-ROYALMAIL",

Address fields are used in the data in the query containing information about the sender, payer and recipient. All address data of the sender on deliveries of „Delivery” type and in the address of the recipient of „Return” type with the exception of additionalDescription that will be supplemented with address data of foreign Global24 points.

Example:

	"shipperAddress": null,
	"receiverAddress":{
			"nameOrCompany":"Birmingham Hippodrome",
			"additionalDescription":"",
			"address1":"Hurst Street",
			"address2":"Southside",
			"city":"Birmingham",
			"zipCode":"B5 4TB",
			"region":"",
			"country":"GB",
			"email":"test@email.com",
			"phone":"123456765",
			"taxId":"",
			"pickupId":null
		},
	"payerAddress":null,

A table containing elements with the specification of the item (package).

A array containing elements with the specification of the products.

Example:

			"items":[
				{
					"referenceID":"GoLabel0001",
					"referenceID2":"",
					"type":"RP",
					"weight":"2.50"
				},
				{
					"referenceID":"GoLabel0002",
					"referenceID2":"",
					"type":"RP",
					"weight":"2.50",
					"products":[
			                	{
			                		"name": "turbocharger v1.3",
			                		"number": "458152587412584",
			                		"quantity": "1",
			                		"price": "1125.45",
			                		"tariffCode": "85044030",
			                		"originCountry": "DE",
			                		"imageUrl": "url_to_photo.com"
			                	},
			                	{
			                		"name": "socks",
			                		"number": "398155774553544",
			                		"quantity": "3"
			                	}
	                		]
				}
			],

Specifies the type of shipping service. Possible types for given couriers are presented in their detailed descriptions.

Example:

"service":"T48",

COD must include details such as amount and currency type. Possible currencies for specific couriers are outlined in their detailed descriptions.

Example:

	"cod":{
		"amount": 100,
		"currency": "EUR"
	}

Insurance must contain data such as amount and type of currency. Possible currencies for couriers are presented in their detailed descriptions.

Example:

	"insurance":{
		"description": "",
		"amount": 100,
		"currency": "EUR"
	}

It is possible to describe the package, the description will be displayed on the label with the couriers concerned.

Example:

	"shipmentDescription1":"Car parts",
	"shipmentDescription2":""

II. Example request

{
	"userName":"username",
	"password":"password",
	"CreateShipmentsRequest002":{
		"shipmentType":"Delivery",
		"carrierName":"DE-DHL",
		"shipperAddress":{
			  "additionalDescription":"description"
		},
		"receiverAddress":{
			  "nameOrCompany":"Kathleen",
			  "additionalDescription":"",
			  "address1":"Packstation 131",
			  "address2":"903729505",
			  "city":"Weil am Rhein",
			  "zipCode":"79576",
			  "region":"",
			  "country":"DE",
			  "email":"test@email.com",
			  "phone":"123456765",
			  "taxId":"",
			  "pickupId": null
		},
		"payerAddress":null,
		"items":[
			{
				"referenceID":"GoLabel00001",
				"referenceID2":"",
				"type":"NP",
				"weight":"1"
			},
            {
				"referenceID":"GoLabel00002",
				"referenceID2":"",
				"type":"NP",
				"weight":"2.5"
			}
		],
		"serviceLevel":{
			"service":"DST",
			"cod":null,
			"insurance":null
		},
		"shipmentDescription1":"description",
		"shipmentDescription2":""
	}
}

III. Response structure

The status of the request sent. Possible values:

• “OK” - request accepted successfully
• “Error” - the request was not accepted, the request needs to be modified

Error message or additional information related to shipping

Example:

	"message": {
        "uid": 14,
        "code": "E1108",
        "content": "The specified combination of the full zipCode and city could not be validated"
    }

A table containing feedback for a particular package. In case one packet does not have any errors, the other one does not create any of them.

Example:

	"responses": [
        {
            "referenceID": "GoLabel00001",
            "created": "2019-02-12",
            "message": {
                "uid": 46,
                "code": "G0032",
                "content": "ReferenceID already used."
            },
            "status": "Error",
            "id": 22674
        },
        {
            "referenceID": "GoLabel00002",
            "created": "2019-02-12",
            "status": "OK",
            "barcode": "123123123123",
            "tracking_number": "123123123",
            "id": 22675,
            "message": null
        }
    ],

IV. Example response

{
    "responses": [
        {
            "referenceID": "GoLabel00004",
            "created": "2019-02-12",
            "message": {
                "uid": 46,
                "code": "G0032",
                "content": "ReferenceID already used."
            },
            "status": "Error",
            "id": 22674
        },
        {
            "referenceID": "GoLabel00005",
            "created": "2019-02-12",
            "status": "OK",
            "barcode": "WW123123123123",
            "tracking_number": "WW123123123",
            "id": 22675,
            "message": null
        }
    ],
    "status": "Error",
    "message": {
        "uid": 46,
        "code": "G0032",
        "content": "ReferenceID already used."
    }
}

									

1.2 GetLabel

The method allows you to download individual or bulk shipping labels from the system. Completing this request is required for the package to appear in the courier's system. Labels can be generated in various formats and sizes.

Address to send the request to:

• production: https://gorest.goglobal24.com/get-label
• test: http://test-gorest.goglobal24.com/get-label

I. Request structure

The authorization structure is required for all requests. There are two ways to go through authorization in the GoLabel REST API. The first is the password and the username, while the second is the user's password. This data is provided by GoLabel administrators.

"hash": "{YourHash}",
"userName": "{YourUsername}",
"password": "{YourPassword}",

The correct part of the request contains the most important information.

II. Example request

{
"userName": "username",
"password": "password",
"GetLabelRequest":
	{
	"referenceID": "GoLabel00001",
	"collectiveLabel": 1,
	"labelFormat": "PDF",
	"labelSize": "A4"
	}
}

III. Response structure

The status of the request sent. Possible values:

• “OK” - request accepted successfully
• ‘Error” - the request was not accepted, the request needs to be modified

Error message or additional information related to shipping

Example:

	"message": {
        "uid": 48,
        "code": "G0029",
        "content": "Incorrect labelFormat."
    }

An array containing feedback for a particular package.

IV. Example response

{
    "responses": [
        {
            "referenceID": "GoLabel00001",
            "labelData": "aHR0cHM6Ly9sYWJlbC5nb2dsb2JhbDI0LmNvbS9mMWFiZDY3MDM1OGUwMzZjMzEyOTZlNjZiM2I2NmMzODJhYzAwODEyLzQxZDA4Nzc4YzNmYjgyNTkxNjgxODdlMTBmZWI4MDEzNDhmMWY0MGVtZ2jduywe",
            "status": "OK",
            "labelFormat": "PDF",
            "trackingNo": "TT008242375GB"
        },
        {
            "referenceID": "GoLabel00002",
            "labelData": "aHR0cHM6Ly9sYWJlbC5nb2dsb2JhbDI0LmNvbS9mMWFiZDY3MDM1OGUwMzZjMzEyOTZlNjZiM2I2NmMzODJidmrsODEyLzQxZDA4Nzc4YzNmYjgyNTkxNjgxODdlMTBmZWI4MDEzNDhmMWY0MGVtZ2jduywe",
            "status": "OK",
            "labelFormat": "PDF",
            "trackingNo": "TT008242389GB"
        }
    ]
}

									

1.3 Error messages

2.1 Royal Mail

I. Available services

II. Available types

If left blank, the default values will be entered. For U24 and U48 services, this will be the value of RL, for the remaining RP.

III. Weight

If left blank, the value will enter 1.00.

IV. Insurance

Service unavailable for this courier.

V. COD Payments

Service unavailable for this courier.

VI. Additional information

The U24 and U48 services do not have their own tracking number at RoyalMail, which is why the GoLabel system has added its own number - for example 0044154; 0038643.

VII. Examples of requests

{
    "userName": "username",
    "password": "password",
    "CreateShipmentsRequest002": {
        "shipmentType": "Delivery",
        "carrierName": "GB-ROYALMAIL",
        "shipperAddress": {
            "additionalDescription": "description"
        },
        "receiverAddress": {
            "nameOrCompany": "Birmingham Hippodrome",
            "additionalDescription": "description",
            "address1": "Hurst Street",
            "address2": "Southside",
            "city": "Birmingham",
            "zipCode": "B5 4TB",
            "region": "",
            "country": "GB",
            "email": "test@email.com",
            "phone": "123456765",
            "taxId": "",
            "pickupId": null
        },
        "invoiceNumber": "TT100/12/01/001",
        "orderValue": 100.50,
        "currency": "EUR",
        "payerAddress": null,
        "items": [
            {
                "referenceID": "GoLabel00010",
                "referenceID2": "",
                "type": "RP",
                "weight": "2.50",
                "products": [
                    {
                        "name": "turbocharger v1.3",
                        "number": "458152587412584",
                        "quantity": "1",
                        "price": 80.50,
                        "tariffCode": "85044030",
                        "originCountry": "DE",
                        "imageUrl": null
                    }
                ]
            }
        ],
        "serviceLevel": {
            "service": "T48"
        },
        "shipmentDescription1": "description",
        "shipmentDescription2": ""
    }
}

												

{
	"userName": "userName",
	"password": "password",
	"CreateShipmentsRequest002":{
		"shipmentType":"Return",
		"carrierName":"GB-ROYALMAIL",
		"shipperAddress": {
			"nameOrCompany":"Birmingham Hippodrome",
			"additionalDescription":"",
			"address1":"Hurst Street",
			"address2":"Southside",
			"city":"Birmingham",
			"zipCode":"B5 4TB",
			"region":"",
			"country":"GB",
			"email":"test@email.com",
			"phone":"123456765",
			"taxId":"",
			"pickupId":null
		},
		"receiverAddress":{
			"additionalDescription":"description"
		},
		"invoiceNumber": "TT100/12/01/001",
		"orderValue": 100.50,
		"currency": "EUR",
		"payerAddress":null,
		"items":[
			{
				"referenceID":"GoLabel000011",
				"referenceID2":"",
				"type":"RP",
				"weight":"2.50",
                "products": [
                    {
                        "name": "turbocharger v1.3",
                        "number": "458152587412584",
                        "quantity": "1",
                        "price": 80.50,
                        "tariffCode": "85044030",
                        "originCountry": "DE",
                        "imageUrl": null
                    }
                ]
			}
			],

		"serviceLevel":{
			"service":"R48"
		},
		"shipmentDescription1":"description",
		"shipmentDescription2":""
	}
}


												

{
"userName": "username",
"password": "password",
"GetLabelRequest":
	{
	"referenceID": "GoLabel00010",
	"collectiveLabel": 0,
	"labelFormat": "PDF",
	"labelSize": "A4"
	}
}


												

2.2 Colissimo

I. Available services

II. Available types

If left blank, the CS value will be entered.

III. Weight

If left blank, the value will enter 1.00.

IV. Insurance

The only currency supported by Colissimo is EUR, and the maximum value is 1500.

V. COD Payments

The only currency supported by Colissimo is EUR, and the maximum value is 1500.

VI. Additional information

VII. Examples of requests

{
	"userName":"username",
	"password":"password",
	"CreateShipmentsRequest002":{
		"shipmentType":"Delivery",
		"carrierName":"FR-COLISSIMO",
		"shipperAddress":{
			"additionalDescription":"description"
		},
		"receiverAddress":{
			"nameOrCompany":"Lucas About",
			"additionalDescription":"",
			"address1":"17 Rue Baron le Roy",
			"address2":"",
			"city":"Paris",
			"zipCode":"75012",
			"region":"",
			"country":"FR",
			"email":"test@email.com",
			"phone":"123456765",
			"taxId":"",
			"pickupId": null
		},
		"payerAddress":null,
		"items":[
			{
				"referenceID":"GoLabel000013",
				"referenceID2":"",
				"type":"CS",
				"weight":"1.00"
			}
		],
		"serviceLevel":{
			"service":"STC",
			"cod":null,
			"insurance":null
		},
		"shipmentDescription1":"description",
		"shipmentDescription2":""
	}
}

												

{
"userName": "username",
"password": "password",
"GetLabelRequest":
	{
	"referenceID": "GoLabel000013",
	"collectiveLabel": 0,
	"labelFormat": "PDF",
	"labelSize": "A4"
	}
}


												

2.3 DPD

I. Available services

II. Available types

If left blank, the KP value will be entered.

III. Weight

If left blank, the value will enter 1.00.

IV. Insurance

Service available for this courier.

V. COD Payments

Service available for this courier.

VI. Additional information

DPD creates two labels when returns, which is why two encoded links are returned with the getLabel method.

VII. Examples of requests

{
	"userName":"username",
	"password":"password",
	"CreateShipmentsRequest002":{
		"shipmentType":"Delivery",
		"carrierName":"DE-DPD",
		"shipperAddress":{
			"additionalDescription":"description"
		},
		"receiverAddress":{
			"nameOrCompany":"John Smith",
			"additionalDescription":"description",
			"address1":"Oldenburger Ring 3",
			"address2":"","city":"Markersdorf",
			"zipCode":"02829",
			"region":"",
			"country":"DE",
			"email":"john@smith.com",
			"phone":"",
			"taxId":"",
			"pickupId":null
		},
		"payerAddress":null,
		"items":[
			{
				"referenceID":"GoLabel000011",
				"referenceID2":"",
				"type":"NP",
				"weight":"1.00"
			}
		],
		"serviceLevel":{
			"service":"STT",
			"cod":null,
			"insurance":null
		},
		"shipmentDescription1":"description",
		"shipmentDescription2":""
	}
}

												

{
	"userName": "userName",
	"password": "password",
	"CreateShipmentsRequest002":{
		"shipmentType":"Return",
		"carrierName":"DE-DPD",
		"shipperAddress": {
			"nameOrCompany":"John Smith",
			"additionalDescription":"description",
			"address1":"Oldenburger Ring 3",
			"address2":"",
			"city":"Markersdorf",
			"zipCode":"02829",
			"region":"",
			"country":"DE",
			"email":"john@smith.com",
			"phone":"",
			"taxId":""
		},
		"receiverAddress":{
			"additionalDescription":"description"
		},
		"payerAddress":null,
		"items":[
			{
				"referenceID":"GoLabel00012",
				"referenceID2":"",
				"type":"NP",
				"weight":"1.00"
			}
			],

		"serviceLevel":{
			"service":"STT"
		},
		"shipmentDescription1":"description",
		"shipmentDescription2":""
	}
}

												

{
"userName": "username",
"password": "password",
"GetLabelRequest":
	{
	"referenceID": "GoLabel000011",
	"collectiveLabel": 0,
	"labelFormat": "PDF",
	"labelSize": "A4"
	}
}



												

2.4 DHL

I. Available services

DHL services in the GoLabel system are distinguished by means of the entered data in the address1 field. For example, if we want to choose Packstation, we enter this phrase along with the parcel lock number.

Example:

“address1”: “Packstation 131”,

II. Available types

If left blank, the NP value will be entered.

III. Weight

If left blank, the value will enter 1.00.

IV. Insurance

Service unavailable for this courier.

V. COD Payments

The only currency supported by DHL is EUR. All bank details of the SEPA area are possible.

Example:

	"cod":{
		"amount": 100,
		"currency": "EUR",
		"bankAccountOwner": "Test Company",
		"bankName": "Deutsche Bank",
		"bankAccountNumber": "DE12345678901234567890",
		"bic": "DEUTDEHHXXX"
	}

If the bank account details are not provided, they will be supplemented with the bank account details for COD DHL from the Global24 user profile.

VI. Additional information

You can create international parcels for DHL

The number of characters in the additionalDescription position in the sender's address (in case of shipmentType: Delivery) and the recipient's address (in case of shipmentType: Return) is 5 characters.

If you choose Packstation, enter "Packstation" and the number of the Packstation in the address1 field, e.g. "Packstation 131", while the post number (Postnummer) must be included in the address2 field.

VII. Examples of requests

{
	"userName":"username",
	"password":"password",
	"CreateShipmentsRequest002":{
		"shipmentType":"Delivery",
		"carrierName":"DE-DHL",
		"shipperAddress":{
			  "additionalDescription":"description"
		},
		"receiverAddress":{
			  "nameOrCompany":"Kathleen",
			  "additionalDescription":"",
			  "address1":"Packstation 131",
			  "address2":"903729505",
			  "city":"Weil am Rhein",
			  "zipCode":"79576",
			  "region":"",
			  "country":"DE",
			  "email":"test@email.com",
			  "phone":"123456765",
			  "taxId":"",
			  "pickupId": null
		},
		"payerAddress":null,
		"items":[
			{
				"referenceID":"GoLabel000014",
				"referenceID2":"",
				"type":"NP",
				"weight":"1.00"
			}
		],
		"serviceLevel":{
			"service":"DST",
			"cod":null,
			"insurance":null
		},
		"shipmentDescription1":"description",
		"shipmentDescription2":""
	}
}


												

{
"userName": "username",
"password": "password",
"GetLabelRequest":
	{
	"referenceID": "GoLabel000014",
	"collectiveLabel": 0,
	"labelFormat": "PDF",
	"labelSize": "A4"
	}
}


												

2.5 Fedex

I. Available services

II. Available types

If left blank, the "PC" value will be entered.

III. Weight

If left blank, the value will enter 1.00.

IV. Insurance

Insurance is required when using cash on delivery service. Field Description (Insurance description) is required. The insurance amount must be provided in PLN currency and cannot be lower than the cash on delivery amount.

V. COD Payments

The only currency supported by Fedex is PLN.

VI. Additional information

If using cash on delivery service (COD), the referneceID2 field is required (you must provide your bank account number). Labels for this courier are available only in PDF format and A4 size.

VII. Examples of requests

{
	"userName":"username",
	"password":"password",
	"CreateShipmentsRequest002":{
		"shipmentType":"Delivery",
		"carrierName":"PL-FEDEX",
		"receiverAddress":{
                        "nameOrCompany":"Jan Nowak",
                        "address1":"Stara 4",
                        "address2":"",
                        "city":"Karwiany",
                        "zipCode":"52-200",
                        "region":"",
                        "country":"PL",
                        "email":"test@email.com",
                        "phone":"123456765",
                        "taxId":"",
                        "pickupId": null
		},
		"payerAddress":null,
		"items":[
			{
				"referenceID":"GoLabel000014",
				"referenceID2":"",
				"type":"PC",
				"weight":"1.00"
			}
		],
		"serviceLevel":{
			"service":"FST",
			"cod":null,
			"insurance":null
		},
		"shipmentDescription1":"description",
		"shipmentDescription2":""
	}
}


												

{
"userName": "username",
"password": "password",
"GetLabelRequest":
	{
	"referenceID": "GoLabel000014",
	"collectiveLabel": 0,
	"labelFormat": "PDF",
	"labelSize": "A4"
	}
}


												

2.6 Parcel Post

I. Available services

II. Available types

If left blank, the NP value will be entered.

III. Weight

If left blank, the value will enter 1.00.

IV. Insurance

Service unavailable for this courier.

V. COD Payments

Service unavailable for this courier.

VI. Additional information

VII. Examples of requests

{
	"userName":"username",
	"password":"password",
	"CreateShipmentsRequest002":{
		"shipmentType":"Delivery",
		"carrierName":"Parcel Post",
		"shipperAddress":{
			"additionalDescription":"description"
		},
		"receiverAddress":{
			"nameOrCompany":"John Smith",
			"additionalDescription":"description",
			"address1":"Oldenburger Ring 3",
			"address2":"","city":"Markersdorf",
			"zipCode":"02829",
			"region":"",
			"country":"DE",
			"email":"john@smith.com",
			"phone":"",
			"taxId":"",
			"pickupId":null
		},
		"payerAddress":null,
		"items":[
			{
				"referenceID":"GoLabel000011",
				"referenceID2":"",
				"type":"NP",
				"weight":"1.00"
			}
		],
		"serviceLevel":{
			"service":"PP",
			"cod":null,
			"insurance":null
		},
		"shipmentDescription1":"description",
		"shipmentDescription2":""
	}
}

										

{
"userName": "username",
"password": "password",
"GetLabelRequest":
	{
	"referenceID": "GoLabel000011",
	"collectiveLabel": 0,
	"labelFormat": "PDF",
	"labelSize": "A4"
	}
}

										

2.7 Post AT

I. Available services

II. Available types

If left blank, the MP value will be entered.

III. Weight

IV. Insurance

Service unavailable for this courier.

V. COD Payments

Service unavailable for this courier.

VI. Additional information

VII. Examples of requests

{
	"userName":"username",
	"password":"password",
	"CreateShipmentsRequest002":{
		"shipmentType":"Delivery",
		"carrierName":"POST-AT",
		"receiverAddress":{
			  "nameOrCompany":"Alexis Trintignant",
			  "additionalDescription":"",
			  "address1":"Teststrasse",
			  "address2":"",
			  "city":"Wien",
			  "zipCode":"1030",
			  "region":"",
			  "country":"AT",
			  "email":"test@email.com",
			  "phone":"+33123456765",
			  "taxId":"",
			  "pickupId": null
		},
		"payerAddress":null,
		"items":[
			{
				"referenceID":"GoLabel000014",
				"referenceID2":"",
				"type":"AP",
				"weight":"1"
			}
		],
		"serviceLevel":{
			"service":"APS",
			"cod":null,
			"insurance":null
		},
		"shipmentDescription1":"description",
		"shipmentDescription2":""
	}
}

												

{
	"userName": "userName",
	"password": "password",
	"CreateShipmentsRequest002":{
		"shipmentType":"Return",
		"carrierName":"POST-AT",
		"shipperAddress": {
			  "nameOrCompany":"Alexis Trintignant",
			  "additionalDescription":"",
			  "address1":"Teststrasse",
			  "address2":"",
			  "city":"Wien",
			  "zipCode":"1030",
			  "region":"",
			  "country":"AT",
			  "email":"test@email.com",
			  "phone":"+33123456765",
			  "taxId":"",
			  "pickupId": null
		},
		"receiverAddress":{
			"additionalDescription":"description"
		},
		"payerAddress":null,
		"items":[
			{
				"referenceID":"GoLabel00015",
				"referenceID2":"",
				"type":"AP",
				"weight":"31.5"
			}
		],

		"serviceLevel":{
			"service":"APS"
		},
		"shipmentDescription1":"description",
		"shipmentDescription2":""
	}
}

												

{
"userName": "username",
"password": "password",
"GetLabelRequest":
	{
	"referenceID": "GoLabel000014",
	"collectiveLabel": 0,
	"labelFormat": "PDF",
	"labelSize": "A4"
	}
}

2.8 GLS-IT

I. Available services

II. Available types

If left blank, the "ST" value will be entered.

III. Weight

IV. Insurance

Service unavailable for this courier.

V. COD Payments

Service unavailable for this courier.

VI. Additional information

VII. Examples of requests

{
	"userName":"username",
	"password":"password",
	"CreateShipmentsRequest002":{
		"shipmentType":"Delivery",
		"carrierName":"GLS-IT",
		"receiverAddress":{
                    "nameOrCompany": "Test Company",
                    "address1": "Piazza del Colosseo, 1",
                    "address2": "",
                    "city": "Roma",
                    "zipCode": "00184",
                    "region": "",
                    "country": "IT",
                    "email": "email@email.com",
                    "phone": "123456765",
                    "taxId": "",
                    "pickupId": null
		},
		"payerAddress":null,
		"items":[
			{
				"referenceID":"GoLabel000014",
				"referenceID2":"",
				"type":"ST",
				"weight":"1"
			}
		],
		"serviceLevel":{
			"service":"GLI",
			"cod":null,
			"insurance":null
		},
		"shipmentDescription1":"description",
		"shipmentDescription2":""
	}
}


												

{
"userName": "username",
"password": "password",
"GetLabelRequest":
	{
	"referenceID": "GoLabel000014",
	"collectiveLabel": 0,
	"labelFormat": "PDF",
	"labelSize": "A4"
	}
}


												

2.9 Correos

I. Available services

II. Available types

If left blank, the "ST" value will be entered.

III. Weight

If left blank, the value will enter 1.00.

IV. Insurance

Service unavailable for this courier.

V. COD Payments

Service unavailable for this courier.

VI. Additional information

VII. Examples of requests

{
	"userName":"username",
	"password":"password",
	"CreateShipmentsRequest002":{
		"shipmentType":"Delivery",
		"carrierName":"ES-CORREOS",
		"shipperAddress":{
			"additionalDescription":"description"
		},
		"receiverAddress":{
			"nameOrCompany":"John Smith",
			"additionalDescription":"description",
			"address1":"Calle Albacete 27",
			"address2":"PORTE 0012",
			"city":"Yuncosd",
			"zipCode":"45210",
			"region":"",
			"country":"ES",
			"email":"info@global24.com",
			"phone":"+48603040604",
			"taxId":"",
			"pickupId": null
		},
		"payerAddress":null,
		"items":[
			{
				"referenceID":"GoLabel000011",
				"referenceID2":"",
				"type":"ST",
				"weight":"1.00"
			}
		],
		"serviceLevel":{
			"service":"CST",
			"cod":null,
			"insurance":null
		},
		"shipmentDescription1":"description",
		"shipmentDescription2":""
	}
}

												

{
	"userName": "userName",
	"password": "password",
	"CreateShipmentsRequest002":{
		"shipmentType":"Return",
		"carrierName":"ES-CORREOS",
		"shipperAddress": {
			"nameOrCompany":"John Smith",
			"additionalDescription":"description",
			"address1":"Calle Albacete 27",
			"address2":"PORTE 0012",
			"city":"Yuncosd",
			"zipCode":"45210",
			"region":"",
			"country":"ES",
			"email":"info@global24.com",
			"phone":"+48603040604",
			"taxId":"",
			"pickupId": null
		},
		"receiverAddress":{
			"additionalDescription":"description"
		},
		"payerAddress":null,
		"items":[
			{
				"referenceID":"GoLabel00012",
				"referenceID2":"",
				"type":"ST",
				"weight":"1.00"
			}
		],

		"serviceLevel":{
			"service":"CRT"
		},
		"shipmentDescription1":"description",
		"shipmentDescription2":""
	}
}

												

{
"userName": "username",
"password": "password",
"GetLabelRequest":
	{
	"referenceID": "GoLabel000011",
	"collectiveLabel": 0,
	"labelFormat": "PDF",
	"labelSize": "A4"
	}
}



												

2.10 Hermes

I. Available services

II. Available types

If left blank, the ST value will be entered.

III. Weight

If left blank, the value will enter 1.00.

IV. Insurance

Service unavailable for this courier.

V. COD Payments

Service unavailable for this courier.

VI. Additional information

VII. Examples of requests

{
    "userName":"username",
    "password":"password",
    "CreateShipmentsRequest002": {
        "shipmentType": "Delivery",
        "carrierName": "GB-HERMES",
        "shipperAddress": {
        },
        "receiverAddress": {
            "nameOrCompany": "Test Company",
            "additionalDescription": "",
            "address1": "103 Gatliff Rd",
            "address2": "",
            "city": "London",
            "zipCode": "SW1W 8BA",
            "region": "",
            "country": "GB",
            "email": "email@email.com",
            "phone": "123456765",
            "taxId": "",
            "pickupId": null
        },
        "invoiceNumber": "TT100/12/01/001",
        "orderValue": 500.50,
        "currency": "EUR",
        "payerAddress": null,
			"items":[
				{
					"referenceID":"GoLabel000011",
					"referenceID2":"",
					"type":"ST",
					"weight":"1",
					"products":[
			                	{
			                		"name": "Giant turtle toy",
			                		"number": "458152587412584",
			                		"quantity": "2",
			                		"price": "20.45",
			                		"tariffCode": "95049080",
			                		"originCountry": "DE",
			                		"imageUrl": "url_to_photo.com"
			                	},
			                	{
			                		"name": "exchaust",
			                		"number": "398155774553544",
			                		"quantity": "3",
			                		"price": "15.32",
			                		"tariffCode": "87141090",
			                		"originCountry": "DE",
			                		"imageUrl": "url_to_photo.com"
			                	}
	                		]
				}
			],
        "serviceLevel": {
            "service": "HST"
        },
        "shipmentDescription1": "",
        "shipmentDescription2": ""
    }
}

												

{
"userName": "username",
"password": "password",
"GetLabelRequest":
	{
	"referenceID": "GoLabel000011",
	"collectiveLabel": 0,
	"labelFormat": "PDF",
	"labelSize": "A4"
	}
}



												

2.11 Post NL

I. Available services

II. Available types

If left blank, the ST value will be entered.

III. Weight

If left blank, the value will enter 1.00.

IV. Insurance

Service unavailable for this courier.

V. COD Payments

Service unavailable for this courier.

VI. Additional information

VII. Examples of requests

{
	"userName":"username",
	"password":"password",
	"CreateShipmentsRequest002":{
		"shipmentType":"Delivery",
		"carrierName":"POST-NL",
		"shipperAddress":{
			"additionalDescription":"description"
		},
		"receiverAddress":{
			"nameOrCompany":"John Smith",
			"additionalDescription":"description",
			"address1":"Prinses Beatrixlaan 23",
			"address2":"Floor 10",
			"city":"Den Haag",
			"zipCode":"2595AK",
			"region":"",
			"country":"NL",
			"email":"info@global24.com",
			"phone":"+48603040604",
			"taxId":"",
			"pickupId": null
		},
		"payerAddress":null,
		"items":[
			{
				"referenceID":"GoLabel000011",
				"referenceID2":"",
				"type":"ST",
				"weight":"1.00"
			}
		],
		"serviceLevel":{
			"service":"PPHD",
			"cod":null,
			"insurance":null
		},
		"shipmentDescription1":"description",
		"shipmentDescription2":""
	}
}

												

{
	"userName": "userName",
	"password": "password",
	"CreateShipmentsRequest002":{
		"shipmentType":"Return",
		"carrierName":"POST-NL",
		"shipperAddress": {
			"nameOrCompany":"John Smith",
			"additionalDescription":"description",
			"address1":"Prinses Beatrixlaan 23",
			"address2":"Floor 10",
			"city":"Den Haag",
			"zipCode":"2595AK",
			"region":"",
			"country":"NL",
			"email":"info@global24.com",
			"phone":"+48603040604",
			"taxId":"",
			"pickupId": null
		},
		"receiverAddress":{
			"additionalDescription":"description"
		},
		"payerAddress":null,
		"items":[
			{
				"referenceID":"GoLabel00012",
				"referenceID2":"",
				"type":"ST",
				"weight":"1.00"
			}
		],

		"serviceLevel":{
			"service":"PPHD"
		},
		"shipmentDescription1":"description",
		"shipmentDescription2":""
	}
}

												

{
"userName": "username",
"password": "password",
"GetLabelRequest":
	{
	"referenceID": "GoLabel000011",
	"collectiveLabel": 0,
	"labelFormat": "PDF",
	"labelSize": "A4"
	}
}



												

2.12 Nova Poshta

I. Available services

II. Available types

If left blank, the NR value will be entered.

III. Weight

If left blank, the value will enter 1.00.

IV. Insurance

Service unavailable for this courier.

V. COD Payments

The only currency supported by Nova Poshta is UAH.

VI. Additional information

Address

Currently, it is only possible to enter address data in Ukrainian language (Cyrillic).

Export clearance

Shipments to Ukraine require export clearance. It is mandatory to provide the invoice number, order value, and currency (corresponding to the currency of the item prices). Additionally, the package contents should be listed with the following fields completed: product name, SKU number, quantity, price, customs tariff code, and country of origin.

Returns

There is no option for self-generating returns. The recipient of the package can use the free "Easy Return" option in the Nova Poshta app or send the package directly at a Nova Poshta branch.

VII. Examples of requests

{
   "userName":"username",
   "password":"password",
   "CreateShipmentsRequest002":{
      "shipmentType":"Delivery",
      "carrierName":"UA-NOVA-POSHTA",
      "receiverAddress":{
                "nameOrCompany":"Випробувальна компанія",
                "additionalDescription":"перший поверх",
                "address1":"Героїв України 1",
                "address2":"",
                "city":"Бровари",
                "zipCode":"07400",
                "region":"Волинська область",
                "country":"UA",
                "email":"test@email.com",
                "phone":"+380660000000",
                "taxId":"",
                "pickupId":null
      },
      "invoiceNumber":"TT100/12/01/001",
      "orderValue":500.50,
      "currency":"UAH",
      "payerAddress":null,
      "items":[
         {
            "referenceID":"NovaPoshta000001",
            "referenceID2":"",
            "type":"NR",
            "weight":"3.00",
            "products":[
               {
                  "name":"Giant turtle toy",
                  "number":"458152587412584",
                  "quantity":"2",
                  "price":"20.45",
                  "tariffCode":"95049080",
                  "originCountry":"DE"
               },
               {
                  "name":"exchaust",
                  "number":"398155774553544",
                  "quantity":"3",
                  "price":"15.32",
                  "tariffCode":"87141090",
                  "originCountry":"DE",
                  "imageUrl":"url_to_photo.com"
               }
            ]
         }
      ],
      "serviceLevel":{
         "service":"NPS",
         "cod":null,
         "insurance":null
      },
      "shipmentDescription1":"description",
      "shipmentDescription2":""
   }
}

{
   "userName":"username",
   "password":"password",
   "GetLabelRequest":{
      "referenceID":"NovaPoshta000001",
      "collectiveLabel":0,
      "labelFormat":"PDF",
      "labelSize":"A4"
   }
}

Tracking (GET method) - Singly - TEMPORARILY UNAVAILABLE

The method allows for returning the package status in JSON format. Note: not all returned fields at the couriers contain data.

Address to send the request to:

• production: http://api.goglobal24.com/tracking
• test: http://test-goreturns-api.goglobal24.com/tracking

I. Request structure

II. Response structure

III. Examples

http://api.goglobal24.com/tracking?code=00340434314501512185

{
    "success": true,
    "trackingCourierUrl": "https://www.royalmail.com/track-your-item#/tracking-results/KT338882630GB",
    "trackingCode": "KT338882630GB",
    "trackingData": [
        {
            "zipCode": null,
            "city": "Olkusz",
            "country": "PL",
            "createdDate": "17/11/19 18:20",
            "status": "created",
            "statusFull": null,
            "note": null,
            "courier": "Global24"
        },
        {
            "zipCode": null,
            "city": "Nowa Wieś Wrocławska",
            "country": "PL",
            "createdDate": "11/12/19 10:23",
            "status": "received",
            "statusFull": null,
            "note": null,
            "courier": "Global24"
        },
        {
            "zipCode": null,
            "city": "Medway Mail Centre",
            "country": "GB",
            "createdDate": "13/12/19 10:12",
            "status": "carrier",
            "statusFull": "Item Received",
            "note": null,
            "courier": "GB-ROYALMAIL"
        },
        {
            "zipCode": null,
            "city": "Home Counties North MC",
            "country": "GB",
            "createdDate": "14/12/19 00:12",
            "status": "carrier",
            "statusFull": "Item Received",
            "note": null,
            "courier": "GB-ROYALMAIL"
        },
        {
            "zipCode": null,
            "city": "Hatfield AL DO",
            "country": "GB",
            "createdDate": "14/12/19 04:12",
            "status": "carrier",
            "statusFull": "Due to be delivered today",
            "note": null,
            "courier": "GB-ROYALMAIL"
        },
        {
            "zipCode": null,
            "city": "Hatfield AL DO",
            "country": "GB",
            "createdDate": "14/12/19 10:12",
            "status": "delivered",
            "statusFull": "Delivered by",
            "note": null,
            "courier": "GB-ROYALMAIL"
        }
    ]
}

{
    "success": false,
    "message": "No result found for your code"
}

Tracking (GET method) - Group

The method allows for returning the latest statuses in JSON format for a maximum of 30 tracking codes. Note: not all returned fields by couriers contain data. Only found packages are returned.

Address to send the request to:

• production: http://api.goglobal24.com/tracking/group
• test: http://test-goreturns-api.goglobal24.com/tracking/group

I. Request structure

II. Response structure

III. Examples

http://api.goglobal24.com/tracking/group?codes=6A16061440938,00340434314501512185,00340434314502556980

{
    "success": true,
    "data": [
        {
            "trackingCourierUrl": "https://www.dhl.de/en/privatkunden/pakete-empfangen/verfolgen.html?piececode=00340434314501512185&cid=dhlde",
            "trackingCode": "00340434314501512185",
            "trackingData": {
                "zipCode": null,
                "city": "Sölden",
                "country": "DE",
                "createdDate": "06/05/20 12:05",
                "status": "delivered",
                "statusFull": "The shipment has been successfully delivered",
                "note": null,
                "courier": "DE-DHL"
            }
        },
        {
            "trackingCourierUrl": "https://www.dhl.de/en/privatkunden/pakete-empfangen/verfolgen.html?piececode=00340434314502556980&cid=dhlde",
            "trackingCode": "00340434314502556980",
            "trackingData": {
                "zipCode": null,
                "city": "Lublin",
                "country": "PL",
                "createdDate": "27/05/20 09:17",
                "status": "created",
                "statusFull": null,
                "note": null,
                "courier": "Global24"
            }
        },
        {
            "trackingCourierUrl": "https://www.laposte.fr/outils/track-a-parcel?code=6A16061440938",
            "trackingCode": "6A16061440938",
            "trackingData": {
                "zipCode": null,
                "city": "Lublin",
                "country": "PL",
                "createdDate": "27/05/20 09:17",
                "status": "created",
                "statusFull": null,
                "note": null,
                "courier": "Global24"
            }
        }
    ]
}

{
    "success": false,
    "message": "Error message"
}
                                

Inventory (GET method)

The method allows for retrieving inventory levels of active user products.

Address to send the request to:

• production: http://api.goglobal24.com/warehouse/status
• test: http://test-goreturns-api.goglobal24.com/warehouse/status

I. Request structure

Authorization type: Basic Auth

The access credentials (login and password) are the same as those used to log in to Global24:

• https://portal.goglobal24.com

II. Response structure

III. Examples

[
{
        "name": "Iphone",
        "description": "Iphone X  - 256GB",
        "itemid": "123456",
        "code": "123456",
        "currentStock": 0
    },
    {
        "name": "Samsung TV",
        "description": "TV 60 4k",
        "itemid": "123456",
        "code": "123456",
        "currentStock": 31
    },
    {
        "name": "Samsung charger",
        "description": "Samsung Wireless Charger Stand",
        "itemid": "123456",
        "code": "123456",
        "currentStock": 39
    }
]