GLS ShipIT 5.0.17 GLS ShipIT - REST services

Webservices Fault Responses Samples

The following samples showcase possible responses to specific errors or missing parameters in webservice requests.

# Create parcel

## Miscellaneous

- Request with no body

  HTTP/1.1 400 Bad Request
  message: The Mandatory parameter ShipmentRequestData is not set
  error: MANDATORY_PARAMETER_NOT_SET

- Request with empty body

  HTTP/1.1 400 Bad Request
  message: The Mandatory parameter Shipment is not set
  error: MANDATORY_PARAMETER_NOT_SET

- Incoterm field missing

  HTTP/1.1 400 Bad Request
  message: Invalid field shipment.incoterm. Value XXXXXXXX is not a valid value. Shipment validation failed
  error: INVALID_FIELD_VALUE

- Consignee does not exist
  HTTP/1.1 400 Bad Request
  message: Invalid field ShipmentRequestData.Shipment.Consignee.Address. Value XXXXXXXX is not a valid value. Consignee Address not found in predefined by manufacturer
  error: INVALID_FIELD_VALUE

## Authentication Errors

HTTP/1.1 401 Unauthorized
WWW-Authenticate: Basic <Base64(user:password)>

## Shipper Validation

- Shipper does not exist or is not available to the user

  HTTP/1.1 400 Bad Request
  message: Invalid field Shipment.Shipper.ContactID. Value XXXXXXXX is not a valid value. Shipper does not exist or is not available for the user.
  error: INVALID_FIELD_VALUE

- NameX/Province/City/Streetname/Streetnumber/Telephone/Mobile/Contact person that's too long

  HTTP/1.1 400 Bad Request
  message: Invalid field Shipment.Shipper.Address.XXXXXXXX. Value XXXXXXXX is not a valid value. Value is too long. Maximum is 40
  error: INVALID_FIELD_VALUE

- Email that's too long

  HTTP/1.1 400 Bad Request
  message: Invalid field Shipment.Shipper.Address.EMail. Value XXXXXXXX is not a valid value. Value is too long. Maximum is 80
  error: INVALID_FIELD_VALUE

- Email with invalid format
  HTTP/1.1 400 Bad Request
  message: Invalid field shipper.email.wrong_format. Value XXXXXXXX is not a valid value. Shipment
  error: INVALID_FIELD_VALUE

## Product validation

- Product does not exist

  com.fasterxml.jackson.databind.exc.InvalidFormatException:
  Cannot deserialize value of type `eu.glsgroup.fpcs.datatypes.soap.v1.common.ProductType` from String &quot;XXXXXXXX&quot;:
  value not one of declared Enum instance names: [EXPRESS, PARCEL, FREIGHT]

- Product is not available
  HTTP/1.1 400 Bad Request
  message: Invalid field ShipmentRequestData.Shipment.Product. Value XXXXXXXX is not a valid value. No matching product available for shipper for the given input data (weight and addresses).
  error: INVALID_FIELD_VALUE

## Service validation

- Services that can't be combined

  HTTP/1.1 400 Bad Request
  message: The services XXXXXXXX, XXXXXXXX cannot be combined with the remaining services of this shipment
  error: INVALID_SERVICE_SELECTION

- Multiple units with concurring services

  HTTP/1.1 400 Bad Request
  message: The services XXXXXXXX, XXXXXXXX cannot be combined with the remaining services of this shipment
  error: INVALID_SERVICE_SELECTION

- Service does not exist or is not available
  HTTP/1.1 400 Bad Request
  message: Invalid field Shipment.Service.ServiceName. Value XXXXXXXX is not a valid value. Article does not exist or is not available for shipper
  error: INVALID_FIELD_VALUE

## Parcel Validation

- Reference number that's too long

  HTTP/1.1 400 Bad Request
  message: Invalid field Shipment.ShipmentUnit.ShipmentUnitReference. Value XXXXXXXX is not a valid value. Value is too long. Maximum is 40
  error: INVALID_FIELD_VALUE

- Weight with negative value

  HTTP/1.1 400 Bad Request
  message: Invalid field shipmentunit.weight.toolow. Value XXXXXXXX is not a valid value. Shipment validation failed
  error: INVALID_FIELD_VALUE

- Weight value with invalid characters
  com.fasterxml.jackson.databind.JsonMappingException:
  Cannot interpret XXXXXXXX as a valid decimal value.

## Printing Options Validation

- TemplateSet does not exist or left empty

  com.fasterxml.jackson.databind.exc.InvalidFormatException:
  Cannot deserialize value of type `eu.glsgroup.fpcs.datatypes.soap.v1.shipmentprocessing.TemplateSet` from String &quot;XXXXXXXX&quot;:
  value not one of declared Enum instance names: [ZPL_300,ZPL_200, NONE]

