GLS ShipIT
3.3.20
GLS ShipIT - REST services
|
The endpoints for the centrally hosted services can be obtained from your primary GLS contact and will be given with your credentials for the Service.
If you are connecting to a locally installed GLS ShipIT, you have to adapt the URL to point to the host (and port) in your network where the GLS ShipIT backend is running. E.g. https://10.10.10.10:8443/backend/rs/shipments The web service request/response content is encoded using UTF-8.
All REST service operations within this port are about creating or updating shipments. A shipment is a selection of one or more parcels that are collected at address A and delivered to address B. If several parcels should be sent from address A to address B and those parcels should share the same services, they can be combined to a shipment.
The pages below contain examples of webservice calls and error responses:
This operation creates a shipment that contains one or more shipment units. The operation takes an instance of eu.glsgroup.fpcs.datatypes.soap.v1.shipmentprocessing.ShipmentRequestData The input object is split into several sections allowing you to specify Shipper data, Consignee data, Shipment unit data, products and services, Printing options as well as some Custom content like an extra barcode or image that should be printed on the label.
/
with http request method POST
Parameter | Mandatory | Location in Request | Description |
---|---|---|---|
shipmentRequest | TRUE | request body | The eu.glsgroup.fpcs.datatypes.soap.v1.shipmentprocessing.ShipmentRequestData with the shipment parameters. |
The parts of the request are explained in the following sections in more detail:
When you are creating a shipment, you can specify several attributes on the shipment level. These are:
Name | Expression in webservices | Field length | Type | Format | Mandatory/Optional | Restrictions | Level | Description |
---|---|---|---|---|---|---|---|---|
Customer reference number | ShipmentReference | 40 | alphanumeric | Optional | - | Reference for this consignment of parcels | ||
Shipping date | ShippingDate | 10 | alphanumeric | YYYY-MM-DD | Optional | - | Date for the shipment | |
Incoterm | IncotermCode | 2 | alphanumeric | 10, 20, 30, etc. | Optional | Incoterm for this shipment. Represented by 2 digits | ||
Identifier | Identifier | 40 | alphanumeric | Optional | - | Person who started the parcel creation | ||
Middleware | Middleware | 40 | alphanumeric | Mandatory | - | Partner ERP System | ||
Product Group | Product | 7 | alphanumeric | Mandatory | Parcel, Express or Freight | Please select one | ||
Alternative delivery activation | ExpressAltDeliveryAllowed | 5 | boolean | Optional | true or false | Please select one | ||
Consignee | Consignee | Mandatory | - | see section Consignee data | ||||
Shipper | Shipper | Mandatory | - | see section Shipper data | ||||
Shipment unit | ShipmentUnit | Mandatory | - | see section Shipment unit data | ||||
Services | Services | Optional | - | see section Services |
The consignee is the person to which the shipment shall be sent. The consignee ID will be printed on the label if specified. The consignee address has to be specified within the request. The consignee category can be "BUSINESS" or "PRIVATE". If the field consignee category is omitted, the consignee will have no (empty) category.
In case of shipments with return services (pick&return, pick&ship, shopreturn) assigned, the consignee and the shipper data sections will automatically be switched on the return label. That means the consignee address, that you provide within your Webrequest will be used as pickup address on the return label. According to Pick&Ship and Pick&Return Service the following fields are mandatory: ContactPerson and FixedLinePhonenumber.
The consignee address can be specified as follows:
The consignee category can be specified as follows:
To provide an example of a consignee ID that should be printed on the label:
Name | Expression in webservices | Field length | Type | Format | Mandatory/Optional | Restrictions | Level | Description |
---|---|---|---|---|---|---|---|---|
Consignee identifier | ConsigneeID | 80 | alphanumeric | Optional | - | Identifier for the recipient of the parcels | ||
Cost Center | CostCenter | 80 | alphanumeric | Optional | - | Delivery location cost center for Inbound | ||
Consignee Category | Category | 8 | alphanumeric | CAPS LOCK | Optional | Only PRIVATE or BUSINESS | Classifies consignee as 2B (BUSINESS) or 2C (PRIVATE) recipient | |
Consignee Address | Address | Mandatory | - | see section Address data for field details |
Name | Expression in webservices | Field length | Type | Format | Mandatory/Optional | Restrictions | Level | Description |
---|---|---|---|---|---|---|---|---|
Name1 | Name1 | 40 | alphanumeric | Mandatory | - | Name of the consignee | ||
Name2 | Name2 | 40 | alphanumeric | Optional | - | Additional consignee name information | ||
Name3 | Name3 | 40 | alphanumeric | Optional | - | Additional consignee name information | ||
Country code | CountryCode | 2 | alphanumeric | DE, AT, BE, FR, etc. | Mandatory | - | Destination country of the shipment | |
Province | Province | 40 | alphanumeric | Optional | - | Province where the consignee's city is located in | ||
ZIPCode | ZIPCode | 10 | alphanumeric | Mandatory | - | ZIP code of the consignee's city | ||
City | City | 40 | alphanumeric | Mandatory | - | City of the consignee | ||
Street | Street | 40 | alphanumeric | Mandatory | > 3 | Street name | ||
Street number | StreetNumber | 40 | alphanumeric | Optional | - | Street number (if not part of the street) | ||
80 | alphanumeric | Optional | - | Email address of the consignee | ||||
Contact person | ContactPerson | 40 | alphanumeric | Optional | > 5 | Contact person to print on the label | ||
Fixed phonenumber | FixedLinePhonenumber | 35 | alphanumeric | Optional | > 3 | Fixed line phone number of the consignee | ||
Mobile | MobilePhoneNumber | 35 | alphanumeric | Optional | > 3 | Mobile phone number of the consignee |
This section fulfills two purposes. It identifies the shipper and as such the address from where the shipment shall be collected. It also offers the possibility to use an alternative shipper address that shall be printed on the labels. As the shipper ID please provide the Contact ID that was provided to you by GLS.
In case of shipments with return services (pick&return, pick&ship, shopreturn) assigned, the shipper data section represents the delivery address on the return label. That is the shipper address, that you provide within your Webrequest and that will be taken as the address on the return label, where the parcel will be delivered to.
Name | Expression in webservices | Field length | Type | Format | Mandatory/Optional | Restrictions | Level | Description |
---|---|---|---|---|---|---|---|---|
Shipper identifier | ContactID | 20 | alphanumeric | Mandatory | - | Shipper identifier as given by GLS | ||
Name1 | Name1 | 40 | alphanumeric | Mandatory | - | Name of the shipper | ||
Name2 | Name2 | 40 | alphanumeric | Optional | - | Additional shipper name information | ||
Name3 | Name3 | 40 | alphanumeric | Optional | - | Additional shipper name information | ||
Country code | CountryCode | 2 | alphanumeric | DE, AT, BE, FR, etc. | Mandatory | - | Origin country of the shipment | |
Province | Province | 40 | alphanumeric | Optional | - | Province where the shipper's city is located in | ||
ZIPCode | ZIPCode | 10 | alphanumeric | Mandatory | - | ZIP code of the shipper's city | ||
City | City | 40 | alphanumeric | Mandatory | - | City of the shipper | ||
Street | Street | 40 | alphanumeric | Mandatory | > 3 | Street name | ||
Street number | StreetNumber | 40 | alphanumeric | Optional | - | Street number (if not part of the street) | ||
Alternative address | AlternativeShipperAddress | - | Address | Optional | - | see section Address data |
Within this section of the request you specify each shipment unit of your shipment.
A shipment unit can contain the following elements:
Name | Expression in webservices | Field length | Type | Format | Mandatory/Optional | Restrictions | Level | Description |
---|---|---|---|---|---|---|---|---|
Parcel reference | ShipmentUnitReference | 40 | alphanumeric | Optional | - | Reference to be given to the parcel | ||
Parcel Weight | Weight | 10 | decimal | Mandatory | > 0 | Each minimum weight is specified by Shipper | ||
Parcel note1 | Note1 | 50 | alphanumeric | Optional | - | Notes added to the parcel (line 1) | ||
Parcel note2 | Note2 | 50 | alphanumeric | Optional | - | Notes added to the parcel (line 2) | ||
Parcel services | Service | - | Optional | - | see section Services for detailed fields | |||
Track identifier | TrackID | 40 | alphanumeric | Optional | - | Identifier for the parcel. Used for a cancelShipment request | ||
1D barcode number | ParcelNumber | - | alphanumeric | Optional | - | 1D barcode printed in the label | ||
Volumetric parcel data | Volume | - | Optional | - | see section Volume for detailed fields |
You can define services that should apply to your shipment. For further information on the services currently available in your country please go to https://gls-group.eu and check the page of the desired country.
The following services can be assigned on the shipment unit level:
Those services may have different attributes for each shipment unit.
Services inside shipment unit can be combined like this:
Name | Expression in webservices | Field length | Type | Format | Mandatory/Optional | Restrictions | Level | Description |
---|---|---|---|---|---|---|---|---|
Cash service | Cash | |||||||
Name of the service | ServiceName | 80 | alphanumeric | service_cash | Mandatory | Parcel | Shipment unit | Must use this fixed value for service name |
Cash reason | Reason | 160 | alphanumeric | Mandatory | - | Reason why the cash service was added to the parcel | ||
Cash amount | Amount | - | decimal | Mandatory | - | Cash amount (numeric value) | ||
Cash currency | Currency | 3 | alphanumeric | EUR | Mandatory | - | Cash currency code (ISO4217 -> 3 digits) | |
AddonLiability service | AddonLiability | |||||||
Name of the service | ServiceName | 80 | alphanumeric | service_addonliability | Mandatory | Parcel | Shipment unit | Must use this fixed value for service name |
AddonLiability amount | Amount | - | decimal | Mandatory | - | Liability amount might differ per country, please liaise with your sales contact | ||
AddonLiability currency | Currency | 3 | alphanumeric | EUR | Mandatory | - | AddonLiability currency code (ISO4217 -> 3 digits) | |
Parcel description | ParcelContent | 255 | alphanumeric | Optional | - | Specify the parcel content | ||
HazardousGoods service | HazardousGoods | |||||||
Name of the service | ServiceName | 80 | alphanumeric | service_hazardousgoods | Mandatory | Parcel | Shipment unit | Must use this fixed value for service name |
HazardousGoods | HazardousGoods | - | Hazardous good item attributes | |||||
Hazardous goods number | GLSHazNo | 8 | alphanumeric | Mandatory | - | Identifier for the hazardous goods type | ||
HazardousGoods Weight | Weight | - | decimal | Mandatory | > 0 | Weight for the hazardous good shipped (numeric) | ||
ExWorks service | ExWorks | |||||||
Name of the service | ServiceName | 80 | alphanumeric | service_exworks | Mandatory | Parcel | Shipment unit | Must use this fixed value for service name |
The following services can be assigned on the shipment level:
All other services do not require specific attributes and can be assigned on the shipment level. If you e.g. want to have more possibilities to customise parcel delivery, you can book the FlexDeliveryService as follows:
The same applies to Express shipments - these services do not require further information and can be added like stated underneath. Please note that parcels targeted to be delivered by the end of the business day do not need a dedicated service attached.
Name | Expression in webservices | Field length | Type | Format | Mandatory/Optional | Restrictions | Level | Description |
---|---|---|---|---|---|---|---|---|
Other service | Service | |||||||
Name of the service | ServiceName | - | alphanumeric | service_name | Must use the service name defined in DB | |||
ShopDelivery service | ShopDelivery | |||||||
Name of the service | ServiceName | 80 | alphanumeric | service_shopdelivery | Mandatory | Parcel | Shipment | Must use this fixed value for service name |
Parcel shop identifier | ParcelShopID | 50 | alphanumeric | {partnerID}-{local id} | Mandatory | - | Specify parcel shop | |
ShopReturn service | ShopReturn | |||||||
Name of the service | ServiceName | 80 | alphanumeric | service_shopreturn | Mandatory | Parcel | Shipment | Must use this fixed value for service name |
Amount of labels | NumberOfLabels | numeric | Mandatory | > 0 | Specify amount of labels to print | |||
Intercompany service | Intercompany | |||||||
Name of the service | ServiceName | 80 | alphanumeric | service_intercompany | Mandatory | Parcel | Shipment | Must use this fixed value for service name |
Intercompany address | Address | Mandatory | see section Address data | |||||
Amount of labels | NumberOfLabels | numeric | Mandatory | > 0 | Specify amount of labels to print | |||
Expected Weight | ExpectedWeight | - | decimal | Optional | > 0 | Expected weight of the returned shipment | ||
Exchange service | Exchange | |||||||
Name of the service | ServiceName | 80 | alphanumeric | service_exchange | Mandatory | Parcel | Shipment | Must use this fixed value for service name |
Exchange address | Address | Mandatory | - | see section Address data | ||||
Expected Weight | ExpectedWeight | - | decimal | Optional | > 0 | Expected weight of the returned shipment | ||
DeliveryAtWork service | DeliveryAtWork | Add an expected weight of the returned shipment | ||||||
Name of the service | ServiceName | 80 | alphanumeric | service_deliveryatwork | Mandatory | Parcel | Shipment | Must use this fixed value for service name |
Name of the Recipient | RecipientName | 40 | alphanumeric | Mandatory | - | Person who is allowed to receive the parcel | ||
AlternateRecipientName | AlternateRecipientName | 40 | alphanumeric | Optional | - | Alternative person who is allowed to receive the parcel | ||
Building | Building | 40 | decimal | Mandatory | - | Building number | ||
Floor | Floor | 40 | decimal | Mandatory | - | Floor number | ||
Room | Room | 40 | decimal | Optional | - | Room number | ||
Phonenumber | Phonenumber | 35 | decimal | Optional | - | Phone number of the contact person | ||
Deposit service | Deposit | |||||||
Name of the service | ServiceName | 80 | alphanumeric | service_deposit | Mandatory | Parcel | Shipment | Must use this fixed value for service name |
Place of deposit | PlaceOfDeposit | 121 | Mandatory | - | Place where the driver can drop the parcel | |||
Letterbox service | Deposit | |||||||
Name of the service | ServiceName | 80 | alphanumeric | service_deposit | Mandatory | Parcel | Shipment | Must use this fixed value for service name |
Place of deposit | PlaceOfDeposit | 121 | Letterbox/ Briefkasten/ etc. | Mandatory | - | Expression for letterbox in the destination's language | ||
IdentPin service | IdentPin | |||||||
Name of the service | ServiceName | 80 | alphanumeric | service_identpin | Mandatory | Parcel | Shipment | Must use this fixed value for service name |
PIN | PIN | 4 | alphanumeric | Mandatory | 4-digit PIN code that the consignee needs to enter | |||
Birthdate | Birthdate | 10 | date | YYYY-MM-DD | Mandatory | < today | Birthdate of the consignee | |
Ident service | Ident | |||||||
Name of the service | ServiceName | 80 | alphanumeric | service_ident | Mandatory | Parcel | Shipment | Must use this fixed value for service name |
Birthdate | Birthdate | 10 | date | YYYY-MM-DD | Mandatory | < today | Birthdate of the consignee | |
Firstname | Firstname | 40 | alphanumeric | Mandatory | - | First name of the consignee | ||
Lastname | Lastname | 40 | alphanumeric | Mandatory | - | Last name of the consignee | ||
Nationality | Nationality | 2 | alphanumeric | Mandatory | CountryCode | Nationality of the consignee | ||
PickAndShip service | PickAndShip | |||||||
Name of the service | ServiceName | 80 | alphanumeric | service_pickandship | Mandatory | Parcel | Shipment | Must use this fixed value |
PickupDate | PickupDate | 10 | date | YYYY-MM-DD | Mandatory | > today | Date when parcel should be picked up at shipper | |
PickAndReturn service | PickAndReturn | |||||||
Name of the service | ServiceName | 80 | alphanumeric | service_pickandreturn | Mandatory | Parcel | Shipment | Must use this fixed value |
PickupDate | PickupDate | 10 | date | YYYY-MM-DD | Mandatory | > today | Date when parcel should be picked up at shipper | |
Inbound Logistics | InboundLogistics | |||||||
Name of the service | ServiceName | 80 | alphanumeric | service_inbound | Mandatory | Parcel | Shipment | Must use this fixed value for service name |
Document Return Service | DocumentReturnService | |||||||
Name of the service | ServiceName | 80 | alphanumeric | service_documentreturn | Mandatory | Parcel | Shipment (w/o attributes) | Must use this fixed value for service name |
Flex Delivery Service | FlexDeliveryService | |||||||
Name of the service | ServiceName | 80 | alphanumeric | service_flexdelivery | Mandatory | Parcel | Shipment (w/o attributes) | Must use this fixed value for service name |
Guaranteed24 Service | Guaranteed24Service | |||||||
Name of the service | ServiceName | 80 | alphanumeric | service_guaranteed24 | Mandatory | Parcel | Shipment (w/o attributes) | Must use this fixed value for service name |
AddresseeOnly Service | AddresseeOnlyService | |||||||
Name of the service | ServiceName | 80 | alphanumeric | service_addresseeonly | Mandatory | Parcel | Shipment (w/o attributes) | Must use this fixed value for service name |
Tyre service | TyreService | |||||||
Name of the service | ServiceName | 80 | alphanumeric | service_tyre | Mandatory | Parcel/Express | Shipment (w/o attributes) | Must use this fixed value for service name |
0800 Service | 0800Service | |||||||
Name of the service | ServiceName | 80 | alphanumeric | service_0800 | Mandatory | Express | Shipment | Must use this fixed value for service name |
0900 Service | 0900Service | |||||||
Name of the service | ServiceName | 80 | alphanumeric | service_0900 | Mandatory | Express | Shipment | Must use this fixed value for service name |
1000 Service | 1000Service | |||||||
Name of the service | ServiceName | 80 | alphanumeric | service_1000 | Mandatory | Express | Shipment | Must use this fixed value for service name |
1200 Service | 1200Service | |||||||
Name of the service | ServiceName | 80 | alphanumeric | service_1200 | Mandatory | Express | Shipment | Must use this fixed value for service name |
Saturday 1000 Service | Saturday1000Service | |||||||
Name of the service | ServiceName | 80 | alphanumeric | service_saturday_1000 | Mandatory | Express | Shipment | Must use this fixed value for service name |
Saturday 1200 Service | Saturday1200Service | |||||||
Name of the service | ServiceName | 80 | alphanumeric | service_saturday_1200 | Mandatory | Express | Shipment | Must use this fixed value for service name |
Saturday Service | SaturdayService | |||||||
Name of the service | ServiceName | 80 | alphanumeric | service_Saturday | Mandatory | Express (Euro) | Shipment | Must use this fixed value for service name |
Delivery next working day (EOB) | ||||||||
Name of the service | ServiceName | Express | No service needs to be added |
If you want to send a shipment containing two shipment units (parcels) with FlexDeliveryService and CashService, you could use something like the following:
Not all of these services are available in all countries and not all of those services may be combined with each other. Please check online which services are available for your region on your local GLS website.
IMPORTANT: This function is only available for GLS network partners. Volumetric data will only be transmitted if none or one of the following services is added:
Combinations with and solely used other services than these will not be persisted. With the following ShipIT versions, the list of services will be enriched further and further.
Volume section can have the following fields displayed in this example:
Name | Expression in webservices | Field length | Type | Format | Mandatory/Optional | Restrictions | Level | Description |
---|---|---|---|---|---|---|---|---|
Parcel width | Width | 6 | numeric | Optional* | >0 | The width of a parcel in millimetres. | ||
Parcel height | Height | 6 | numeric | Optional* | >0 | The height of a parcel in millimetres. | ||
Parcel length | Length | 6 | numeric | Optional* | >0 | The length of a parcel in millimetres. | ||
Volume scanner station | ScannerStation | 20 | alphanumeric | Optional* | - | Defines the station / device of volumetric scanner - freetext. | ||
Type of volume | VolumetricType | 20 | alphanumeric | CALIBRATED/NON_CALIBRATED | Optional* | Defines if the volume is calibrated or not.To be defined with your GLS contact. |
Volume data is optional but when one of these fields is given, the others need to be given as well.
Finding the right product for your shipment will be determined by GLS ShipIT. The only information you have to give: if you want to send a standard parcel or wish to speed up by using express. Depending on the country-relation (where to send your parcel) and the weight the respective shipment product will be calculated.
1) Parcels sent within a country are considered as BusinessParcel or ExpressParcel - dependent on the product type chosen.
Small, light products with a given size and weight will get a "Small" - BusinessSmallParcel
You can create a Request BusinessParcel like the following example:
You can create a Request ExpressParcel like the following example:
2) Parcels that are sent cross-border to other European countries will be either EuroBusinessParcels or EuroExpressParcels.
For EuroBusinessParcel there is as well the option to send them as EuroBusinessSmallParcel.
Don't forget to add incoterm information to your request, sending to customs areas like Switzerland.
Request EuroBusinessParcel
Request EuroExpressParcel
3) International parcels are marked with a leading "Global" - so either GlobalBusinessParcel or GlobalExpressParcel.
Request GlobalBusinessParcel
Request GlobalExpressParcel
The printing options give you several ways of dealing with the labels that you need to place on your parcels. In general you can choose between GLS ShipIT handling the printing (this option is not available if you are using GLS ShipIT hosted at GLS premises) or for GLS ShipIT to return the created labels. If you choose to retrieve the labels from GLS ShipIT, you can choose the format of the labels to match your printers. Thus when issuing the request, you have to define one of the following printing options:
The PrintingOptions section is mandatory for all types of shipment creation webservice requests. This also includes services like Pick&Ship and Pick&Return, where no label data is returned.
If your are connecting to a centrally hosted GLS ShipIT, you can only use the option "ReturnLabels" as there will not be any printer installed within the centrally hosted GLS ShipIT (and you won't be able to retrieve the labels).
If you plan to use GLS ShipIT for printing your labels, please check the chapter "Druckerverwaltung" of the manual for information on how to configure printers in GLS ShipIT.
The option "UseDefault" should be considered when you are using GLS ShipIT with the Client or when you already configured your printers within your GLS ShipIT installation. By choosing that option, all documents are sent to the printers that are configured within GLS ShipIT. As the REST requests are being executed on the GLS ShipIT backend, only the configured backend printers are valid printers for this printing option.
The option "DefinePrinter" should be considered when you have printers configured within GLS ShipIT, but you want to print to different printers then the configured default printers of GLS ShipIT (e.g. you want to use a different printer when using the REST interface as when a user is creating parcels using the GLS ShipIT client application). With this option you have to provide the name of the printers that should be used for printing the labels and the accompanying documents. As the REST requests are being executed on the GLS ShipIT backend, only the configured backend printers are valid printers for this printing option.
The option "ReturnLabels" should be used when you cannot configure your printers in GLS ShipIT (e.g. the printer cannot be reached from the host which runs the GLS ShipIT backend). For this option you have to specify which type of printer you have. GLS ShipIT will return the labels for the desired type of printer. All other documents (e.g. additional documents for addon liability or ident service) will be returned as PDF document. If you do not have any of the supported label printers (or if your label printer is capable of printing PDF), you can specify PDF as the desired label format.
Here are some samples of the printing options you can use in your requests:
If you are working on our GLS-provided central webbackends, the options "UseDefault" and "DefinePrinter" are obsolete - please use "ReturnLabels" instead.
If you want to use GLS ShipIT for printing labels and documents:
If you want to use dedicated printers configured in GLS ShipIT (but not the default printers):
If you want to print the labels on your thermal printer (in this case a ZEBRA with ZPL_200):
If you want to retrieve the labels as PDF documents:
If you want to retrieve the labels as PNG documents:
To reduce the amount of data in the response you can use the two options:
If you are working on our GLS-provided central webbackends, the options "UseDefault" and "DefinePrinter" are obsolete - please use "ReturnLabels" instead.
Name | Expression in webservices | Field length | Type | Format | Mandatory/Optional | Restrictions | Level | Description |
---|---|---|---|---|---|---|---|---|
Use default printer | UseDefault | 7 | alphanumeric | Default | Optional | Default fixed value | Uses the preset standard printer | |
Define printer | DefinePrinter | Define configured printers for printing labels and shipment documents | ||||||
Label printer | LabelPrinter | 255 | alphanumeric | Optional | - | Please define name of the label printer | ||
Document printer | DocumentPrinter | 255 | alphanumeric | Optional | - | Please define name of the document printer | ||
Define printer for return labels | ReturnLabels | Defines the data output formats. | ||||||
Template name | TemplateSet | 7 | alphanumeric | Optional | Must use one of the defined set | NONE, ZPL_200, ZPL_300 | ||
Printer label format | LabelFormat | 8 | alphanumeric | Optional | Must use one of the defined set | PDF, PNG, ZEBRA | ||
Define returned data | ReturnOptions | Reduce the amount of data in response | ||||||
Print Data | ReturnPrintData | 5 | boolean | Optional | true or false | Removes the printing information and data from response. Default:true | ||
Routing Data | ReturnRoutingInfo | 5 | boolean | Optional | true or false | Removes all routing information. Default:true |
This section of the request contains several optional attributes when printing as PDF or PNG that can be found in the vertical area of the label. You do not need to fill any of them. If you however have the need of adding your own barcode or logo to the labels or if you want to suppress the shipper address on the labels, you can use this request section to steer this behaviour.
If you want to have a custom logo / image on the labels, fill the content of the element "CustomerLogo" with the binary data of the logo. The data must be Base64 encoded. The image formats jpg, gif and png are supported. Hint: The available character set of selected barcode type needs to be observed.
To print your logo on the label, use something like this:
If you need an own barcode on the label there are two elements to support this. In the element "Barcode" you specify the data that should be printed as a barcode. In the element "BarcodeType" you can specify the barcode format that should be used. You can choose between the following barcode formats:
If you want to print a Code39 barcode on the label, you can define the elements like this:
If you want to hide the shipper address on the label you can define the elements like this:
Name | Expression in webservices | Field length | Type | Format | Mandatory/Optional | Restrictions | Level | Description |
---|---|---|---|---|---|---|---|---|
Customer logo | CustomerLogo | 255 | base64Binary | Optional | - | Custom content provided for label generation (f.e. customer logo) | ||
Barcode | Barcode | 255 | alphanumeric | Optional | - | Barcode to create in the label | ||
Barcode type | BarcodeType | 7 | alphanumeric | Optional | EAN_128 or CODE_39 | The type of barcode to create in the label | ||
Hide shipper address | HideShipperAddress | 5 | boolean | Optional | true or false | Specify if the shipper address must be removed from the label |
The REST response is an instance of eu.glsgroup.fpcs.datatypes.soap.v1.shipmentprocessing.CreatedShipment or one of the following faults:
Depending of multiple conditions the response can have different content/information:
The Barcodes section varies. The informations (as the NDI numbers or UniShip for example) are filled depending of origin, destination and used services:
The routing informations are returned in section RoutingInfo:
In some countries, different routings may apply as you can see for the German example below:
When using a service, the REST response will list all used services with their service attributes:
For product EXPRESS there is also a serviceArea entry:
In case of Express product the response contains additional express delivery/routing informations:
If the parcel is a Der Kurier parcel the Kurier1D, KurierTourNumber and KurierImportStation are given in the ExpressArea:
For some destination countries there are NDI informations (NDI1D) returned. Parcels to Great Britain (GB) and to Switzerland (CH) have additional informations.
For parcels to Great Britain (GB) the GBProductIdentifier is filled with fixed value 24. The GB information GBPostOffice1D contains the zipcode (if longer than 4, the first 4 chars/digits only) surrounded by two asterisk (*):
For parcels to Switzerland (CH) the CHParcelNumber is filled with readable NDI number. The CH information CHPRI1D contains the fixed value 0509.
There are some pre-defined shorthand symbols which are returned in HandlingInformation:
There are more shorthand symbols for various services which are returned if such a service is used. If there are more than one symbol for a parcel, those symbols are concatenated (separated by spaces).
If the request was successful:
If the request was syntactically correct, but there where validation issues:
If you specified an invalid service (or a service that is not available to the shipper used in the request):
If a mandatory attribute was not set:
This operation tries to cancel a previously created parcel. This operation is not guaranteed to succeed. If the parcel is already being processed, it cannot be cancelled anymore. The cancel operation itself is handled asynchronously in most cases. If the system is not connected to the central systems of GLS at the time of the issuing of the request, it will be retried at a later time. The REST service will not wait for the request to be executed, it will return after the request has been scheduled successfully. Return parcels can only be cancelled through your responsible depot. A webservice can be called but this does not have any operational impact.
/cancel/{trackID}
with http request method POST
Parameter | Mandatory | Location in Request | Description |
---|---|---|---|
trackID | TRUE | path param | The track ID of the parcel that should be canceled. |
The REST response is an instance of eu.glsgroup.fpcs.datatypes.soap.v1.shipmentprocessing.CancelParcelResponse or one of the following faults:
If the cancellation was successful:
If the cancellation was successfully scheduled:
If the request was successful, but the parcel cannot be cancelled:
If a wrong TrackID has been transmitted:
If a mandatory attribute was not provided (e.g. the TrackID):
If a shipper shall be used to which the user does not have access:
This REST service operation returns a list of services (product/articles) that can be used for a shipment from a specific source address to a specific destination address.
The operation takes an instance of eu.glsgroup.fpcs.datatypes.soap.v1.shipmentprocessing.AllowedServicesRequestParameter
/allowedservices
with http request method POST
Parameter | Mandatory | Location in Request | Description |
---|---|---|---|
allowedServicesRequestParameter | TRUE | request body | The eu.glsgroup.fpcs.datatypes.soap.v1.shipmentprocessing.AllowedServicesRequestParameter with the request parameters. |
No special input validation is being done. The zip code should comply with zip code rules of the respective country.
The REST response is an instance of eu.glsgroup.fpcs.datatypes.soap.v1.shipmentprocessing.AllowedServicesResponse or one of the following faults:
It is possible to add a specific shipper as an optional parameter to the request above, in order to get the allowed services for that shipper only:
If the request was successful:
If the request was syntactically incorrect:
If an attribute had a wrong value (e.g. a invalid country code):
Executes the end of day procedure for the given day and returns all shipments that where affected by the end of day procedure.
/endofday
with http request method POST
Parameter | Mandatory | Location in Request | Description |
---|---|---|---|
date | TRUE | query param | Shipping or pick up day for which the end of day procedure should be executed |
The end of day procedure does the following things:
The shipment units for which end of day will be performed is limited by the shipments to which the user issuing the request has access to. This means, it affects all shippers to which the user has access based on the roles assigned to him.
If you are connecting to a local installation of GLS ShipIT on your premises, you can configure the following actions to be done during end of day:
The operation takes a date as an input parameter.
No input validation is to be done.
The REST response is an instance of eu.glsgroup.fpcs.datatypes.soap.v1.shipmentprocessing.EndOfDayResponse or one of the following faults:
If shipments still need to be transmitted, but could not be transmitted:
Updates the weight of a shipment unit. The shipment unit will be searched by its trackID.
changes are only applied if the weight change is >0.2 kg.
/updateparcelweight
with http request method POST
Parameter | Mandatory | Location in Request | Description |
---|---|---|---|
updateParcelWeightRequestParameter | TRUE | request body | The eu.glsgroup.fpcs.datatypes.soap.v1.shipmentprocessing.UpdateParcelWeightRequestParameter with the request parameters. |
The search is restricted to the shippers to which the user issuing the request has access to.
The REST response is an instance of eu.glsgroup.fpcs.datatypes.soap.v1.shipmentprocessing.UpdateParcelWeightResponse or one of the following faults:
If the request was successful:
If the request points to more than one shipment unit:
If the shipment unit cannot be found by the provided reference numbers:
If the shipment unit cannot be found by the provided reference number on shipment unit level (no shipment reference number passed to the service):
If a mandatory parameter is not provided:
If an invalid value is provided (e.g. a too high weight):