Welcome to the Air Go Express API documentation. Here it is described our API specification.
\nThe API has a JWT type authentication. Please, contact with us and you will be provided with:
\nAPI key: this must be included as header in ALL requests done to the API.
\nUsername and password: you must generate the JWT tokens with this credentials.
\nOnce you are provided with the API key, one username and one password, you can go to the Token folder and follow the instructions described in the Generate token request. Once you obtain the token, save it into a secure place inside your aplication and you will need to pass this value in the Authorization header of your requests preceded by the word \"Bearer\". This token has an expiration of 14 days, so you will need to reauthenticate every 14 days.
\nAir Go Express uses standard HTTP response status codes. All response bodies follow the same structure, it does not matter if they have been good or bad requests. You will receive and object with the following parameters:
\nIn case of successful requests, you will always receive a 200 OK status. You can receive a 200 status code with false in the Success attribute, as it is possible to send a good schema request but do not match some attributes specifications, for example. So, we recommend you to use both (the HTTP status and this attribute) in order to check if the request has been successfully processed.
\nPlease note that every request returns the same body response, so in each request, when we define the response object, we are referring to the Result attribute of the response object described above. In any case, all requests come with several sample responses.
\nWe have two main environments, one for testing and other for production.
\nPRODUCTION: https://api.airgoexpress.net
\nYou can call this method for generating the token that you need for authenticate in all requests. You need to send an object with the following properties:
\nIn case of success, you will receive an object with the following properties:
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"api-key"},{"key":"value","value":"{APIKey}"}]},"isInherited":true,"source":{"_postman_id":"b2b82823-2c19-4efc-8536-d91ca0ab453a","id":"b2b82823-2c19-4efc-8536-d91ca0ab453a","name":"Token","type":"folder"}},"urlObject":{"path":["api","token","generate"],"host":["{BaseURL}"],"query":[],"variable":[]}},"response":[{"id":"fa355469-35dc-44b7-a8a1-8814ccc6689d","name":"Login successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"api-key","value":"{APIKey}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"User\": \"string\",\r\n \"Password\": \"string\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{BaseURL}/api/token/generate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Wed, 01 Feb 2023 09:14:28 GMT"},{"key":"Server","value":"Kestrel"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"Result\": {\n \"Token\": \"string\",\n \"Exp\": 1676452468\n },\n \"Success\": true,\n \"NotificationList\": []\n}"},{"id":"a036a73b-3ea0-49bc-bd65-d84ea1c7cc93","name":"Login failed","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"api-key","value":"{APIKey}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"User\": \"string\",\r\n \"Password\": \"string\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{BaseURL}/api/token/generate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Wed, 01 Feb 2023 09:20:34 GMT"},{"key":"Server","value":"Kestrel"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"Result\": null,\n \"Success\": false,\n \"NotificationList\": [\n \"Incorrect user or password\"\n ]\n}"}],"_postman_id":"a2baab86-98d8-4c03-b68d-ec029495f9f1"}],"id":"b2b82823-2c19-4efc-8536-d91ca0ab453a","description":"In this collection, it is described how you can generate the tokens that must be sent in each request that needs authentication. Each token has a duration of two weeks.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"api-key"},{"key":"value","value":"{APIKey}"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"87a19fa9-9854-4253-9bae-af05436a2195"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"c4b54ecc-9238-4aaa-8881-7f58a21d3c64"}}],"_postman_id":"b2b82823-2c19-4efc-8536-d91ca0ab453a"},{"name":"User","item":[{"name":"Change password","id":"d5291f62-c0ef-480d-aef9-8fe83b4a78b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"api-key","value":"{APIKey}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"Password\": \"string\",\r\n \"NewPassword\": \"string\",\r\n \"RepeatNewPassword\": \"string\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{BaseURL}/api/user/change-password","description":"Calling this method, you can change your password. You must send an object with the following attributes:
\nThis service is made for handle all requests related with user information.
\n","_postman_id":"53ac5b60-ff8e-4b02-ad2d-22a33ed4d219","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This feature allows customers to receive real-time tracking updates for their parcels. To enable this capability, customers must provide a designated endpoint, which we configure in our system to deliver tracking data, using the preferred authentication method:
\nBasic Authentication: Customers may provide username and password, enabling us to authenticate to the endpoint with basic authentication.
\nStatic Token: We can include a static token in the header, using a header name specified by the customer.
\nAdditionally, customers can request configuration of a specific batch size for our tracking updates to optimize request flow and data handling.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"d060c07d-b74a-43b4-ba5b-8db0d13a9a0e","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"90287376-b68f-4053-999c-14781cbb0e91","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"2aa941ae-99b2-4aa7-a364-736b677d15e5"},{"name":"Create shipment","id":"a5c3accd-dd89-4989-b77e-d80c3b3c6b80","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"api-key","value":"{APIKey}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"ProductKey\": \"string\",\r\n \"ExporterName\": \"string\",\r\n \"ExporterAddress\": \"string\",\r\n \"ExporterCountryIso2\": \"string\",\r\n \"ExporterPostCode\": \"string\",\r\n \"ExporterCity\": \"string\",\r\n \"CustomerFirstName\": \"string\",\r\n \"CustomerLastName\": \"string\",\r\n \"CustomerEmail\": \"string@string.com\",\r\n \"CustomerPhone\": \"string\",\r\n \"DeliveryCountryIso2\": \"string\",\r\n \"DeliveryPostalCode\": \"string\",\r\n \"DeliveryCity\": \"string\",\r\n \"DeliveryTown\": \"string\",\r\n \"DeliveryAddress1\": \"string\",\r\n \"DeliveryAddress2\": \"string\",\r\n \"IOSSNumber\": \"string\",\r\n \"ParcelList\": [\r\n {\r\n \"Reference\": \"string\",\r\n \"Weight\": X.XX,\r\n \"Description\": \"string\",\r\n \"Price\": X.XX,\r\n \"SKUList\": [\r\n {\r\n \"Code\": \"string\",\r\n \"Description\": \"string\",\r\n \"HSCode\": \"string\",\r\n \"OriginCountryIso2\": \"string\",\r\n \"Price\": X.XX,\r\n \"Weight\": X.XX\r\n }\r\n ]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{BaseURL}/api/shipment","description":"Use this method to create a new shipment in the Air Go system. The request body must follow the following schema:
\nParcel_Data:
\nSKU_Data:
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Via this method, you can obtain the tracking status of one shipment. You can also get the label in PDF or ZPL format. The response returned follows the following schema:
\nParcel_Data:
\nStatus_Data:
\nReturn_Data
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Shipment reference provided by Air Go
\n","type":"text/plain"},"key":"Reference","value":"AGOXXXXXXXXX"},{"description":{"content":"If you want the label included in the response, specify the desired format. Possible values are: PDF, ZPL.
\n","type":"text/plain"},"key":"LabelFormat","value":"{PDF, ZPL}"}],"variable":[]}},"response":[{"id":"2204440f-8d39-4c8b-8250-557ae3fb950e","name":"Successfull request","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"{APIKey}","type":"text"},{"key":"Authorization","value":"Bearer {Token}","type":"text"}],"url":{"raw":"{BaseURL}/api/shipment?Reference=AGOXXXXXXXXX&LabelFormat={PDF, ZPL}","host":["{BaseURL}"],"path":["api","shipment"],"query":[{"key":"Reference","value":"AGOXXXXXXXXX","description":"Reference provided by Air Go"},{"key":"LabelFormat","value":"{PDF, ZPL}","description":"If you want the label in the response, specify the desired format. Possible values are: PDF, ZPL."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Tue, 19 Mar 2024 09:09:24 GMT"},{"key":"Server","value":"Kestrel"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Security-Policy","value":"default-src 'self'"}],"cookie":[],"responseTime":null,"body":"{\n \"Result\": {\n \"Reference\": \"string\", // The shipment reference provided by Air Go system when creating the shipment\n \"Supplier\": \"string\", // Carrier associated to the shipment\n \"SupplierReference\": \"string\", // Carrier's reference\n \"SupplierTrackingUrl\": \"string\", // Carrier's tracking url\n \"ParcelList\": [{ // Parcels associated to the shipment\n \"InternalReference\": \"string\", // The internal reference provided by customer\n \"Reference\": \"string\", // The reference generated by Air Go for the parcel\n \"SupplierReference\": \"string\", // Carrier's reference\n \"DeclaredWeight\": X.XX, // Weight provided by customer\n \"RealWeight\": X.XX, // Weight measured in Air Go warehouse\n \"Label\": \"string\" // In case of PDF, base64 encoded label. In case of ZPL, the ZPL string\n \n }],\n \"StatusList\": [{ // Historical list of statuses for the shipment\n \"StatusId\": \"string\", // Code identifier for the status\n \"Description\": \"string\", // Description for the status\n \"Date\": \"2024-03-19T09:05:53.539+00:00\" // Date when the status was produced\n }],\n \"SupplierErrorList\": [\"string\", \"string\", \"string\"] // In case of errors when sending information to the last mile carrier, the error list provided by the carrier system\n },\n \"Success\": true,\n \"NotificationList\": []\n}"},{"id":"fadd329d-4331-4327-9b8e-dcc67d5aeb14","name":"Error request","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"{APIKey}","type":"text"},{"key":"Authorization","value":"Bearer {Token}","type":"text"}],"url":{"raw":"{BaseURL}/api/shipment?Reference=AGOXXXXXXXXX&LabelFormat={PDF, ZPL}","host":["{BaseURL}"],"path":["api","shipment"],"query":[{"key":"Reference","value":"AGOXXXXXXXXX","description":"Reference provided by Air Go"},{"key":"LabelFormat","value":"{PDF, ZPL}","description":"If you want the label in the response, specify the desired format. Possible values are: PDF, ZPL."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Tue, 19 Mar 2024 13:31:33 GMT"},{"key":"Server","value":"Kestrel"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Security-Policy","value":"default-src 'self'"}],"cookie":[],"responseTime":null,"body":"{\n \"Result\": null,\n \"Success\": false,\n \"NotificationList\": [\n \"string\",\n \"string\",\n \"string\"\n ]\n}"}],"_postman_id":"772aa924-2c83-46b1-b606-8c022e6bf575"},{"name":"Pack parcels","id":"e2213ec8-a251-48b8-899b-10326b08974b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"api-key","value":"{APIKey}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"ParcelList\": [\"string\", \"string\", \"string\"]\r\n}","options":{"raw":{"language":"json"}}},"url":"{BaseURL}/api/bag/pack-parcels","description":"This API method allows for the efficient grouping of individual parcels into boxes for streamlined handling and transport. By calling this endpoint, customers can package multiple parcels together under a single box reference.
\nBag_Data
\nEach bag can be submitted as many times as necessary (to be able to correct errors), but once the bag is consolidated, it cannot be modified.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This API method enables the consolidation of packaged boxes into a single transportation unit, such as air, sea, or ground transport, to streamline large-scale shipments. By using this endpoint, customers can organize multiple boxes into a consolidated transport unit, which facilitates the customs processing for the entire shipment.
\nConsolidation_Data
\nFile_Data
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Air Go Express S.L. offers a comprehensive last-mile delivery solution for global clients requiring parcel shipments to multiple destinations. This documentation describes the API methods available to enable seamless integration with client systems, facilitating parcel labeling and real-time tracking from initial dispatch to final delivery.
\nTo support this process, we have developed the following schema:
\nOur system generates a shipment (assigned a unique reference number), which can be configured as either a single-parcel or multi-parcel shipment. Each parcel within a multi-parcel shipment is also assigned its own reference number. Consequently, we provide API methods for creating shipments (single or multi-parcel), retrieving shipment status (using the reference number issued by our system), packing parcels within shipments, and consolidating shipments for air, road, or sea transport.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"0c0a46ca-c78d-42a3-9f70-3ad0e26e27a0"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"6181fddc-e6e1-48f9-9912-b4a194f9b2de"}}],"_postman_id":"4b02344f-de11-44e5-9d32-929d8a44843e","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Through this webhook, every time there is a change in one of your manifests, you will receive list of objects at the agreed-upon endpoint with Air Go, as described below:
\nManifest_Response_Status:
\n","urlObject":{"host":["{Customer_URL}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c5fea30a-17a2-48c0-b436-6f2e1e59ce13"},{"name":"Parcel webhook","id":"20bb57ac-fd15-4792-8395-136c31548ec2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"webhook-key","value":"{unique for each customer}","type":"text"}],"body":{"mode":"raw","raw":"[\r\n {\r\n \"AdmissionDate\":\"string\",\r\n \"Importer\":\"string\",\r\n \"Shipment\":\"string\",\r\n \"Circuit\":\"string\",\r\n \"BagReference\":\"string\",\r\n \"Status\":\"string\",\r\n \"StatusList\":[\r\n {\r\n \"Status\":\"string\",\r\n \"Date\":\"string\"\r\n },\r\n {\r\n \"Status\":\"string\",\r\n \"Date\":\"string\"\r\n },\r\n {\r\n \"Status\":\"string\",\r\n \"Date\":\"string\"\r\n }\r\n ],\r\n \"DeliveryProof\": \"string\",\r\n \"Scanned\":false\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"{Customer_URL}","description":"Through this webhook, every time there is a change in one of your parcels, you will receive a list of objects at the agreed-upon endpoint with Air Go, as described below.
\nPlease be aware that for this webhook, requests may be triggered with a substantial number of objects. If the status of 2000 parcels changes simultaneously, your endpoint will receive a single request containing a list of 2000 objects. If you prefer smaller batches of information, such as 100 objects at a time, we can configure a size that accommodates to your system. For example, instead of receiving one request with 2000 objects, you would receive 20 requests each with 100 objects.
\nManifest_Response_Status:
\n","urlObject":{"host":["{Customer_URL}"],"query":[],"variable":[]}},"response":[],"_postman_id":"20bb57ac-fd15-4792-8395-136c31548ec2"}],"id":"4bb12dce-7d02-4bab-ba74-2f819c65c947","description":"This is an option we offer to our customers who wish to receive real-time tracking updates for their manifests.
\nStatus changes can be obtained at both manifest and parcel levels.
\nTo enable this feature, the customer needs to provide us with an endpoint, and we configure our system to send information to that endpoint using static token authentication.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"aa1009b8-005c-4f08-b1ef-48b573ec01b6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6ca23b31-25b2-4fb2-9f2b-148ade78621e","type":"text/javascript","exec":[""]}}],"_postman_id":"4bb12dce-7d02-4bab-ba74-2f819c65c947"},{"name":"Create manifest","id":"b510ccea-706d-4116-9a29-a282d16de0a4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"api-key","value":"{APIKey}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"Invoice\": {\r\n \"Name\": \"string\",\r\n \"Base64Data\": \"string\"\r\n },\r\n \"AirwayBill\": {\r\n \"Name\": \"string\",\r\n \"Base64Data\": \"string\"\r\n },\r\n \"Manifest\": {\r\n \"AWB\": \"string\",\r\n \"FlightDate\": \"string\",\r\n \"AirLine\": \"string\",\r\n \"FlightNumber\": \"string\",\r\n \"Transportation\": \"string\",\r\n \"AirportDepartureIata3\": \"string\",\r\n \"AirportDestinationIata3\": \"string\",\r\n \"EstimatedArrivalDate\": \"string\",\r\n \"BagList\": [\r\n {\r\n \"BagReference\": \"string\",\r\n \"TypeBox\": \"string\",\r\n \"LastMileCarrier\": \"string\",\r\n \"ShipmentList\": [\r\n {\r\n \"PackageBarcode\": \"string\",\r\n \"OrderNumber\": \"string\",\r\n \"ShipperName\": \"string\",\r\n \"IOSSNumber\": \"string\",\r\n \"SourcePlace\": {\r\n \"Address\": \"string\",\r\n \"City\": \"string\",\r\n \"PostalCode\": \"string\",\r\n \"CountryISO2\": \"string\"\r\n },\r\n \"ConsigneeName\": \"string\",\r\n \"NIF\": \"string\",\r\n \"DestinationPlace\": {\r\n \"Address\": \"string\",\r\n \"City\": \"string\",\r\n \"PostalCode\": \"string\",\r\n \"CountryISO2\": \"string\"\r\n },\r\n \"Description\": \"string\",\r\n \"Weight\": X.XX,\r\n \"Price\": X.XX,\r\n \"HSCode\": \"string\",\r\n \"CustomClearance\": \"string\",\r\n \"CustomLocation\": \"string\",\r\n \"B2CShippingMethod\": \"string\",\r\n \"SKUList\": [\r\n {\r\n \"Code\": \"string\",\r\n \"HSCode\": \"string\",\r\n \"Description\": \"string\",\r\n \"OriginCountryIso2\": \"string\",\r\n \"Weight\": X.XX,\r\n \"Price\": X.XX,\r\n \"Quantity\": X\r\n }\r\n ]\r\n }\r\n ]\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{BaseURL}/api/manifest","description":"With this API call, you can send all the information related with a manifest. This information will be automatically notified and processed when due. The object that must be sent has the following structure:
\nPost_Manifest_Request:
\nFile_Data:
\nManifest_Data:
\nManifest_Bag_Data:
\nManifest_Bag_Shipment_Data:
\nManifest_Bag_Shipment_SKU_Data:
\nPlace_Data:
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"In this request, you can obtain the status of one of your sent manifests. There are six statuses, in the following order:
\nIn case of the request has been successful, you will receive and object with the following properties:
\nManifest_Response_Bag:
\nManifest_Response_Circuit:
\nManifest_Response_Status:
\nFile_Data:
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"AWB number that identifies the manifest. Mandatory.
\n","type":"text/plain"},"key":"awb","value":"112-36158673"}],"variable":[]}},"response":[{"id":"3e6d95ed-1fd7-4276-a62e-47cc5794abea","name":"Successfull request","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"{APIKey}","type":"text"},{"key":"Authorization","value":"Bearer {Token}","type":"text"}],"url":{"raw":"{BaseURL}/api/manifest?awb={awb}","host":["{BaseURL}"],"path":["api","manifest"],"query":[{"key":"awb","value":"{awb}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Wed, 01 Feb 2023 19:28:48 GMT"},{"key":"Server","value":"Kestrel"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"Result\": {\n \"AWB\": \"string\",\n \"Status\": \"string\",\n \"BagList\": [{\n \"BagReference\": \"string\",\n \"Scanned\": true\n }],\n \"CircuitList\": [\n {\n \"AdmissionDate\": \"string\",\n \"Importer\": \"string\",\n \"Shipment\": \"string\",\n \"Circuit\": \"string\",\n \"BagReference\": \"string\",\n \"Status\": \"string\",\n \"StatusList\": [\n {\n \"Status\": \"string\",\n \"Date\": \"string\"\n }\n ],\n \"DeliveryProof\": {\n \"Name\": \"string\",\n \"ContentType\": \"string\",\n \"Base64Data\": \"string\"\n },\n \"Scanned\": false\n },\n {\n \"AdmissionDate\": \"string\",\n \"Importer\": \"string\",\n \"Shipment\": \"string\",\n \"Circuit\": \"string\",\n \"BagReference\": \"string\",\n \"Status\": \"string\",\n \"StatusList\": [\n {\n \"Status\": \"string\",\n \"Date\": \"string\"\n }\n ],\n \"DeliveryProof\": {\n \"Name\": \"string\",\n \"ContentType\": \"string\",\n \"Base64Data\": \"string\"\n },\n \"Scanned\": true\n }\n ],\n \"StatusHistoryList\": [\n {\n \"Status\": \"string\",\n \"Date\": \"string\"\n },\n {\n \"Status\": \"string\",\n \"Date\": \"string\"\n }\n ],\n \"DeliveryProofList\": [\n {\n \"Name\": \"string\",\n \"ContentType\": \"string\",\n \"Base64Data\": \"string\"\n },\n {\n \"Name\": \"string\",\n \"ContentType\": \"string\",\n \"Base64Data\": \"string\"\n }\n ]\n },\n \"Success\": true,\n \"NotificationList\": []\n}"},{"id":"5fca543a-f476-4512-af37-4fabe46eea5e","name":"Request with errors","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"{APIKey}","type":"text"},{"key":"Authorization","value":"Bearer {Token}","type":"text"}],"url":{"raw":"{BaseURL}/api/manifest?awb={awb}","host":["{BaseURL}"],"path":["api","manifest"],"query":[{"key":"awb","value":"{awb}","description":"AWB number that identifies the manifest. Mandatory."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"186"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Mon, 13 Mar 2023 16:02:36 GMT"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Request-Context","value":"appId=cid-v1:da9daa0a-6f7f-417e-b11b-e1a725dd1f33"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Security-Policy","value":"default-src 'self'"},{"key":"Content-Security-Policy","value":"default-src 'self'"}],"cookie":[],"responseTime":null,"body":"{\n \"Result\": null,\n \"Success\": false,\n \"NotificationList\": [\n \"Manifest not found\"\n ]\n}"}],"_postman_id":"5dd6a72f-b358-497b-925f-4b7547d393d2"},{"name":"Get parcel status","id":"700da1da-1e3c-4e61-b498-d3dd1264c7e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"api-key","value":"{APIKey}","type":"text"}],"url":"{BaseURL}/api/manifest/parcel-status?awb=157-92808671&barcode=0082800082809734581783","description":"This method is limited to 100 QPM (queries per minute).
\nThis method must be used when you want to obtain the different statuses of one parcel inside a manifest. There are several statuses:
\nIn case of the request has been successful, you will receive an object with the following properties:
\nManifest_Response_Status:
\nFile_Data
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"AWB number that identifies the manifest. Mandatory.
\n","type":"text/plain"},"key":"awb","value":"157-92808671"},{"description":{"content":"Barcode of the parcel that wants to be queried. Mandatory.
\n","type":"text/plain"},"key":"barcode","value":"0082800082809734581783"}],"variable":[]}},"response":[{"id":"ca268512-11c6-48f6-a747-456c476fe625","name":"Successfull request","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"{APIKey}","type":"text"},{"key":"Authorization","value":"Bearer {Token}","type":"text"}],"url":{"raw":"{BaseURL}/api/manifest/parcel-status?awb={awb}&barcode={barcode}","host":["{BaseURL}"],"path":["api","manifest","parcel-status"],"query":[{"key":"awb","value":"{awb}","description":"AWB number that identifies the manifest. Mandatory."},{"key":"barcode","value":"{barcode}","description":"Barcode of the parcel that wants to be queried. Mandatory."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Wed, 01 Feb 2023 19:28:48 GMT"},{"key":"Server","value":"Kestrel"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"Result\": {\n \"AdmissionDate\": \"string\",\n \"Importer\": \"string\",\n \"Shipment\": \"string\",\n \"Circuit\": \"string\",\n \"BagReference\": \"string\",\n \"Status\": \"string\",\n \"StatusList\": [\n {\n \"Status\": \"string\",\n \"Date\": \"string\"\n },\n {\n \"Status\": \"string\",\n \"Date\": \"string\"\n },\n {\n \"Status\": \"string\",\n \"Date\": \"string\"\n }\n ],\n \"DeliveryProof\": {\n \"Name\": \"string\",\n \"ContentType\": \"string\",\n \"Base64Data\": \"string\"\n },\n \"Scanned\": false\n },\n \"Success\": true,\n \"NotificationList\": []\n}"},{"id":"34d060d2-680c-49a3-b8f9-e4c5705feea5","name":"Request with errors","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"{APIKey}","type":"text"},{"key":"Authorization","value":"Bearer {Token}","type":"text"}],"url":{"raw":"{BaseURL}/api/manifest/parcel-status?awb={awb}&barcode={barcode}","host":["{BaseURL}"],"path":["api","manifest","parcel-status"],"query":[{"key":"awb","value":"{awb}","description":"AWB number that identifies the manifest. Mandatory."},{"key":"barcode","value":"{barcode}","description":"Barcode of the parcel that wants to be queried. Mandatory."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"186"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Mon, 13 Mar 2023 16:02:36 GMT"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Request-Context","value":"appId=cid-v1:da9daa0a-6f7f-417e-b11b-e1a725dd1f33"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Security-Policy","value":"default-src 'self'"},{"key":"Content-Security-Policy","value":"default-src 'self'"}],"cookie":[],"responseTime":null,"body":"{\n \"Result\": null,\n \"Success\": false,\n \"NotificationList\": [\n \"Unauthorized\"\n ]\n}"},{"id":"5dede745-7043-4fdf-8bc1-a34102cca6a5","name":"Shipment not found","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"{APIKey}","type":"text"},{"key":"Authorization","value":"Bearer {Token}","type":"text"}],"url":{"raw":"{BaseURL}/api/manifest/parcel-status?awb={awb}&barcode={barcode}","host":["{BaseURL}"],"path":["api","manifest","parcel-status"],"query":[{"key":"awb","value":"{awb}","description":"AWB number that identifies the manifest. Mandatory."},{"key":"barcode","value":"{barcode}","description":"Barcode of the parcel that wants to be queried. Mandatory."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"186"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Mon, 13 Mar 2023 16:02:36 GMT"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Request-Context","value":"appId=cid-v1:da9daa0a-6f7f-417e-b11b-e1a725dd1f33"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Security-Policy","value":"default-src 'self'"},{"key":"Content-Security-Policy","value":"default-src 'self'"}],"cookie":[],"responseTime":null,"body":"{\n \"Result\": null,\n \"Success\": false,\n \"NotificationList\": [\n \"Shipment not found\"\n ]\n}"}],"_postman_id":"700da1da-1e3c-4e61-b498-d3dd1264c7e7"},{"name":"Cancel manifest","id":"0eee43c7-fe1d-4764-a71f-5522dc85fc58","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"api-key","value":"{APIKey}","type":"text"}],"url":"{BaseURL}/api/manifest?awb={awb}","description":"You can use this request to cancel a manifest. Please note that manifests can only be cancelled under WAITING_FOR_SUMMARY_ACTIVATION status.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"AWB of the shipment that wants to be cancelled
\n","type":"text/plain"},"key":"awb","value":"{awb}"}],"variable":[]}},"response":[{"id":"f8badc89-ae4b-47d9-8027-4dd4c70ebf60","name":"Successfully cancelled","originalRequest":{"method":"DELETE","header":[{"key":"api-key","value":"{APIKey}","type":"text"},{"key":"Authorization","value":"Bearer {Token}","type":"text"}],"url":{"raw":"{BaseURL}/api/manifest?awb={awb}","host":["{BaseURL}"],"path":["api","manifest"],"query":[{"key":"awb","value":"{awb}","description":"AWB of the shipment that wants to be cancelled"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"167"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Mon, 13 Mar 2023 11:29:21 GMT"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Request-Context","value":"appId=cid-v1:da9daa0a-6f7f-417e-b11b-e1a725dd1f33"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Security-Policy","value":"default-src 'self'"},{"key":"Content-Security-Policy","value":"default-src 'self'"}],"cookie":[],"responseTime":null,"body":"{\n \"Result\": null,\n \"Success\": true,\n \"NotificationList\": []\n}"},{"id":"d1d569e7-9da0-456f-be6e-c91e015ba34b","name":"Manifest not found","originalRequest":{"method":"DELETE","header":[{"key":"api-key","value":"{APIKey}","type":"text"},{"key":"Authorization","value":"Bearer {Token}","type":"text"}],"url":{"raw":"{BaseURL}/api/manifest?awb={awb}","host":["{BaseURL}"],"path":["api","manifest"],"query":[{"key":"awb","value":"{awb}","description":"AWB of the shipment that wants to be cancelled"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"186"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Mon, 13 Mar 2023 11:29:53 GMT"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Request-Context","value":"appId=cid-v1:da9daa0a-6f7f-417e-b11b-e1a725dd1f33"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Security-Policy","value":"default-src 'self'"},{"key":"Content-Security-Policy","value":"default-src 'self'"}],"cookie":[],"responseTime":null,"body":"{\n \"Result\": null,\n \"Success\": false,\n \"NotificationList\": [\n \"Manifest not found\"\n ]\n}"}],"_postman_id":"0eee43c7-fe1d-4764-a71f-5522dc85fc58"}],"id":"29d5f078-0dbb-4bb4-86f0-0b0906de6c35","description":"This collection is destintated to describe methods related to customs.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"b119ab4e-53aa-41fb-b33d-db1d6efa81e7"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"4b036cd3-795b-495a-94d9-217e3c0d6e77"}}],"_postman_id":"29d5f078-0dbb-4bb4-86f0-0b0906de6c35","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"