- LabelFormat does not exist or left empty

  com.fasterxml.jackson.databind.exc.InvalidFormatException:
  Cannot deserialize value of type `eu.glsgroup.fpcs.datatypes.soap.v1.shipmentprocessing.LabelFormat` from String &quot;XXXXXXXX&quot;:
  value not one of declared Enum instance names: [PDF, PNG, ZEBRA]

- Printer does not exist

  HTTP/1.1 400 Bad Request
  message: Invalid field PrintingOptions.DefinePrinter.DocumentPrinter. Value XXXXXXXX is not a valid value. Printer not found in configuration.
  error: INVALID_FIELD_VALUE

- Label printer does not exist

  HTTP/1.1 400 Bad Request
  message: Invalid field PrintingOptions.DefinePrinter.LabelPrinter. Value XXXXXXXX is not a valid value. Printer not found in configuration.
  error: INVALID_FIELD_VALUE

- Default printer field with invalid value

  HTTP/1.1 400 Bad Request
  message: Invalid field PrintingOptions.UseDefault. Value XXXXXXXX is not a valid value. Invalid field PrintingOptions.UseDefault. Value XXXXXXXX is not a valid value
  error: INVALID_FIELD_VALUE

- Printing options fields left empty
  HTTP/1.1 400 Bad Request
  message: The Mandatory parameter ShipmentRequestData.PrintingOptions is not set
  error: INVALID_FIELD_VALUE

## Consignee Address

- Zip code invalid or left empty

  HTTP/1.1 400 Bad Request
  message: Invalid field consignee.zip. Value XXXXXXXX is not a valid value. Shipment validation failed
  error: INVALID_FIELD_VALUE

- CountryCode left empty

  HTTP/1.1 400 Bad Request
  message: The Mandatory parameter Shipment.Consignee.Address.CountryCode is not set
  error: MANDATORY_PARAMETER_NOT_SET

- CountryCode field set with invalid or unknown values

  HTTP/1.1 400 Bad Request
  message: Invalid field Shipment.Consignee.Address.CountryCode. Value XXXXXXXX is not a valid value. Mandatory field is not set or invalid
  error: INVALID_FIELD_VALUE

- NameX/Province/City/Street/Streetnumber/Contact person that's too long

  HTTP/1.1 400 Bad Request
  message: Invalid field Shipment.Consignee.Address.XXXXXXXX. Value XXXXXXXX is not a valid value. Value is too long. Maximum is 40
  error: INVALID_FIELD_VALUE

- Email that's too long

  HTTP/1.1 400 Bad Request
  message: Invalid field Shipment.Consignee.Address.EMail. Value XXXXXXXX is not a valid value. Value is too long. Maximum is 80
  error: INVALID_FIELD_VALUE

- Telephone or mobile number that's too long
  HTTP/1.1 400 Bad Request
  message: Mobile or telephone number length exceeds 40
  error: NUMBER_EXCEEDS_LENGTH

## IdentPIN

- Pin that's too short or no Pin

  HTTP/1.1 400 Bad Request
  message: Invalid field ShipmentRequestData.Shipment.Service.IdentPin.PIN. Value XXXXXXXX is not a valid value. Value is too short. Minimum 4

- Pin that's too long

  HTTP/1.1 400 Bad Request
  message: Invalid field ShipmentRequestData.Shipment.Service.IdentPin.PIN. Value XXXXXXXX is not a valid value. Value is too long. Maximum is 4
  error: INVALID_FIELD_VALUE

- Pin with invalid characters

  HTTP/1.1 400 Bad Request
  message: Invalid field pin. Value XXXXXXXX is not a valid value. Value contains characters that are not allowed
  error: INVALID_FIELD_VALUE

- Birthdate field set with past/future values

  HTTP/1.1 400 Bad Request
  message: Invalid field article.identPin.birthdate. Value XXXXXXXX is not a valid value. Shipment validation failed
  error: INVALID_FIELD_VALUE

- Birthdate field set with an invalid format

  com.fasterxml.jackson.databind.JsonMappingException:
  Cannot interpret XXXXXXXX as a valid date.

- Birthdate field left empty
  com.fasterxml.jackson.databind.JsonMappingException:
  Unexpected character XXXXXXXX (code 125)): expected a value

## IdentService

- Firstname/Lastname that's too long

  HTTP/1.1 400 Bad Request
  message: Invalid field ShipmentRequestData.Shipment.Service.Ident.XXXXXXXX. Value XXXXXXXX is not a valid value. Value is too long. Maximum is 40
  error: INVALID_FIELD_VALUE

