Shipment Hub is a comprehensive platform designed to streamline and manage all aspects of shipment creation, tracking, and management.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"14921753","collectionId":"54cc7069-ee71-4bd9-b903-810978c63ca7","publishedId":"2sAXqpA4sa","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-09-20T20:40:45.000Z"},"item":[{"name":"v2","item":[{"name":"Token","item":[{"name":"Token","event":[{"listen":"test","script":{"id":"de3640f5-25c7-4814-b3a2-cccc39e1e73f","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.collectionVariables.set(\"token\", pm.response.headers.one(\"Token\").value);\r"," \r","});\r",""],"type":"text/javascript","packages":{}}}],"id":"4b028df5-7138-4870-be26-0537eec7ffed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/plain; ver=2.0"},{"key":"Username","value":"xxxx","type":"text"},{"key":"Password","value":"xxxx","type":"text"}],"url":"https://ship.gls-us.com/v2/Token","description":"Provide username and password in the request header.
\nThe Token and TokenExpiry are provided in the response header.
\n","urlObject":{"path":["v2","Token"],"host":["https://ship.gls-us.com"],"query":[],"variable":[]}},"response":[{"id":"bbf21239-9cbe-4e67-bb99-9c4239c5bdef","name":"Created","originalRequest":{"method":"GET","header":[{"key":"Username","value":"testuser","type":"text"},{"key":"Password","value":"testpassword","type":"text"}],"url":{"raw":"https://ship.gls-us.com/v2/Token?Username=XXXXXXXXX&Password=XXXXXXXXX","host":["https://ship.gls-us.com"],"path":["v2","Token"],"query":[{"key":"Username","value":"XXXXXXXXX"},{"key":"Password","value":"XXXXXXXXX"}]}},"status":"Created","code":201,"_postman_previewlanguage":"text","header":[{"key":"Transfer-Encoding","value":"chunked","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"Authorized"},{"id":"972188f2-1abd-43b9-a7b4-a1ed8cf54a31","name":"Bad Request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain; ver=2.0"}],"url":{"raw":"https://ship.gls-us.com/v2/Token?Username=XXXXXXXXX&Password=XXXXXXXXX","host":["https://ship.gls-us.com"],"path":["v2","Token"],"query":[{"key":"Username","value":"XXXXXXXXX"},{"key":"Password","value":"XXXXXXXXX"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; ver=2.0"}],"cookie":[],"responseTime":null,"body":"{\n \"StatusCode\": 400,\n \"StatusDescription\": \"Bad Request\",\n \"AuthenticationResultCode\": 1,\n \"RequestDateTime\": \"2024-07-19T09:52:45.0175002-07:00\",\n \"ResponseDateTime\": \"2024-07-19T09:52:45.3074304-07:00\",\n \"ErrorCount\": 1,\n \"ErrorDetail\": [\n {\n \"ErrorCode\": \"Failure\",\n \"ErrorDescription\": \"Error Message.\"\n }\n ]\n}"},{"id":"1e82fd99-5cfc-4ca4-b035-0ce0ac0d9045","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain; ver=2.0"}],"url":{"raw":"https://ship.gls-us.com/v2/Token?Username=XXXXXXXXX&Password=XXXXXXXXX","host":["https://ship.gls-us.com"],"path":["v2","Token"],"query":[{"key":"Username","value":"XXXXXXXXX"},{"key":"Password","value":"XXXXXXXXX"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; ver=2.0"}],"cookie":[],"responseTime":null,"body":"{\n \"StatusCode\": 401,\n \"StatusDescription\": \"Unauthorized\",\n \"AuthenticationResultCode\": 1,\n \"RequestDateTime\": \"2024-07-19T09:52:45.0175002-07:00\",\n \"ResponseDateTime\": \"2024-07-19T09:52:45.3074304-07:00\",\n \"ErrorCount\": 1,\n \"ErrorDetail\": [\n {\n \"ErrorCode\": \"Failure\",\n \"ErrorDescription\": \"INVALID CREDENTIALS.\"\n }\n ]\n}"},{"id":"eaac3cb9-2c9c-41e7-bd52-eb56822362f1","name":"Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://ship.gls-us.com/v2/Token?Username=XXXXXXXXX&Password=XXXXXXXXX","host":["https://ship.gls-us.com"],"path":["v2","Token"],"query":[{"key":"Username","value":"XXXXXXXXX"},{"key":"Password","value":"XXXXXXXXX"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"StatusCode\": 500,\r\n \"StatusDescription\": \"Internal Server Error\",\r\n \"AuthenticationResultCode\": 1,\r\n \"RequestDateTime\": \"2024-07-19T09:52:45.0175002-07:00\",\r\n \"ResponseDateTime\": \"2024-07-19T09:52:45.3074304-07:00\",\r\n \"ErrorCount\": 1,\r\n \"ErrorDetail\": [\r\n {\r\n \"ErrorCode\": \"Failure\",\r\n \"ErrorDescription\": \"Error Message.\"\r\n }\r\n ]\r\n}"}],"_postman_id":"4b028df5-7138-4870-be26-0537eec7ffed"}],"id":"826389ff-d369-4a9e-b548-57848353ff75","description":"As the initial step, the user will submit their GLS-provided username and password within the request header. Upon successful verification of the credentials by GLS, a token will be issued to the user, which will remain valid for 12 hours.
\n","_postman_id":"826389ff-d369-4a9e-b548-57848353ff75"},{"name":"Shipment","item":[{"name":"Shipment","id":"1a043d9d-d1c5-4f41-98d8-3801686f56a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json-patch+json; ver=2.0"},{"key":"Accept","value":"text/plain; ver=2.0"},{"key":"Token","value":"xxxx","type":"text"}],"body":{"mode":"raw","raw":"{\n \"AccountNumber\": \"1036\",\n \"Shipment\": { \n \"TrackingNumber\": \"OOROISD1\",\n \"ShipperCompany\": \"Techfolds Company\",\n \"ShipperContact\": \"Jerald Mc White\",\n \"ShipperPhone\": \"9212341234\",\n \"ShipperEmail\": \"testemail@123.com\",\n \"PickupAddress1\": \"1000 South Ampton Line Rd\",\n \"PickupAddress2\": null,\n \"PickupCity\": \"TRACY\",\n \"PickupState\": \"CA\",\n \"PickupZip\": \"94583\",\n \"PickupCountry\":\"US\",\n \"PickupCountryCode\": \"US\",\n \"LabelFromCompany\": \"test\",\n \"labelFromContact\": \"Andrew Joe Martin\",\n \"labelFromAddress1\": \"252 lenin priego\",\n \"labelFromAddress2\": \"\",\n \"labelFromCity\": \"Tracy\",\n \"labelFromState\": \"CA\",\n \"labelFromZip\": \"94583\",\n \"labelFromCountry\": \"US\",\n \"labelFromCountryCode\": \"US\",\n \"PickupAddressType\":\"R\",\n \"ShipToCompany\": \"SCK\",\n \"ShipToAttention\": \"Steve Martin\",\n \"ShipToPhone\": \"123654789\",\n \"ShipToEmail\": \"test123@abc.com\",\n \"DeliveryAddress1\": \"1540, Blog Street, 2nd Lane \",\n \"DeliveryAddress2\": \"\",\n \"DeliveryCity\": \"Berlin\",\n \"DeliveryState\": \"CA\",\n \"DeliveryZip\": \"65760\",\n \"DeliveryCountry\": \"Germany\",\n \"DeliveryCountryCode\": \"DE\",\n \"ShipDate\":\"2025-02-18\",\n \"ServiceCode\": \"ITS\",\n \"DeclaredValue\": 10,\n \"CODValue\": \"20\",\n \"SpecialInstructions\": \"test Special Instructions\",\n \"Weight\": \"10\", \n \"WeightUnitOfMeasure\" : \"lb\",\n \"Dimensions\":\n {\n \"Length\":1,\n \"Width\":\"2\",\n \"Height\":\"3\",\n \"UnitOfMeasure\":\"inch\"\n },\n \"SignatureCode\":\"ADULT_SIG_REQD\",\n \"ShipmentReference\": 1213,\n \"ShipmentLabelType\": \"zpl_short_label\",\n \"AddnShipperReference1\": \"Addn reference content1\",\n \"AddnShipperReference2\": \"Addn reference content2\",\n \"ParcelContent\": [\n \"unrestricted\"\n ], \n \"DeliveryAddressType\":\"R\",\n \"ItemDetails\": [\n {\n \"name\": \"TestItem1\",\n \"code\": \"1\",\n \"quantity\": \"10\",\n \"value\": 15,\n \"hsCode\": \"215\",\n \"hsDescription\": \"test\",\n \"countryCodeOfOrigin\": \"DE\",\n \"pieceweight\": 2.2,\n \"grosspieceweight\": 2.5\n }, \n {\n \"name\": \"TestItem2\",\n \"code\": \"2\",\n \"quantity\": \"10\",\n \"value\": 12,\n \"hsCode\": \"214\",\n \"hsDescription\": \"test\",\n \"countryCodeOfOrigin\": \"DE\",\n \"pieceweight\": 2.2,\n \"grosspieceweight\": 2.5\n }],\n \"customs\": // optional\n {\n \"importer\": {\n \"address\": {\n \"name1\": \"Hofmann Hausgeräte GmbH\", // Req if any one of the importer / exporter fields are provided\n \"street1\": \"Im oberen Kienle\", // Req if any one of the importer / exporter fields are provided\n \"postcode\": \"70839\", // Req if any one of the importer / exporter fields are provided\n \"city1\": \"Gerlingen\", // Req if any one of the importer / exporter fields are provided\n \"countryCode\": \"DE\", // Req if any one of the importer / exporter fields are provided\n \"name2\": \"Kundenservice\",\n \"street2\": \"Waldesruh\",\n \"houseNumber\": \"13\",\n \"stateOrRegion\": \"BW\"\n },\n \"contactPerson\": {\n \"name\": \"Ralf Richter\",\n \"emailAddress\": \"ralf.richter@mydomain.de\", //Either EmailAddress or both PhoneCountryPrefix and PhoneNumber is required.\n \"phoneCountryPrefix\": \"+49\",\n \"phoneNumber\": \"7114478890\"\n },\n \"isCommercial\": true, // Req if any one of the importer / exporter fields are provided\n \"eoriNumber\": \"r09876\",\n \"taxId\": \"\"\n },\n \"exporter\": {\n \"address\": {\n \"name1\": \"Hofmann Hausgeräte GmbH\",\n \"street1\": \"Im oberen Kienle\",\n \"postcode\": \"70839\",\n \"city1\": \"Gerlingen\",\n \"countryCode\": \"US\",\n \"name2\": \"Kundenservice\",\n \"street2\": \"Waldesruh\",\n \"houseNumber\": \"13\",\n \"stateOrRegion\": \"BW\"\n },\n \"contactPerson\": {\n \"name\": \"Ralf Richter\",\n \"emailAddress\": \"ralf.richter@mydomain.de\",\n \"phoneCountryPrefix\": \"+49\",\n \"phoneNumber\": \"7114478890\"\n },\n \"isCommercial\": true,\n \"eoriNumber\": \"ASWQER123\",\n \"taxId\": \"123HGFD\",\n \"SwissUid\": \"XZ987\",\n \"VatRegistrationNumber\": \"AS2345\",\n \"AuthorizationNumber\": \"65765432\",\n \"LoadingPlaceCode\": \"Gerlingen\"\n }\n },\n \n \"CommercialInvoiceAttached\": true,\n \"TotalCommercialInvoiceAmount\":100,\n \"PurchaseOrderNumber\":\"test\",\n \"PackageDescription\": \"test\",\n \"CommercialInvoiceNumber\": 235,\n \"ReceiveNotifications\":{\n \"emailAddress\":[\"testcontact@sample.com\"],\n \"MobileNumber\":[\"+1 9112341234\"]\n }, \n \"Notification\": [\n {\n \"NotificationType\": \"SHIPMENT\",\n \"EmailAddress\":\"test123@sample.com\"\n \n },\n {\n \"NotificationType\": \"RECEIPT\",\n \"EmailAddress\":\"test123@sample.com\"\n },\n {\n \"NotificationType\": \"EXCEPTION\",\n \"EmailAddress\":\"test123@sample.com\"\n }\n ,\n {\n \"NotificationType\": \"DELIVERY\",\n \"EmailAddress\":\"test123@sample.com\"\n }\n ,\n {\n \"NotificationType\": \"ETA\",\n \"EmailAddress\":\"test123@sample.com\"\n }\n ]\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://ship.gls-us.com/v2/Shipment","description":"The request body must be a JSON object with the following keys:
\nEmailAddress
Array of email addresses to receive automated email notifications.
Trigger points:
SHIPMENT: Triggered when package data upload is received by the GLS server.
\nRECEIPT: Triggered when the package is scanned at a GLS facility.
\nETA: Triggered when the package is out for delivery.
\nDELIVERY: Triggered when the delivery is completed.
\nMobile
Array of mobile numbers to receive automated text (SMS) notifications.
Trigger points:
SHIPMENT: Triggered when package data upload is received by the GLS server.
\nRECEIPT: Triggered when the package is scanned at a GLS facility.
\nETA: Triggered when the package is out for delivery.
\nDELIVERY: Triggered when the delivery is completed.
\nAdditional Notes:
\nOnly one mobile number per notification is allowed.
\nUnsubscribed mobile numbers will not receive SMS notifications.
\nInternational numbers must include the area code.
\nUsers can subscribe to specific notification types, and GLS will automatically trigger the subscribed ones.
\nNotificationType
Options: SHIPMENT, RECEIPT, DELIVERY, EXCEPTION, ETA.
EmailAddress
Email address(es) to receive automated notifications.
Multiple emails should be separated by a semicolon (;).
Notification trigger points:
SHIPMENT: When package data is uploaded to GLS server.
\nRECEIPT: When scanned at GLS facility.
\nETA: When package is out for delivery.
\nDELIVERY: When delivery is complete.
\nMobileNumber
Only one mobile number allowed.
Used for SMS notifications.
Unsubscribed numbers will not receive SMS.
Message
Optional sender commentis included in the email body.
Not applicable for SMS notifications.
EmailAddress or both PhoneCountryPrefix and PhoneNumber are required.The response for this request will be in the form of a JSON schema with the following properties:
\nPlease note that these are the complete list of fields in the request and response
\n","urlObject":{"path":["v2","Shipment"],"host":["https://ship.gls-us.com"],"query":[],"variable":[]}},"response":[{"id":"56cf9de9-8b7b-4de9-8e32-a9b5ef89834b","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json-patch+json; ver=2.0"},{"key":"Accept","value":"text/plain; ver=2.0"}],"body":{"mode":"raw","raw":"{\n \"AccountNumber\": \"1005001\",\n \"Shipment\": { \n \"TrackingNumber\": \"OOROISD1\",\n \"ShipperCompany\": \"Techfolds Company\",\n \"ShipperContact\": \"Jerald Mc White\",\n \"ShipperPhone\": \"9212341234\",\n \"ShipperEmail\": \"testemail@123.com\",\n \"PickupAddress1\": \"1000 South Ampton Line Rd\",\n \"PickupAddress2\": null,\n \"PickupCity\": \"TRACY\",\n \"PickupState\": \"CA\",\n \"PickupZip\": \"94583\",\n \"PickupCountry\":\"US\",\n \"PickupCountryCode\": \"US\",\n \"LabelFromCompany\": \"test\",\n \"labelFromContact\": \"Andrew Joe Martin\",\n \"labelFromAddress1\": \"252 lenin priego\",\n \"labelFromAddress2\": \"\",\n \"labelFromCity\": \"Tracy\",\n \"labelFromState\": \"CA\",\n \"labelFromZip\": \"94583\",\n \"labelFromCountry\": \"US\",\n \"labelFromCountryCode\": \"US\",\n \"PickupAddressType\":\"R\",\n \"ShipToCompany\": \"SCK\",\n \"ShipToAttention\": \"Steve Martin\",\n \"ShipToPhone\": \"123654789\",\n \"ShipToEmail\": \"test123@abc.com\",\n \"DeliveryAddress1\": \"1540, Blog Street, 2nd Lane \",\n \"DeliveryAddress2\": \"\",\n \"DeliveryCity\": \"Berlin\",\n \"DeliveryState\": \"CA\",\n \"DeliveryZip\": \"65760\",\n \"DeliveryCountry\": \"Germany\",\n \"DeliveryCountryCode\": \"DE\",\n \"ShipDate\":\"2025-02-18\",\n \"ServiceCode\": \"ITS\",\n \"DeclaredValue\": 10,\n \"CODValue\": \"20\",\n \"SpecialInstructions\": \"test Special Instructions\",\n \"Weight\": \"10\", \n \"WeightUnitOfMeasure\" : \"lb\",\n \"Dimensions\":\n {\n \"Length\":1,\n \"Width\":\"2\",\n \"Height\":\"3\",\n \"UnitOfMeasure\":\"inch\"\n },\n \"SignatureCode\":\"ADULT_SIG_REQD\",\n \"ShipmentReference\": 1213,\n \"ShipmentLabelType\": \"zpl_short_label\",\n \"AddnShipperReference1\": \"Addn reference content1\",\n \"AddnShipperReference2\": \"Addn reference content2\",\n \"ParcelContent\": [\n \"unrestricted\"\n ], \n \"DeliveryAddressType\":\"R\",\n \"ItemDetails\": [\n {\n \"name\": \"TestItem1\",\n \"code\": \"1\",\n \"quantity\": \"10\",\n \"value\": 15,\n \"hsCode\": \"215\",\n \"hsDescription\": \"test\",\n \"countryCodeOfOrigin\": \"DE\"\n }, \n {\n \"name\": \"TestItem2\",\n \"code\": \"2\",\n \"quantity\": \"10\",\n \"value\": 12,\n \"hsCode\": \"214\",\n \"hsDescription\": \"test\",\n \"countryCodeOfOrigin\": \"DE\"\n }],\n \"customs\": // optional\n {\n \"importer\": {\n \"address\": {\n \"name1\": \"Hofmann Hausgeräte GmbH\", // Req if any one of the importer / exporter fields are provided\n \"street1\": \"Im oberen Kienle\", // Req if any one of the importer / exporter fields are provided\n \"postcode\": \"70839\", // Req if any one of the importer / exporter fields are provided\n \"city1\": \"Gerlingen\", // Req if any one of the importer / exporter fields are provided\n \"countryCode\": \"DE\", // Req if any one of the importer / exporter fields are provided\n \"name2\": \"Kundenservice\",\n \"street2\": \"Waldesruh\",\n \"houseNumber\": \"13\",\n \"stateOrRegion\": \"BW\"\n },\n \"contactPerson\": {\n \"name\": \"Ralf Richter\",\n \"emailAddress\": \"ralf.richter@mydomain.de\", //Either EmailAddress or both PhoneCountryPrefix and PhoneNumber is required.\n \"phoneCountryPrefix\": \"+49\",\n \"phoneNumber\": \"7114478890\"\n },\n \"isCommercial\": true, // Req if any one of the importer / exporter fields are provided\n \"eoriNumber\": \"r09876\",\n \"taxId\": \"\"\n },\n \"exporter\": {\n \"address\": {\n \"name1\": \"Hofmann Hausgeräte GmbH\",\n \"street1\": \"Im oberen Kienle\",\n \"postcode\": \"70839\",\n \"city1\": \"Gerlingen\",\n \"countryCode\": \"US\",\n \"name2\": \"Kundenservice\",\n \"street2\": \"Waldesruh\",\n \"houseNumber\": \"13\",\n \"stateOrRegion\": \"BW\"\n },\n \"contactPerson\": {\n \"name\": \"Ralf Richter\",\n \"emailAddress\": \"ralf.richter@mydomain.de\",\n \"phoneCountryPrefix\": \"+49\",\n \"phoneNumber\": \"7114478890\"\n },\n \"isCommercial\": true,\n \"eoriNumber\": \"ASWQER123\",\n \"taxId\": \"123HGFD\",\n \"SwissUid\": \"XZ987\",\n \"VatRegistrationNumber\": \"AS2345\",\n \"AuthorizationNumber\": \"65765432\",\n \"LoadingPlaceCode\": \"Gerlingen\"\n }\n },\n \n \"CommercialInvoiceAttached\": true,\n \"TotalCommercialInvoiceAmount\":100,\n \"PurchaseOrderNumber\":\"test\",\n \"PackageDescription\": \"test\",\n \"CommercialInvoiceNumber\": 235,\n \"ReceiveNotifications\":{\n \"emailAddress\":[\"testcontact@sample.com\"],\n \"MobileNumber\":[\"+1 9112341234\"]\n }, \n \"Notification\": [\n {\n \"NotificationType\": \"SHIPMENT\",\n \"EmailAddress\":\"test123@sample.com\"\n \n },\n {\n \"NotificationType\": \"RECEIPT\",\n \"EmailAddress\":\"test123@sample.com\"\n },\n {\n \"NotificationType\": \"EXCEPTION\",\n \"EmailAddress\":\"test123@sample.com\"\n }\n ,\n {\n \"NotificationType\": \"DELIVERY\",\n \"EmailAddress\":\"test123@sample.com\"\n }\n ,\n {\n \"NotificationType\": \"ETA\",\n \"EmailAddress\":\"test123@sample.com\"\n }\n ]\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/v2/Shipment"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; ver=2.0"}],"cookie":[],"responseTime":null,"body":"{\n \"AccountNumber\": 1036,\n \"TrackingNumber\": \"999880955243\",\n \"ServiceCode\": \"ITS\",\n \"ScheduledShipDate\": \"05/14/2025\",\n \"ScheduledDeliveryDate\": \"5/26/2025 - 5/28/2025 \",\n \"ScheduledDeliveryTime\": null,\n \"DeliveryZone\": 2,\n \"RouteCode\": \"NWK CA927-EPG\",\n \"ShipmentCharges\": {\n \"TransportationCharge\": 28.00,\n \"CODCharge\": 0.00,\n \"DeclaredCharge\": 0.00,\n \"FuelSurcharge\": 8.63,\n \"OtherCharge\": [\n {\n \"Code\": \"ASR\",\n \"Description\": \"Adult Signature Fee\",\n \"Fee\": 21.31\n }\n ],\n \"TotalCharge\": 57.94\n },\n \"CommercialInvoice\": {\n \"PdfURL\": \"https://gls-customer-portal-dev.s3.us-west-1.amazonaws.com/CommercialInvoice\"\n },\n \"PaperLabel\": null,\n \"ThermalLabel\": \"~JO\\n^XA^EG^XZ\\n^XA\\n^PMN\\n^MUD\\n^LH15,0\\n^CI28\\n^JMA\\n^FO10,946,^GB616,137,1^FS\\n^FO10,703,^GB616,244,1^FS\\n^FO24,712,^A0N,24^FR^FD^FS\\n^FO24,743,^A0N,43^FR^FDCOLLEGIO ALLA QUERCE^FS\\n^FO24,790,^A0N,31^FR^FDSteve Martin^FS\\n^FO24,824,^A0N,31^FR^FD^FS\\n^FO24,857,^A0N,30^FR^FD2000 South Ampton Line Rd \\n^XZ\\n\",\n \"StatusCode\": 200,\n \"StatusDescription\": \"OK\",\n \"AuthenticationResultCode\": 0,\n \"RequestDateTime\": \"2025-05-14T08:12:48.7667466-07:00\",\n \"ResponseDateTime\": \"2025-05-14T08:13:00.7886175-07:00\",\n \"ErrorCount\": 0,\n \"ErrorDetail\": null\n}"},{"id":"33861794-c1fb-4b57-86ec-0cb748d7cb7f","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json-patch+json; ver=2.0"},{"key":"Accept","value":"text/plain; ver=2.0"}],"body":{"mode":"raw","raw":"{\n \"AccountNumber\": \"1005001\",\n \"Shipment\": { \n \"TrackingNumber\": \"KMPH1024123\",\n \"ShipperCompany\": \"Techfolds Company\",\n \"ShipperContact\": \"Jerald Mc White\",\n \"ShipperPhone\": \"9212341234\",\n \"ShipperEmail\": \"testemail@123.com\",\n \"PickupAddress1\": \"1000 South Ampton Line Rd\",\n \"PickupAddress2\": null,\n \"PickupCity\": \"TRACY\",\n \"PickupState\": \"CA\",\n \"PickupZip\": \"94583\",\n \"PickupCountry\":\"US\",\n \"PickupCountryCode\": \"US\",\n \"LabelFromCompany\": \"test\",\n \"labelFromContact\": \"Andrew Joe Martin\",\n \"labelFromAddress1\": \"252 lenin priego\",\n \"labelFromAddress2\": \"\",\n \"labelFromCity\": \"Tracy\",\n \"labelFromState\": \"CA\",\n \"labelFromZip\": \"94583\",\n \"labelFromCountry\": \"US\",\n \"labelFromCountryCode\": \"US\",\n \"PickupAddressType\":\"R\",\n \"ShipToCompany\": \"SCK-FAT \",\n \"ShipToAttention\": \"Steve Martin\",\n \"ShipToPhone\": \"123654789\",\n \"ShipToEmail\": \"test123@abc.com\",\n \"DeliveryAddress1\": \"1540, Blog Street, 2nd Lane \",\n \"DeliveryAddress2\": \"\",\n \"DeliveryCity\": \"Berlin\",\n \"DeliveryState\": \"CA\",\n \"DeliveryZip\": \"65760\",\n \"DeliveryCountry\": \"Germany\",\n \"DeliveryCountryCode\": \"DE\",\n \"ShipDate\":\"2024-07-19\",\n \"ServiceCode\": \"ITS\",\n \"DeclaredValue\": 100,\n \"CODValue\": \"20\",\n \"SpecialInstructions\": \"test Special Instructions\",\n \"Weight\": \"10\", \n \"WeightUnitOfMeasure\" : \"kg\",\n \"Dimensions\":\n {\n \"Length\":1,\n \"Width\":\"20\",\n \"Height\":\"30\",\n \"UnitOfMeasure\":\"cm\"\n },\n \"SignatureCode\":\"ADULT_SIG_REQD\",\n \"ShipmentReference\": 1213,\n \"ShipmentLabelType\": \"zpl_short_label\",\n \"AddnShipperReference1\": \"Addn reference content1\",\n \"AddnShipperReference2\": \"Addn reference content2\",\n \"ParcelContent\": [\n \"unrestricted\"\n ], \n \"DeliveryAddressType\":\"R\",\n \"ItemDetails\": [\n {\n \"name\": \"TestItem1\",\n \"code\": \"1\",\n \"quantity\": \"10\",\n \"value\": 10,\n \"hsCode\": \"215\",\n \"hsDescription\": \"test\",\n \"countryCodeOfOrigin\": \"DE\"\n }, {\n \"name\": \"TestItem2\",\n \"code\": \"2\",\n \"quantity\": \"10\",\n \"value\": 12,\n \"hsCode\": \"214\",\n \"hsDescription\": \"test\",\n \"countryCodeOfOrigin\": \"DE\"\n }],\n \"ImporterTaxId\": \"1234\", \n \"CommercialInvoiceAttached\": true,\n \"TotalCommercialInvoiceAmount\":100,\n \"PurchaseOrderNumber\":\"test\",\n \"PackageDescription\": \"test\",\n \"CommercialInvoiceNumber\": 235,\n \"ReceiveNotifications\":{\n \"emailAddress\":[\"testcontact@sample.com\"],\n \"MobileNumber\":[\"+1 9112341234\"]\n }, \n \"Notification\": [\n {\n \"NotificationType\": \"SHIPMENT\",\n \"EmailAddress\":\"test123@sample.com\"\n \n },\n {\n \"NotificationType\": \"RECEIPT\",\n \"EmailAddress\":\"test123@sample.com\"\n },\n {\n \"NotificationType\": \"EXCEPTION\",\n \"EmailAddress\":\"test123@sample.com\"\n }\n ,\n {\n \"NotificationType\": \"DELIVERY\",\n \"EmailAddress\":\"test123@sample.com\"\n }\n ,\n {\n \"NotificationType\": \"ETA\",\n \"EmailAddress\":\"test123@sample.com\"\n }\n ]\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://ship.gls-us.com/v2/Shipment"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; ver=2.0"}],"cookie":[],"responseTime":null,"body":"{\n \"StatusCode\": 400,\n \"StatusDescription\": \"Bad Request\",\n \"AuthenticationResultCode\": 0,\n \"RequestDateTime\": \"2024-07-19T07:24:26.8517465-07:00\",\n \"ResponseDateTime\": \"2024-07-19T08:21:11.5885999-07:00\",\n \"ErrorCount\": 1,\n \"ErrorDetail\": [\n {\n \"ErrorCode\": \"Failure\",\n \"ErrorDescription\": \"Error Message\"\n }\n ]\n}"}],"_postman_id":"1a043d9d-d1c5-4f41-98d8-3801686f56a5"},{"name":"Shipment","id":"9b8bb30a-7430-4de7-8374-c508e5d7f38b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json-patch+json; ver=2.0"},{"key":"Accept","value":"text/plain; ver=2.0"},{"key":"Token","value":"xxxx","type":"text"}],"body":{"mode":"raw","raw":"{\n \"trackingNumber\": \"id\",\n \"accountNumber\": -96273340\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://ship.gls-us.com/v2/Shipment","description":"This method will be used to cancel a shipment that has been uploaded to GLS.
\nRequest
\nMethod: DELETE
\nURL: /v2/Shipment
This method will be used to upload information about an outbound package to GLS. The uploaded shipment information does not go live in the GLS operations system until the package is physically received/scanned in the GLS scan facility. If the package is not scanned, the data will be dropped after 90 days from upload date without delivery or billing action. This is a transactional method and does not accept batch uploads.
\n\n\n","_postman_id":"a5b8706a-057d-431f-9ae3-c00a5a81c8f7"},{"name":"Pickup","item":[{"name":"Locations","item":[{"name":"Locations","id":"6a522186-ebaf-41fe-9ef2-ac1d55d8621d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/plain; ver=2.0"},{"key":"Token","value":"xxxx","type":"text"}],"url":"https://ship.gls-us.com/v2/Pickup/Locations?AccountNumber=36534637","description":"Note: We've added LabelFrom fields to the Shipment object. Instead of being limited to specifying the actual pickup location on the label, you can use the LabelFrom fields to designate an alternative address, which will only appear on the GLS label. This feature provides flexibility for scenarios where our shippers may prefer not to display the actual ship-from address on the label. If no data is passed in the LabelFrom fields address info from the Pickup/ShipFrom fields will be printed on the label.
\n
This method will return pickup locations and related pickup information for each scheduled and on-call pickup location registered in GLS system for a Parcel account.
\nNote: Oncall Pickup Locations expects the input parameters from the URL.
\nMethod: GET
\nEndpoint: /v2/Pickup/Locations
The response for this request will be a JSON object representing the pickup locations.
\nDescription
This method will return the pickup window details of a specific ZIP code/All ZIP codes.
• Provide a specific ZIP in the Request parameter “ZIP” to get the pickup window details of that specific ZIP.
• Provide “ALL” in the Request parameter “ZIP”, to get pickup window for all ZIP’s in GLS service footprint.
Note: Oncall Pickup Window expects the input parameters from the URL.
\nMethod: GET
\nEndpoint: /v2/Pickup/PickupWindow
HTTP Method
\nMethod: Post
\nEndpoint: /v2/Pickup
Description
This method will allow user to request an On-Call pickup for a GLS Parcel Account. It will return a Pickup Confirmation number if Pickup is successfully scheduled. This method will also send a Pickup Request notification email to the user if requested.
HTTP Method
Method: DELETE
Endpoint: /v2/Pickup
\nThis method will cancel any future On-Call pickups by confirmation number. This method will also send a Pickup cancellation notification if email address is provided. On-Call pickups submitted for same day pickup cannot be cancelled via API as they are auto-dispatched to field operations for pickup scheduling.
\nThis method will provide estimated shipping rates and transit times for all the GLS services available for your account before you ship for the next available business day.
\nDescription
This method will allow user to track On-Call Pickup by either Confirmation # or Account #/Pickup Date
combination.
\n\nNote: Track Shipment expects the input parameters from the URL
\n
Retrieves detailed shipment information, including transit details, based on the provided search criteria. The request must include an account number and at least one of the following:
\nTracking Number, Reference Number, or Ship Date.
\n","_postman_id":"2a27390f-18bc-447c-ae98-c1834ff9e9c5"},{"name":"Transportation","item":[{"name":"Transportation","id":"bd02644c-c195-44a6-b4f5-7f9ee7d62976","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Accept","value":"text/plain; ver=2.0","type":"text"},{"key":"Token","value":"xxxx","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"accountNumber\":1036,\r\n \"TRACKINGNUMBER\": [\r\n \"04202510362929e604ea\"\r\n ],\r\n \"DEPARTURELOCATION\": \"LAX\",\r\n \"arrivalLocation\": \"ORD\",\r\n \"actualTimeOfDeparture\": \"2025-04-15T14:30:45-07:00\",\r\n \"estimateTimeOfArrival\": \"2025-04-16T11:10:10-07:00\",\r\n \"transportType\": \"airplane\",\r\n \"transportVehicleType\": \"airplane\",\r\n \"sealNumber\": \"3542561803\",\r\n \"flightNumber\": \"DL5678\",\r\n \"fillLevel\": \"10\",\r\n \"loadUnitID\": \"2025042513dd92eb84\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://ship.gls-us.com/v2/Transportation","description":"The response for this request will be in the form of a JSON schema with the following properties:
\nThe Transportation endpoint is used to submit transportation-related data to GLS US. The primary purpose of this endpoint is to allow GLS US to capture and store transportation data within the system for operational, tracking, or compliance purposes.
\n\n\n","_postman_id":"ac2c4b7a-b00d-4730-8ac4-6890c97837f2"},{"name":"UploadCommercialInvoice","item":[{"name":"UploadCommercialInvoice","id":"02ea6f9a-054e-42f5-a7bb-5e60d5b275b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"file","file":{"src":"postman-cloud:///1f021f20-d12b-4f20-994d-ad70b4fc0ae1"}},"url":"https://ship.gls-us.com/v2/Documents/invoice/upload?AccountNumber=9999999&TrackingNumber=testtracking","urlObject":{"path":["v2","Documents","invoice","upload"],"host":["https://ship.gls-us.com"],"query":[{"key":"AccountNumber","value":"9999999"},{"key":"TrackingNumber","value":"testtracking"}],"variable":[]}},"response":[{"id":"3f868662-b72a-4cd1-ba0b-95ec68063c9a","name":"Success","originalRequest":{"method":"GET","header":[],"body":{"mode":"file","file":{"src":"postman-cloud:///1f021f20-d12b-4f20-994d-ad70b4fc0ae1"}},"url":{"raw":"https://ship.gls-us.com/v2/Documents/invoice/upload?AccountNumber=9999999&TrackingNumber=testtracking","host":["https://ship.gls-us.com"],"path":["v2","Documents","invoice","upload"],"query":[{"key":"AccountNumber","value":"9999999"},{"key":"TrackingNumber","value":"testtracking"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"AccountNumber\": 9999999,\r\n \"TrackingNumber\": \"0720251036e40913749\",\r\n \"DownloadUrl\": \"https://gls-customer-portal-dev.s3.us-west-1.amazonaws.com/CommercialInvoice/\",\r\n \"StatusCode\": 200,\r\n \"StatusDescription\": \"OK\",\r\n \"AuthenticationResultCode\": 0,\r\n \"RequestDateTime\": \"2025-07-22T09:32:44.1413018-07:00\",\r\n \"ResponseDateTime\": \"2025-07-22T09:32:46.715199-07:00\",\r\n \"ErrorCount\": 0,\r\n \"ErrorDetail\": null\r\n}"},{"id":"f6cafcc3-a08d-4b09-b0aa-9d47c97be79c","name":"Bad Request","originalRequest":{"method":"GET","header":[],"body":{"mode":"file","file":{"src":"postman-cloud:///1f021f20-d12b-4f20-994d-ad70b4fc0ae1"}},"url":{"raw":"https://ship.gls-us.com/v2/Documents/invoice/upload?AccountNumber=9999999&TrackingNumber=testtracking","host":["https://ship.gls-us.com"],"path":["v2","Documents","invoice","upload"],"query":[{"key":"AccountNumber","value":"9999999"},{"key":"TrackingNumber","value":"testtracking"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"AccountNumber\": null,\r\n \"TrackingNumber\": null,\r\n \"DownloadUrl\": null,\r\n \"StatusCode\": 400,\r\n \"StatusDescription\": \"BadRequest\",\r\n \"AuthenticationResultCode\": 0,\r\n \"RequestDateTime\": \"2025-05-28T16:34:25.8228542-07:00\",\r\n \"ResponseDateTime\": \"2025-05-28T16:34:25.8672443-07:00\",\r\n \"ErrorCount\": 1,\r\n \"ErrorDetail\": [\r\n {\r\n \"ErrorCode\": \"Failure\",\r\n \"ErrorDescription\": \"No Shipment found.\"\r\n }\r\n ]\r\n}"},{"id":"2c1663a3-20ff-414c-968e-3a7206023652","name":"Unauthorized","originalRequest":{"method":"GET","header":[],"body":{"mode":"file","file":{"src":"postman-cloud:///1f021f20-d12b-4f20-994d-ad70b4fc0ae1"}},"url":{"raw":"https://ship.gls-us.com/v2/Documents/invoice/upload?AccountNumber=9999999&TrackingNumber=testtracking","host":["https://ship.gls-us.com"],"path":["v2","Documents","invoice","upload"],"query":[{"key":"AccountNumber","value":"9999999"},{"key":"TrackingNumber","value":"testtracking"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"StatusCode\": 401,\r\n \"StatusDescription\": \"Unauthorized\",\r\n \"AuthenticationResultCode\": 2,\r\n \"RequestDateTime\": \"2025-05-14T14:55:14.8506889-07:00\",\r\n \"ResponseDateTime\": \"2025-05-15T15:31:18.0812038-07:00\",\r\n \"ErrorCount\": 1,\r\n \"ErrorDetail\": [\r\n {\r\n \"ErrorCode\": \"Failure\",\r\n \"ErrorDescription\": \"Token has been expired. Please request for new Token.\"\r\n }\r\n ]\r\n}"}],"_postman_id":"02ea6f9a-054e-42f5-a7bb-5e60d5b275b0"}],"id":"87fd14cd-c713-49e6-9374-caf81ee7dd85","description":"Note: All submitted data must conform to the required schema and validation rules. Optional fields, if provided, must contain valid and correctly formatted values.
\n
This endpoint allows customers to upload their commercial invoice. The uploaded invoice will be used by GLS during the customs clearance process.
\n","_postman_id":"87fd14cd-c713-49e6-9374-caf81ee7dd85"},{"name":"ShopDelivery(Under Development)","item":[{"name":"ShopDelivery/Addresses","id":"2f4acd18-4cfe-460b-8911-3ae5b2139321","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Token","value":"xxxx","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"AccountNumber\":999999, \r\n \"CountryCode\": \"DE\",\r\n \"ZIPCode\": \"80331\",\r\n \"Distance\": 50,\r\n \"Street\": \"Alleestraße\",\r\n \"HouseNumber\": \"13a\",\r\n \"City\": \"Munich\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://ship.gls-us.com/v2/ShopDelivery/Addresses","description":"This endpoint is used to identify available Parcel Shop locations, addresses, and hours of operation within a given location.
\n\n\n","_postman_id":"92991bae-364d-4b85-9a25-c4503ebe766f"},{"name":"Customs(Under Development)","item":[{"name":"Customs","id":"43449eeb-8d15-4432-9bb6-d62fbe76d791","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Token","value":"xxxx"}],"body":{"mode":"raw","raw":"{\r\n \"AccountNumber\": \"1036\",\r\n \"ConsignmentNumber\": \"98410004588\",\r\n \"generateCommercialInvoice\": true,\r\n \"PurchaseOrderNumber\": \"PO7\",\r\n \"packageDescription\": \"Stationery\",\r\n \"CommercialInvoiceNumber\": \"2025/INV/0626-1\",\r\n \"IncotermCode\": \"10\",\r\n \"importer\": {\r\n \"address\": {\r\n \"name1\": \"Importer name\",\r\n \"street1\": \"Via della Rocca\",\r\n \"postcode\": \"00118\",\r\n \"city1\": \"Roccacasale/L'Aquila\",\r\n \"countryCode\": \"IT\",\r\n \"name2\": \"Importer Company\",\r\n \"street2\": \"\",\r\n \"houseNumber\": \"# 25\",\r\n \"stateOrRegion\": \"WD\"\r\n },\r\n \"contactPerson\": {\r\n \"name\": \"Importer contact name\",\r\n \"emailAddress\": \"contact@example.com\",\r\n \"phoneCountryPrefix\": \"+1\",\r\n \"phoneNumber\": \"(510)340-4104\"\r\n },\r\n \"isCommercial\": false,\r\n \"eoriNumber\": \"itlsdj\",\r\n \"taxId\": \"itlkhs\"\r\n },\r\n \"exporter\": {\r\n \"address\": {\r\n \"name1\": \"Exporter name\",\r\n \"street1\": \"4000 Parkway\",\r\n \"postcode\": \"94583\",\r\n \"city1\": \"San Ramon\",\r\n \"countryCode\": \"US\",\r\n \"name2\": \"Exporter Company name\",\r\n \"street2\": \"Suit\",\r\n \"houseNumber\": \"501\",\r\n \"stateOrRegion\": \"CA\"\r\n },\r\n \"contactPerson\": {\r\n \"name\": \"Exporter contact\",\r\n \"emailAddress\": \"exporter@example.com\",\r\n \"phoneCountryPrefix\": \"+1\",\r\n \"phoneNumber\": \"(925) 487-2339\"\r\n },\r\n \"isCommercial\": true,\r\n \"eoriNumber\": \"124\",\r\n \"taxId\": \"2394723kh\",\r\n \"swissUid\": \"usswissid\",\r\n \"vatRegistrationNumber\": \"42412\",\r\n \"authorizationNumber\": \"12098\",\r\n \"loadingPlaceCode\": \"02397kdhkhrwe\"\r\n },\r\n \"itemDetails\": [\r\n {\r\n \"name\": \"Item 1\",\r\n \"code\": \"8\",\r\n \"pieceweight\": 1,\r\n \"grosspieceweight\": \"1\",\r\n \"quantity\": 1,\r\n \"value\": \"35\",\r\n \"hsCode\": \"\",\r\n \"hsDescription\": \"Popular pencils\",\r\n \"countryCodeOfOrigin\": \"NZ\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://ship.gls-us.com/v2/Customs","description":"Note: This endpoint is currently under development and not ready for use. The documentation is only for reference purposes. There may be additional changes during the development.
\n
Description: Customs declaration request payload
Content-Type: application/json
Description: Importer details for customs declaration
\nDescription: Physical address information
\nDescription: Contact person information
\nemailAddress OR (phoneCountryPrefix + phoneNumber) must be provided.Description: Exporter details for customs declaration
\nDescription: Physical address information
Fields are the same as Importer.Address.
Description: Contact person information
Fields are the same as Importer.ContactPerson.
Description: List of items in the shipment
\nname, pieceweight, grosspieceweight, quantity, value, hsCode, countryCodeOfOrigin
This endpoint is used to submit customs declaration details for a shipment. It supports both import and export shipments and optionally generates a commercial invoice based on the request parameters. The API validates importer, exporter, address, contact, and item-level details before processing the request.
\n\n\n","_postman_id":"a27540e9-23fe-416d-a084-8e2c079c6cf2"}],"id":"1035bbdb-be88-4381-a3ed-a285bb39ab96","_postman_id":"1035bbdb-be88-4381-a3ed-a285bb39ab96","description":""}],"event":[{"listen":"prerequest","script":{"id":"2547fdfa-36f6-43d2-8dd9-bf2ef6aa8df9","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"9e108c88-9959-40b3-b70e-78a0126e687c","type":"text/javascript","packages":{},"exec":[""]}}],"variable":[{"id":"30ace478-c2b1-45a3-a4a4-c94a9483a81b","key":"baseUrl","value":"https://ship.gls-us.com"},{"id":"75bbaae9-e703-46d9-97c8-47b1f1ff6cfe","key":"token","value":"xxxx"}]}Note: This endpoint is currently under development
\n