- Firstname/Lastname left empty

  HTTP/1.1 400 Bad Request
  message: Invalid field Ident.XXXXXXXX. Value is not a valid value. Value is mandatory
  error: INVALID_FIELD_VALUE

- Invalid country code value
  HTTP/1.1 400 Bad Request
  message: Invalid field Ident.Nationality. Value XXXXXXXX is not a valid value. Mandatory field is not set or invalid
  error: INVALID_FIELD_VALUE

## HazardousGoods

- Weight that's too high/negative/zero

  HTTP/1.1 400 Bad Request
  message: Invalid field shipmentunit.weight.XXXXXXXX. Value XXXXXXXX is not a valid value. Shipment validation failed
  error: INVALID_FIELD_VALUE

- Weight field left empty

  com.fasterxml.jackson.databind.JsonMappingException:
  Cannot interpret as a valid decimal value.

- ID field does not exist or is not available
  HTTP/1.1 400 Bad Request
  message: Invalid field ShipmentRequestData.Shipment.ShipmentUnit.Service.HazardousGoods.HazardousGood.GLSHazNo. Value XXXXXXXX is not a valid value.
  Hazardous good does not exist or is not available for the shipper
  error: INVALID_FIELD_VALUE

## CashService

- Reason field left empty

  HTTP/1.1 400 Bad Request
  message: Invalid field Cash.Reason. Value is not a valid value. Value is mandatory
  error: INVALID_FIELD_VALUE

- Reason field that's too long

  HTTP/1.1 400 Bad Request
  message: Invalid field ShipmentRequestData.Shipment.ShipmentUnit.Service.Cash.Reason. Value XXXXXXXX is not a valid value. Value is too long. Maximum is 160
  error: INVALID_FIELD_VALUE

- Incorrect currency

  HTTP/1.1 400 Bad Request
  message: Invalid field shipmentunit.article.cod.wrongcurrency. Value XXXXXXXX is not a valid value. Shipment validation failed
  error: INVALID_FIELD_VALUE

- Amount field with zero or negative value

  HTTP/1.1 400 Bad Request
  message: Invalid field article.attribute.notpositive. Value XXXXXXXX is not a valid value. Shipment validation failed
  error: INVALID_FIELD_VALUE

- Amount field left empty

  HTTP/1.1 400 Bad Request
  message: Invalid field null. Value null is not a valid value. Value is mandatory
  error: INVALID_FIELD_VALUE

- Amount value with invalid characters

  com.fasterxml.jackson.databind.JsonMappingException: Cannot interpret XXXXXXXX as a valid decimal value.

- Amount value that's too high
  HTTP/1.1 400 Bad Request
  message: Invalid field shipmentunit.attribute.cod.toohigh. Value XXXXXXXX is not a valid value. Shipment validation failed
  error: INVALID_FIELD_VALUE

## ShopDelivery

- ShopID field left empty

  HTTP/1.1 400 Bad Request
  message: Invalid field ShipmentRequestData.Shipment.Service.ShopDelivery.ParcelShopID. Value is not a valid value. Value is too short. Minimum 1
  error: INVALID_FIELD_VALUE

- ShopID field that's too long

  HTTP/1.1 400 Bad Request
  message: Invalid field ShipmentRequestData.Shipment.Service.ShopDelivery.ParcelShopID. Value XXXXXXXX is not a valid value. Value is too long. Maximum is 10
  error: INVALID_FIELD_VALUE

- Unroutable parcelshop

  HTTP/1.1 400 Bad Request
  message: Invalid field routing. Value XXXXXXXX is not a valid value. Shipment validation failed
  error: INVALID_FIELD_VALUE

- No consignee contact data provided
  HTTP/1.1 400 Bad Request
  message: Invalid field consignee.shopDelivery. Value XXXXXXXX is not a valid value. Shipment validation failed
  error: INVALID_FIELD_VALUE

## ShopReturn

- NumberOfLabels field with zero or negative value

  HTTP/1.1 400 Bad Request
  message: Invalid field Shipment.Service.ShopReturn.NumberOfLabels. Value XXXXXXXX is not a valid value. Invalid field Shipment.Service.ShopReturn.NumberOfLabels. Value XXXXXXXX is not a valid value
  error: INVALID_FIELD_VALUE

- Service not available
  HTTP/1.1 400 Bad Request
  message: Invalid field article.notavailable. Value XXXXXXXX is not a valid value. Shipment validation failed
  error: INVALID_FIELD_VALUE

## InterCompany

- NameX/Province/City/Street/Streetnumber/Telephone/Mobile that's too long

  HTTP/1.1 400 Bad Request
  message: Invalid field Shipment.ShipmentService.[Intercompany|Exchange].Address.XXXXXXXX. Value XXXXXXXX is not a valid value. Value is too long. Maximum is 40
  error: INVALID_FIELD_VALUE

- Email that's too long

  HTTP/1.1 400 Bad Request
  message: Invalid field Shipment.ShipmentService.[Intercompany|Exchange].Address.EMail. Value XXXXXXXX is not a valid value. Value is too long. Maximum is 80
  error: INVALID_FIELD_VALUE

- NumberOfLabels field with zero or negative value

  HTTP/1.1 400 Bad Request
  message: Invalid field Shipment.Service.Intercompany.NumberOfLabels. Value XXXXXXXX is not a valid value. Invalid field Shipment.Service.ShopReturn.NumberOfLabels. Value XXXXXXXX is not a valid value
  error: INVALID_FIELD_VALUE

- Zip code field that's left empty

  HTTP/1.1 400 Bad Request
  message: Invalid field Intercompany.Address.ZIPCode. Value null is not a valid value. Value is mandatory
  error: INVALID_FIELD_VALUE

- CountryCode field that's left empty
  HTTP/1.1 400 Bad Request
  message: Invalid field Intercompany.Address.CountryCode. Value null is not a valid value. Value is mandatory
  error: INVALID_FIELD_VALUE

## Exchange

- Zip code field that's left empty

  HTTP/1.1 400 Bad Request
  message: Invalid field Exchange.Address.ZIPCode. Value null is not a valid value. Value is mandatory
  error: INVALID_FIELD_VALUE

- CountryCode field that's left empty

  HTTP/1.1 400 Bad Request
  message: Invalid field Exchange.Address.CountryCode. Value null is not a valid value. Value is mandatory
  error: INVALID_FIELD_VALUE

- NameX/Province/City/Street/Streetnumber/Telephone/Mobile that's too long

  HTTP/1.1 400 Bad Request
  message: Invalid field Shipment.ShipmentService.[Intercompany|Exchange].Address.XXXXXXXX. Value XXXXXXXX is not a valid value. Value is too long. Maximum is 40
  error: INVALID_FIELD_VALUE

- Email that's too long
  HTTP/1.1 400 Bad Request
  message: Invalid field Shipment.ShipmentService.[Intercompany|Exchange].Address.EMail. Value XXXXXXXX is not a valid value. Value is too long. Maximum is 80
  error: INVALID_FIELD_VALUE

## DeliveryAtWork

- Weight that's too high/low/negative

  HTTP/1.1 400 Bad Request
  message: Invalid field shipmentunit.weight.XXXXXXXX. Value XXXXXXXX is not a valid value. Shipment validation failed
  error: INVALID_FIELD_VALUE

- Weight field left empty

  com.fasterxml.jackson.databind.JsonMappingException:
  Cannot interpret as a valid decimal value.

- RecipientName/AlternateRecipientName/Building/Floor/Room/Telephone that's too long
  HTTP/1.1 400 Bad Request
  message: Invalid field ShipmentRequestData.Shipment.Service.DeliveryAtWork.XXXXXXXX. Value XXXXXXXX is not a valid value. Value is too long. Maximum is 40
  error: INVALID_FIELD_VALUE

## Deposit

- PlaceOfDeposit that's too long
  HTTP/1.1 400 Bad Request
  message: Invalid field ShipmentRequestData.Shipment.Service.Deposit.PlaceOfDeposit. Value XXXXXXXX is not a valid value. Value is too long. Maximum is 121
  error: INVALID_FIELD_VALUE

## AddOnLiability

- Amount field with zero or negative value

  HTTP/1.1 400 Bad Request
  message: Invalid field shipmentunit.article.addonliability.notavailable. Value XXXXXXXX is not a valid value. Shipment validation failed
  error: INVALID_FIELD_VALUE

- Amount field left empty

  com.fasterxml.jackson.databind.JsonMappingException:
  Cannot interpret as a valid decimal value.

- Currency field set with invalid value or left empty
  HTTP/1.1 400 Bad Request
  message: Invalid field shipmentunit.article.addonliability.wrongcurrency. Value XXXXXXXX is not a valid value. Shipment validation failed
  error: INVALID_FIELD_VALUE

## CustomContent

- Barcode type invalid or empty
  com.fasterxml.jackson.databind.exc.InvalidFormatException:
  Cannot deserialize value of type `eu.glsgroup.fpcs.datatypes.soap.v1.shipmentprocessing.BarcodeType` from String &quot;XXXXXXXX&quot;:
  value not one of declared Enum instance names: [CODE_39, EAN_128]