Example Response
\n401 - Unauthorization
\nno Authorization header found\n\n422 - Unprocessable Entity
\n{\n \"error\": {\n \"statusCode\": 422,\n \"name\": \"UnprocessableError\",\n \"message\": [\n {\n \"id\": \"VALIDATION_ERROR_JOB_ORDER_001\",\n \"message\": \"(customsCode) Customs code must be provided with 6 characters.\"\n },\n {\n \"id\": \"VALIDATION_ERROR_JOB_ORDER_002\",\n \"message\": \"(exitCustomsCode) The exit customs code must be sent with 6 characters. For customs with 5 digits, 0 must be added at the beginning of the customs code.\"\n },\n {\n \"id\": \"VALIDATION_ERROR_JOB_ORDER_004\",\n \"message\": \"(bankCode) Bank code must be provided with 12 digits.\"\n },\n {\n \"id\": \"VALIDATION_ERROR_CONSIGNEE_002\",\n \"message\": \"(countryCode) The short name of the importer company's country must be provided in 2 characters.\"\n },\n {\n \"id\": \"VALIDATION_ERROR_INVOICE_004\",\n \"message\": \"(invoiceAmountCurrency) Invoice amount currency information must be provided. Related invoice: BAY202200000000.\"\n },\n {\n \"id\": \"VALIDATION_ERROR_INVOICE_005\",\n \"message\": \"gtbReferenceNo field must be provided with 23 characters or can be sent empty. Related invoice: BAY202200000000.\"\n },\n {\n \"id\": \"VALIDATION_ERROR_INVOICE_006\",\n \"message\": \"(gtbReferenceDate) The invoice approval date information was sent incorrectly. It must be in the correct format (day/month/year) or be sent blank. Related invoice: BAY202200000000.\"\n },\n {\n \"id\": \"VALIDATION_ERROR_INVOICE_007\",\n \"message\": \"(countryOfDestinationCode) Short name of destination country must be provided. Related invoice: BAY202200000000.\"\n },\n {\n \"id\": \"VALIDATION_ERROR_ITEM_002\",\n \"message\": \"(originCountryCode) The short name of the country of origin must be provided with 2 characters. Related item: BAY202200000000/1.\"\n },\n {\n \"id\": \"VALIDATION_ERROR_ITEM_003\",\n \"message\": \"(procedure) Regime information must be provided with 4 characters. Related item: BAY202200000000/1.\"\n },\n {\n \"id\": \"VALIDATION_ERROR_ITEM_004\",\n \"message\": \"(incoterms) The delivery mode code must be provided with 3 characters. Related item: BAY202200000000/1.\"\n },\n {\n \"id\": \"VALIDATION_ERROR_ITEM_005\",\n \"message\": \"(hsCode) Commodity Code must be provided with 12 character. Related item: BAY202200000000/1.\"\n },\n {\n \"id\": \"VALIDATION_ERROR_ITEM_007\",\n \"message\": \"(invoiceAmountCurrency) The currency code of item must be provided with 3 characters. Related item: BAY202200000000/1.\"\n },\n {\n \"id\": \"VALIDATION_ERROR_ITEM_011\",\n \"message\": \"(packagingType) The packaging type code of item must be provided with 2 characters. Related item: BAY202200000000/1.\"\n },\n {\n \"id\": \"VALIDATION_ERROR_ITEM_034\",\n \"message\": \"(processingDocumentYear) The year of the inward/external processing document must be provided in 4 characters or sent empty. Related item: BAY202200000000/1.\"\n },\n {\n \"id\": \"VALIDATION_ERROR_ITEM_002\",\n \"message\": \"(originCountryCode) The short name of the country of origin must be provided with 2 characters. Related item: BAY202200000000/2.\"\n },\n {\n \"id\": \"VALIDATION_ERROR_ITEM_003\",\n \"message\": \"(procedure) Regime information must be provided with 4 characters. Related item: BAY202200000000/2.\"\n },\n {\n \"id\": \"VALIDATION_ERROR_ITEM_004\",\n \"message\": \"(incoterms) The delivery mode code must be provided with 3 characters. Related item: BAY202200000000/2.\"\n },\n {\n \"id\": \"VALIDATION_ERROR_ITEM_005\",\n \"message\": \"(hsCode) Commodity Code must be provided with 12 character. Related item: BAY202200000000/2.\"\n },\n {\n \"id\": \"VALIDATION_ERROR_ITEM_007\",\n \"message\": \"(invoiceAmountCurrency) The currency code of item must be provided with 3 characters. Related item: BAY202200000000/2.\"\n },\n {\n \"id\": \"VALIDATION_ERROR_ITEM_011\",\n \"message\": \"(packagingType) The packaging type code of item must be provided with 2 characters. Related item: BAY202200000000/2.\"\n },\n {\n \"id\": \"VALIDATION_ERROR_INVOICE_004\",\n \"message\": \"(invoiceAmountCurrency) Invoice amount currency information must be provided. Related invoice: BAY202200000000.\"\n },\n {\n \"id\": \"VALIDATION_ERROR_INVOICE_005\",\n \"message\": \"gtbReferenceNo field must be provided with 23 characters or can be sent empty. Related invoice: BAY202200000000.\"\n },\n {\n \"id\": \"VALIDATION_ERROR_INVOICE_006\",\n \"message\": \"(gtbReferenceDate) The invoice approval date information was sent incorrectly. It must be in the correct format (day/month/year) or be sent blank. Related invoice: BAY202200000000.\"\n },\n {\n \"id\": \"VALIDATION_ERROR_INVOICE_007\",\n \"message\": \"(countryOfDestinationCode) Short name of destination country must be provided. Related invoice: BAY202200000000.\"\n },\n {\n \"id\": \"VALIDATION_ERROR_ITEM_002\",\n \"message\": \"(originCountryCode) The short name of the country of origin must be provided with 2 characters. Related item: BAY202200000000/1.\"\n },\n {\n \"id\": \"VALIDATION_ERROR_ITEM_003\",\n \"message\": \"(procedure) Regime information must be provided with 4 characters. Related item: BAY202200000000/1.\"\n },\n {\n \"id\": \"VALIDATION_ERROR_ITEM_004\",\n \"message\": \"(incoterms) The delivery mode code must be provided with 3 characters. Related item: BAY202200000000/1.\"\n },\n {\n \"id\": \"VALIDATION_ERROR_ITEM_005\",\n \"message\": \"(hsCode) Commodity Code must be provided with 12 character. Related item: BAY202200000000/1.\"\n },\n {\n \"id\": \"VALIDATION_ERROR_ITEM_007\",\n \"message\": \"(invoiceAmountCurrency) The currency code of item must be provided with 3 characters. Related item: BAY202200000000/1.\"\n },\n {\n \"id\": \"VALIDATION_ERROR_ITEM_011\",\n \"message\": \"(packagingType) The packaging type code of item must be provided with 2 characters. Related item: BAY202200000000/1.\"\n },\n {\n \"id\": \"VALIDATION_ERROR_ITEM_002\",\n \"message\": \"(originCountryCode) The short name of the country of origin must be provided with 2 characters. Related item: BAY202200000000/2.\"\n },\n {\n \"id\": \"VALIDATION_ERROR_ITEM_003\",\n \"message\": \"(procedure) Regime information must be provided with 4 characters. Related item: BAY202200000000/2.\"\n },\n {\n \"id\": \"VALIDATION_ERROR_ITEM_004\",\n \"message\": \"(incoterms) The delivery mode code must be provided with 3 characters. Related item: BAY202200000000/2.\"\n },\n {\n \"id\": \"VALIDATION_ERROR_ITEM_005\",\n \"message\": \"(hsCode) Commodity Code must be provided with 12 character. Related item: BAY202200000000/2.\"\n },\n {\n \"id\": \"VALIDATION_ERROR_ITEM_007\",\n \"message\": \"(invoiceAmountCurrency) The currency code of item must be provided with 3 characters. Related item: BAY202200000000/2.\"\n },\n {\n \"id\": \"VALIDATION_ERROR_ITEM_011\",\n \"message\": \"(packagingType) The packaging type code of item must be provided with 2 characters. Related item: BAY202200000000/2.\"\n }\n ],\n \"details\": \"undefined\\nERR_UnprocessableError\\n[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]\\nundefined\"\n }\n}\n\nExample Response
\n401 - Unauthorization
\nno Authorization header found\n\n500 - Internal Server Error
\n{\n \"error\": {\n \"statusCode\": 500,\n \"name\": \"error\",\n \"message\": \"invalid input syntax for type uuid: \\\"123\\\"\",\n \"details\": \"error: invalid input syntax for type uuid: \\\"123\\\"\\n at Parser.parseErrorMessage (/app/node_modules/pg-protocol/dist/parser.js:283:98)\\n at Parser.handlePacket (/app/node_modules/pg-protocol/dist/parser.js:122:29)\\n at Parser.parse (/app/node_modules/pg-protocol/dist/parser.js:35:38)\\n at Socket.<anonymous> (/app/node_modules/pg-protocol/dist/index.js:11:42)\\n at Socket.emit (node:events:524:28)\\n at addChunk (node:internal/streams/readable:561:12)\\n at readableAddChunkPushByteMode (node:internal/streams/readable:512:3)\\n at Readable.push (node:internal/streams/readable:392:5)\\n at TCP.onStreamRead (node:internal/stream_base_commons:191:23)\\n at TCP.callbackTrampoline (node:internal/async_hooks:130:17)\"\n }\n}\n\nExample Response
\n401 - Unauthorization
\nno Authorization header found\n\n422 - Unprocessable Entity
\n{\n \"error\": {\n \"statusCode\": 422,\n \"name\": \"ValidationError\",\n \"message\": \"Detailed validation errors\",\n \"details\": [\n {\n \"id\": \"VALIDATION_ERROR_001\",\n \"message\": \"Job order id must be provided.\"\n }\n ]\n }\n}\n\nExample Response
\n401 - Unauthorization
\nno Authorization header found\n\nThe exporter initiates the export process by submitting the Export Job Order Request, and the process continues up to the creation of foreign import declarations for goods entering the destination country. This entire workflow is carried out by Declarant and other relevant actors.
In this way, Declarant introduces a new approach to the export customs process, which traditionally progresses in a step-by-step manner and involves mutual waiting: instead of starting the process prematurely with missing data, the exporter is expected to initiate the process only after all related procedures on their end are clarified and all necessary information is obtained.
This ensures that the process progresses quickly and automatically, without the need for back and forth data exchanges.
The first phase of the process, in which the exporter is actively involved up to the registration of the export declarationcan be schematized as follows:
Example Response
\n401 - Unauthorization
\nno Authorization header found\n\n500 - Internal Server Error
\n{\n \"error\": {\n \"statusCode\": 500,\n \"name\": \"error\",\n \"message\": \"invalid input syntax for type uuid: \\\"123\\\"\",\n \"details\": \"error: invalid input syntax for type uuid: \\\"123\\\"\\n at Parser.parseErrorMessage (/app/node_modules/pg-protocol/dist/parser.js:283:98)\\n at Parser.handlePacket (/app/node_modules/pg-protocol/dist/parser.js:122:29)\\n at Parser.parse (/app/node_modules/pg-protocol/dist/parser.js:35:38)\\n at Socket.<anonymous> (/app/node_modules/pg-protocol/dist/index.js:11:42)\\n at Socket.emit (node:events:524:28)\\n at addChunk (node:internal/streams/readable:561:12)\\n at readableAddChunkPushByteMode (node:internal/streams/readable:512:3)\\n at Readable.push (node:internal/streams/readable:392:5)\\n at TCP.onStreamRead (node:internal/stream_base_commons:191:23)\\n at TCP.callbackTrampoline (node:internal/async_hooks:130:17)\"\n }\n}\n\nThe endpoint allows users to upload files for a direct export job with the specified job order ID.
\nRequest Payload application/json
\nfiles REQUIRED array object
Array object representing uploaded files informations such as id, fileName, fileType, fileBusinessType
\n
files/id REQUIRED string
String representing file id. Sample: \"id\": \"3c224d7a-ed95-4289-bb91-8a104730e70e\"
\n
files/fileName REQUIRED string
String representing file name. Sample: \"fileName\": \"1674411.pl\"
\n
files/fileType REQUIRED string
String representing file type. Such as pdf,jpg.
\n
files/fileBusinessType REQUIRED string
String representing file business type. Such as \"E-invoice\", \"Commercial_Invoice\", \"Packing_List\", \"Other\"
Example Response
\n401 - Unauthorization
\nno Authorization header found\n\n422 - UnprocessableError
\n{\n \"error\": {\n \"statusCode\": 422,\n \"name\": \"UnprocessableError\",\n \"message\": {\n \"id\": \"DB_DATA_ERROR_002\",\n \"message\": \"Same file cannot be sent more than once. File: xopejroz.\"\n },\n \"details\": \"undefined\\nERR_UnprocessableError\\n[object Object]\\nundefined\"\n }\n\n\nThe endpoint lets users see uploaded files with the specified job order ID and file ID for a direct export job.
\nExample Response
\n401 - Unauthorization
\n{no Authorization header found\n\nTo upload a file, execute the POST request located under the \"Post Services\" section within the \"Upload Services\" folder of the Declarant collection.
\nOnce uploaded, the files can be retrieved using the GET request found under the \"Get Services\" section.
\n","_postman_id":"c6ee0667-4a66-4027-a287-16cd2253ac0d"},{"name":"TOKEN","item":[{"name":"Create Token","event":[{"listen":"test","script":{"id":"6e002380-8be4-47ae-a18a-0b18a020a3fc","exec":[""],"type":"text/javascript","packages":{}}}],"id":"04aa1d0c-ff91-4648-bfa5-d20b48c948fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"client_credentials","type":"text"},{"key":"client_id","value":"your-declarant-admin-user","type":"text"},{"key":"client_secret","value":"your_client_secret","type":"text"}]},"url":"https://dev-kc.singlewindow.io/auth/realms/agsw/protocol/openid-connect/token","description":"This HTTP POST request is used to obtain an access token.
\nRequest Body Parameters
\n- \n
grant_type
\nREQUIREDstring: The type of grant being requested. \nclient_id
\nREQUIREDstring: The client identifier. \nclient_secret
\nREQUIREDstring: The client secret. \n
Upon successful authentication, the response will include the access token and relevant details.
\nExample Response
\n400 - BadRequest
\n{\n \"error\": \"invalid_request\",\n \"error_description\": \"Missing form parameter: grant_type\"\n}\n\n401 - Unauthorization
\n{\n \"error\": \"unauthorized_client\",\n \"error_description\": \"Invalid client or Invalid client credentials\"\n}\n\nAI and integration-powered customs declaration preparation system
\nOGI is a comprehensive customs declaration preparation system that leverages AI to automatically identify submitted documents and extract declaration-relevant data within minutes. It seamlessly integrates with ERP systems such as SAP, ensuring compliance with customs regulations through autonomous data flow and transmitting declaration data directly to the relevant submission systems.
\nInitially implemented in the field of exports, OGI (also referred to as Declarant) was designed to automate customs processes by collecting additional data from exporters related to e-invoice fields and processing it accordingly. Once the data is entered into the system, it enables a fill rate of up to 99% in export declarations. This significantly accelerates the preparation process, enhances accuracy and security in data transmission, and minimizes human error.
\nWith direct transmission, a new standard of data security is established. Over time, the scope of OGI expanded to include ATR and EUR1 circulation documents by introducing a few additional input fields. Certificates of Origin (C/O) and Form-A documents are also now automatically prepared within the system.
\nOPERATION OF THE SYSTEM:
Within the scope of Declarant, the export process begins with the receipt of the e-invoice from the exporter.
This e-invoice includes both mandatory and supplementary information. Declarant processes this request and generates the relevant documents accordingly.
\nBased on the provided data, the following documents can be created:
\n- \n
Export Declaration
\n \nA.TR Circulation Certificate (upon request)
\n \nEUR.1 Movement Certificate (upon request)
\n \nCertificate of Origin – C/O (upon request)
\n \nForm-A Certificate of Origin (upon request)
\n \n
If Declarant is also used in the context of transport documents, then after the declaration process is completed, the transporter (or agency) submits a separate request containing the necessary additional information. Based on this request, Declarant can generate the following documents:
\n- \n
T1 Transit Declaration
\n \nCMR Transport Document (upon request)
\n \nInternational Import Declaration (for Germany and Austria – upon request)
\n \n
The entire Declarant export process is illustrated in the diagrams below:
\nThis HTTP POST request is used to obtain an access token.
\nRequest Body Parameters
\n- \n
grant_type
\nREQUIREDstring: The type of grant being requested. \nclient_id
\nREQUIREDstring: The client identifier. \nclient_secret
\nREQUIREDstring: The client secret. \n
Upon successful authentication, the response will include the access token and relevant details.
\nExample Response
\n401 - Unauthorization
\n{\n \"error\": \"invalid_grant\",\n \"error_description\": \"Invalid user credentials\"\n}\n\nThis endpoint allows you to make an HTTP POST request to create a classification order. The request should include a payload in the raw request body type, containing information such as:
\nRequest Payload application/json
\n- \n
title
\nOPTIONALstring
String representing the group code of the uploaded product. Sample: \"title\": \"ABC-10005515\" \ncustomsBrokerIdentifier
\nOPTIONALstring
String representing the unique identifier of the customs broker. Sample: \"customsBrokerIdentifier\": \"4\" \nclientIdentifier
\nOPTIONALstring
String representing the unique identifier of the client. Sample: \"clientIdentifier\": \"dedecorp\" \nuser_identifier
\nREQUIREDstring
String representing the email of the user who initiated the process. Sample: \"user_identifier\": \"user@example.com\" \nnotification_emails
\nREQUIREDstring array
An array of email addresses to be used for sending notifications. Sample: \"notification_emails\": [\"user1@example.com\", \"user2@example.com\"] \narticles
\nREQUIREDobject array
Array of classification article objects, each containing detailed information about the article, such as its unique identifier, description, commercial details, raw material, and HS code. \narticles/articleIdentifier
\nREQUIREDstring
Unique identifier of the classification article. Sample: \"articleIdentifier\": \"new-integration-test-d-1\" \narticles/articleDescription
\nOPTIONALstring
Description of the classification article. Sample: \"articleDescription\": \"ASIN-0005 DESC\" \narticles/placeOfUseAndPurpose
\nOPTIONALstring
Information about where and how the article will be used. Sample: \"placeOfUseAndPurpose\": \"Industrial machinery component\" \narticles/rawMaterial
\nOPTIONALstring
Information about the raw material of the article. Sample: \"rawMaterial\": \"Plastic\" \narticles/hsCode
\nOPTIONALstring
Harmonized System (HS) code of the article. Sample: \"hsCode\": \"3926.90.97.90.18\" \narticles/comment
\nOPTIONALstring
Additional comments regarding the article. \narticles/commercialDescription
\nREQUIREDstring
The commercial description of the article. Sample: \"commercialDescription\": \"High-grade industrial plastic component\" \narticles/gtipCodes
\nOPTIONALobject array
Array of GTIP codes associated with the article, including geographical area codes and classification details. \narticles/translations
\nOPTIONALobject array
Array of translated descriptions of the article for different languages. \nservices
\nREQUIREDobject array
Array of commodity service objects, each defining specific services related to the commodity. \nservices/id
\nOPTIONALnumber
Unique identifier for the commodity service, automatically generated if not provided. \nservices/oid
\nOPTIONALstring
Optional unique identifier associated with the commodity service. \nservices/serviceCode
\nREQUIREDstring
The service code representing the type of service applied to the commodity. Sample: \"serviceCode\": \"HsCls\" \nservices/geoAreaCode
\nOPTIONALstring
Geographical area code indicating where the service applies. Sample: \"geoAreaCode\": \"TR\" \n
Response Body application/json
\nResponse upon successful creation of the commodity, the response will include:
\n- \n
id
\nREQUIREDnumber
Unique identifier of the created commodity. Sample: \"id\": 495743 \noid
\nREQUIREDstring
Unique identifier (UUID) associated with the commodity. Sample: \"oid\": \"6f5a2e3f-bb18-43a5-8257-3f0d2951c016\" \ncreatedBy
\nREQUIREDnumber
Identifier of the user who created the commodity. Sample: \"createdBy\": 1 \narticle
\nREQUIREDstring
Name or identifier of the article associated with the commodity. Sample: \"article\": \"2024-test-documentation-12\" \nproductDescription
\nOPTIONALstring
Description of the product or commodity. Sample: \"productDescription\": \"2024-test-documentation-12\" \ncommodityStatus
\nOPTIONALstring
Current status of the commodity. Sample: \"commodityStatus\": \"CURRENT\" \nuploadGroupCode
\nOPTIONALstring
Group code associated with the upload process. Sample: \"uploadGroupCode\": \"ALIDEDE-1000009583\" \nclientId
\nREQUIREDnumber
Identifier of the client associated with the commodity. Sample: \"clientId\": 3 \n
401 - Unauthorization
\nno Authorization header found\n\n422 - Unprocessable Entity Error
\n{\n \"error\": {\n \"statusCode\": 422,\n \"name\": \"UnprocessableEntityError\",\n \"message\": \"The request body is invalid. See error object `details` property for more info.\",\n \"code\": \"VALIDATION_FAILED\",\n \"details\": [\n {\n \"path\": \"\",\n \"code\": \"required\",\n \"message\": \"must have required property 'notification_emails'\",\n \"info\": {\n \"missingProperty\": \"notification_emails\"\n }\n },\n {\n \"path\": \"\",\n \"code\": \"required\",\n \"message\": \"must have required property 'articles'\",\n \"info\": {\n \"missingProperty\": \"articles\"\n }\n },\n {\n \"path\": \"\",\n \"code\": \"required\",\n \"message\": \"must have required property 'services'\",\n \"info\": {\n \"missingProperty\": \"services\"\n }\n }\n ],\n \"status\": 422,\n \"expose\": true,\n \"stack\": \"UnprocessableEntityError: The request body is invalid. See error object `details` property for more info.\\n at Object.invalidRequestBody (/home/node/app/node_modules/@loopback/rest/dist/rest-http-error.js:46:30)\\n at validateValueAgainstSchema (/home/node/app/node_modules/@loopback/rest/dist/validation/request-body.validator.js:133:34)\\n at process.processTicksAndRejections (node:internal/process/task_queues:95:5)\\n at async validateRequestBody (/home/node/app/node_modules/@loopback/rest/dist/validation/request-body.validator.js:50:5)\\n at async buildOperationArguments (/home/node/app/node_modules/@loopback/rest/dist/parser.js:57:5)\\n at async /home/node/app/node_modules/@loopback/rest/dist/providers/parse-params.provider.js:52:28\\n at async _0x33342f.interceptor (/home/node/app/node_modules/@loopback/express/dist/middleware-interceptor.js:82:25)\\n at async _0x267539.interceptor (/home/node/app/node_modules/@loopback/express/dist/middleware-interceptor.js:82:25)\\n at async /home/node/app/node_modules/@loopback/express/dist/middleware-interceptor.js:82:25\\n at async /home/node/app/node_modules/@loopback/express/dist/middleware-interceptor.js:82:25\\n at async /home/node/app/node_modules/@loopback/express/dist/middleware-interceptor.js:82:25\\n at async /home/node/app/node_modules/@loopback/rest/dist/providers/send.provider.js:39:32\\n at async MySequence.handle (/home/node/app/node_modules/@loopback/rest/dist/sequence.js:201:9)\\n at async MySequence.handle (/home/node/app/dist/sequence.js:1:3549)\\n at async HttpHandler._handleRequest (/home/node/app/node_modules/@loopback/rest/dist/http-handler.js:64:9)\"\n }\n}\n\n400 - Bad Request
\n{\n \"error\": {\n \"statusCode\": 400,\n \"name\": \"SyntaxError\",\n \"message\": \"Expected property name or '}' in JSON at position 201\",\n \"expose\": true,\n \"status\": 400,\n \"body\": \"{\\n \\\"customsBrokerIdentifier\\\": \\\"4\\\",\\n \\\"clientIdentifier\\\": \\\"dedecorp\\\",\\n \\\"user_identifier\\\": \\\"ahmet.uzgor@atez.com\\\",\\n \\\"notification_emails\\\": [\\\"ahmet.uzgor@atez.com\\\"],\\n \\\"articles\\\": [{\\n {\\n \\\"articleIdentifier\\\": \\\"2024-test-documentation\\\",\\n \\\"articleDescription\\\": \\\"ASIN-0005 DESC\\\",\\n \\\"hsCode\\\": \\\"3926.90.97.90.18\\\",\\n \\\"gtipCodes\\\": [\\n {\\n \\\"geoAreaCode\\\": \\\"TR\\\",\\n \\\"code\\\": \\\"392690979018\\\"\\n }\\n ]\\n },\\n {\\n \\\"articleIdentifier\\\": \\\"2024-test-documentation-2\\\",\\n \\\"articleDescription\\\": \\\"ASIN-0006 DESC\\\",\\n \\\"hsCode\\\": \\\"3926.90.97.90.18\\\",\\n \\\"gtipCodes\\\": [\\n {\\n \\\"geoAreaCode\\\": \\\"TR\\\",\\n \\\"code\\\": \\\"010511110000\\\"\\n }\\n ]\\n },\\n }\\n {\\n \\\"articleIdentifier\\\": \\\"2024-test-documentation-3\\\"\\n },\\n {\\n \\\"articleIdentifier\\\": \\\"2024-test-documentation-4\\\"\\n }\\n\\n ],\\n \\\"services\\\": [\\n {\\n \\\"geoAreaCode\\\": \\\"TR\\\",\\n \\\"serviceCode\\\": \\\"HsCls\\\"\\n },\\n {\\n \\\"geoAreaCode\\\": \\\"TR\\\",\\n \\\"serviceCode\\\": \\\"CusCmp\\\"\\n },\\n {\\n \\\"geoAreaCode\\\": \\\"TR\\\",\\n \\\"serviceCode\\\": \\\"RglCmpIm\\\"\\n }\\n ]\\n}\",\n \"type\": \"entity.parse.failed\",\n \"stack\": \"SyntaxError: Expected property name or '}' in JSON at position 201\\n at JSON.parse (<anonymous>)\\n at parse (/home/node/app/node_modules/body-parser/lib/types/json.js:77:19)\\n at /home/node/app/node_modules/body-parser/lib/read.js:123:18\\n at AsyncResource.runInAsyncScope (node:async_hooks:206:9)\\n at invokeCallback (/home/node/app/node_modules/raw-body/index.js:238:16)\\n at done (/home/node/app/node_modules/raw-body/index.js:227:7)\\n at IncomingMessage.onEnd (/home/node/app/node_modules/raw-body/index.js:287:7)\\n at /home/node/app/node_modules/elastic-apm-node/lib/instrumentation/run-context/AbstractRunContextManager.js:96:49\\n at AsyncLocalStorage.run (node:async_hooks:335:14)\\n at AsyncLocalStorageRunContextManager.with (/home/node/app/node_modules/elastic-apm-node/lib/instrumentation/run-context/AsyncLocalStorageRunContextManager.js:57:36)\\n at IncomingMessage.wrapper (/home/node/app/node_modules/elastic-apm-node/lib/instrumentation/run-context/AbstractRunContextManager.js:96:23)\\n at IncomingMessage.emit (node:events:519:28)\\n at endReadableNT (node:internal/streams/readable:1696:12)\\n at process.processTicksAndRejections (node:internal/process/task_queues:82:21)\"\n }\n}\n\nThis endpoint allows you to make an HTTP GET request to retrieve detailed information about articles. The request should include query parameters in the raw request body type to filter the data based on specific criteria, such as the article identifier or client identifier.
\nExample Response
\n401 - Unauthorization
\nno Authorization header found\n\n422 - Unprocessable Entity Error
\n{\n \"error\": {\n \"statusCode\": 422,\n \"name\": \"UnprocessableEntityError\",\n \"message\": \"The request body is invalid. See error object `details` property for more info.\",\n \"code\": \"VALIDATION_FAILED\",\n \"details\": [\n {\n \"path\": \"\",\n \"code\": \"required\",\n \"message\": \"must have required property 'clientIdentifier'\",\n \"info\": {\n \"missingProperty\": \"clientIdentifier\"\n }\n }\n ],\n \"status\": 422,\n \"expose\": true,\n \"stack\": \"UnprocessableEntityError: The request body is invalid. See error object `details` property for more info.\\n at Object.invalidRequestBody (/home/node/app/node_modules/@loopback/rest/dist/rest-http-error.js:46:30)\\n at validateValueAgainstSchema (/home/node/app/node_modules/@loopback/rest/dist/validation/request-body.validator.js:133:34)\\n at process.processTicksAndRejections (node:internal/process/task_queues:95:5)\\n at async validateRequestBody (/home/node/app/node_modules/@loopback/rest/dist/validation/request-body.validator.js:50:5)\\n at async buildOperationArguments (/home/node/app/node_modules/@loopback/rest/dist/parser.js:57:5)\"\n }\n}\n\n400 - Bad Request
\n{\n \"error\": {\n \"statusCode\": 400,\n \"name\": \"SyntaxError\",\n \"message\": \"Expected ',' or '}' after property value in JSON at position 86\",\n \"expose\": true,\n \"status\": 400,\n \"body\": \"{\\n \\\"clientIdentifier\\\": \\\"9CE1B288-C453-440F-A377-556DEBF6FA86\\\",\\n \\\"pageNo\\\": 1\\n \\\"pageSize\\\": 1000\\n}\\n\",\n \"type\": \"entity.parse.failed\",\n \"stack\": \"SyntaxError: Expected ',' or '}' after property value in JSON at position 86\\n at JSON.parse (<anonymous>)\\n at parse (/home/node/app/node_modules/body-parser/lib/types/json.js:77:19)\\n at /home/node/app/node_modules/body-parser/lib/read.js:123:18\\n at AsyncResource.runInAsyncScope (node:async_hooks:206:9)\\n at invokeCallback (/home/node/app/node_modules/raw-body/index.js:238:16)\\n at done (/home/node/app/node_modules/raw-body/index.js:227:7)\\n at IncomingMessage.onEnd (/home/node/app/node_modules/raw-body/index.js:287:7)\\n at /home/node/app/node_modules/elastic-apm-node/lib/instrumentation/run-context/AbstractRunContextManager.js:96:49\\n at AsyncLocalStorage.run (node:async_hooks:335:14)\\n at AsyncLocalStorageRunContextManager.with (/home/node/app/node_modules/elastic-apm-node/lib/instrumentation/run-context/AsyncLocalStorageRunContextManager.js:57:36)\\n at IncomingMessage.wrapper (/home/node/app/node_modules/elastic-apm-node/lib/instrumentation/run-context/AbstractRunContextManager.js:96:23)\\n at IncomingMessage.emit (node:events:519:28)\\n at endReadableNT (node:internal/streams/readable:1696:12)\\n at process.processTicksAndRejections (node:internal/process/task_queues:82:21)\"\n }\n}\n\nThis endpoint allows you to retrieve detailed information about articles based on specific criteria. The request includes parameters such as clientIdentifier, despatch, and a list of articleIdentifiers to query article details. The response will provide the status of the articles, including the commodity code, customs status, special customs text, and any associated documents. Additionally, the endpoint returns the count of commodities ready for query and not yet ready for query.
\nExample Response
\n401 - Unauthorization
\nno Authorization header found\n\n422 - Unprocessable Entity Error
\n{\n \"error\": {\n \"statusCode\": 422,\n \"name\": \"UnprocessableEntityError\",\n \"message\": \"The request body is invalid. See error object `details` property for more info.\",\n \"code\": \"VALIDATION_FAILED\",\n \"details\": [\n {\n \"path\": \"\",\n \"code\": \"required\",\n \"message\": \"must have required property 'clientIdentifier'\",\n \"info\": {\n \"missingProperty\": \"clientIdentifier\"\n }\n },\n {\n \"path\": \"\",\n \"code\": \"required\",\n \"message\": \"must have required property 'despatch'\",\n \"info\": {\n \"missingProperty\": \"despatch\"\n }\n }\n ],\n \"status\": 422,\n \"expose\": true,\n \"stack\": \"UnprocessableEntityError: The request body is invalid. See error object `details` property for more info.\\n at Object.invalidRequestBody (/home/node/app/node_modules/@loopback/rest/dist/rest-http-error.js:46:30)\\n at validateValueAgainstSchema (/home/node/app/node_modules/@loopback/rest/dist/validation/request-body.validator.js:133:34)\\n at process.processTicksAndRejections (node:internal/process/task_queues:95:5)\\n at async validateRequestBody (/home/node/app/node_modules/@loopback/rest/dist/validation/request-body.validator.js:50:5)\\n at async buildOperationArguments (/home/node/app/node_modules/@loopback/rest/dist/parser.js:57:5)\"\n }\n} \"stack\": \"UnprocessableEntityError: The request body is invalid. See error object `details` property for more info.\\n at Object.invalidRequestBody (/home/node/app/node_modules/@loopback/rest/dist/rest-http-error.js:46:30)\\n at validateValueAgainstSchema (/home/node/app/node_modules/@loopback/rest/dist/validation/request-body.validator.js:133:34)\\n at process.processTicksAndRejections (node:internal/process/task_queues:95:5)\\n at async validateRequestBody (/home/node/app/node_modules/@loopback/rest/dist/validation/request-body.validator.js:50:5)\\n at async buildOperationArguments (/home/node/app/node_modules/@loopback/rest/dist/parser.js:57:5)\"\n }\n}\n\n400 - Bad Request
\n{\n \"error\": {\n \"statusCode\": 400,\n \"name\": \"SyntaxError\",\n \"message\": \"Expected property name or '}' in JSON at position 101\",\n \"expose\": true,\n \"status\": 400,\n \"body\": \"{\\n \\\"clientIdentifier\\\": \\\"amazon-landed-cost-api\\\",\\n \\\"despatch\\\": \\\"CN\\\",\\n \\\"articleIdentifiers\\\": [\\n {{\\\"article\\\": \\\"B07M8P93FD\\\", \\\"origin\\\": \\\"CN\\\"}}\\n ]\\n}\",\n \"type\": \"entity.parse.failed\",\n \"stack\": \"SyntaxError: Expected property name or '}' in JSON at position 101\\n at JSON.parse (<anonymous>)\\n at parse (/home/node/app/node_modules/body-parser/lib/types/json.js:77:19)\\n at /home/node/app/node_modules/body-parser/lib/read.js:123:18\\n at AsyncResource.runInAsyncScope (node:async_hooks:206:9)\\n at invokeCallback (/home/node/app/node_modules/raw-body/index.js:238:16)\\n at done (/home/node/app/node_modules/raw-body/index.js:227:7)\\n at IncomingMessage.onEnd (/home/node/app/node_modules/raw-body/index.js:287:7)\\n at /home/node/app/node_modules/elastic-apm-node/lib/instrumentation/run-context/AbstractRunContextManager.js:96:49\\n at AsyncLocalStorage.run (node:async_hooks:335:14)\\n at AsyncLocalStorageRunContextManager.with (/home/node/app/node_modules/elastic-apm-node/lib/instrumentation/run-context/AsyncLocalStorageRunContextManager.js:57:36)\\n at IncomingMessage.wrapper (/home/node/app/node_modules/elastic-apm-node/lib/instrumentation/run-context/AbstractRunContextManager.js:96:23)\\n at IncomingMessage.emit (node:events:519:28)\\n at endReadableNT (node:internal/streams/readable:1696:12)\\n at process.processTicksAndRejections (node:internal/process/task_queues:82:21)\"\n }\n}\n\nThis endpoint allows you to make an HTTP POST request to retrieve detailed delta data for articles. The request should include filtering criteria in the JSON request body—specifically the start date, end date, and client identifier. Based on these parameters, the backend maps the provided client identifier to its internal client ID, retrieves the associated commodity records, and aggregates service history information from multiple service history tables. The response returns a result flag, a message list with status details, and an article list that contains detailed service data for each article.
\nExample Response
\n401 - Unauthorization
\nno Authorization header found\n\n400 - Bad Request
\n{\n \"error\": {\n \"statusCode\": 400,\n \"name\": \"BadRequestError\",\n \"message\": \"Invalid data \\\"string\\\" for parameter \\\"startDate\\\".\",\n \"code\": \"INVALID_PARAMETER_VALUE\",\n \"parameterName\": \"startDate\",\n \"status\": 400,\n \"expose\": true,\n \"stack\": \"BadRequestError: Invalid data \\\"string\\\" for parameter \\\"startDate\\\".\\n at Object.invalidData (/home/node/app/node_modules/@loopback/rest/dist/rest-http-error.js:14:30)\\n at coerceDatetime (/home/node/app/node_modules/@loopback/rest/dist/coercion/coerce-parameter.js:102:38)\\n at coerceParameter (/home/node/app/node_modules/@loopback/rest/dist/coercion/coerce-parameter.js:45:22)\\n at buildOperationArguments (/home/node/app/node_modules/@loopback/rest/dist/parser.js:53:75)\\n at parseOperationArgs (/home/node/app/node_modules/@loopback/rest/dist/parser.js:29:12)\\n at process.processTicksAndRejections (node:internal/process/task_queues:95:5)\\n at async /home/node/app/node_modules/@loopback/rest/dist/providers/parse-params.provider.js:52:28\\n at async _0x33342f.interceptor (/home/node/app/node_modules/@loopback/express/dist/middleware-interceptor.js:82:25)\\n at async _0x267539.interceptor (/home/node/app/node_modules/@loopback/express/dist/middleware-interceptor.js:82:25)\\n at async /home/node/app/node_modules/@loopback/express/dist/middleware-interceptor.js:82:25\\n at async /home/node/app/node_modules/@loopback/express/dist/middleware-interceptor.js:82:25\\n at async /home/node/app/node_modules/@loopback/express/dist/middleware-interceptor.js:82:25\\n at async /home/node/app/node_modules/@loopback/rest/dist/providers/send.provider.js:39:32\\n at async MySequence.handle (/home/node/app/node_modules/@loopback/rest/dist/sequence.js:201:9)\\n at async MySequence.handle (/home/node/app/dist/sequence.js:1:3549)\\n at async HttpHandler._handleRequest (/home/node/app/node_modules/@loopback/rest/dist/http-handler.js:64:9)\"\n }\n}\n\nThis endpoint allows you to make an HTTP PATCH request to update a commodity model instance used for classification. The request must include the commodity ID in the URL path and the updated model details in the JSON request body. Upon successful update, the endpoint returns an object containing both the updated product catalog data and the commodity details.
\nRequest Payload application/json
\n- \n
changeReason
\nOPTIONALstring
String explaining the reason for the change made to the product information. Sample:\"changeReason\": \"Updated for documentation\"\nmodelNo
\nOPTIONALstring
String representing the model number of the product. Sample:\"modelNo\": \"New Model Number\"\nchangeNotes
\nOPTIONALstring
String providing additional notes regarding the change. Sample:\"changeNotes\": \"Notes about the change\"\nhsCode
\nOPTIONALstring
String representing the Harmonized System (HS) code for the product. Sample:\"hsCode\": \"HS123456\"\ngtipCodeTR
\nOPTIONALstring
String representing the Turkish GTIP (Goods Tariff Classification) code for the product. Sample:\"gtipCodeTR\": \"870431100000\"\ngtipCodeCH
\nOPTIONALstring
String representing the Swiss GTIP code for the product. Sample:\"gtipCodeCH\": \"87043130\"\ngtipCodeUK
\nOPTIONALstring
String representing the UK GTIP code for the product. Sample:\"gtipCodeUK\": \"87043140\"\ngtipCodeEU
\nOPTIONALstring
String representing the EU GTIP code for the product. Sample:\"gtipCodeEU\": \"87043150\"\ngtipCodeDE
\nOPTIONALstring
String representing the German GTIP code for the product. Sample:\"gtipCodeDE\": \"87043160\"\ntaricImportCode
\nOPTIONALstring
String representing the TARIC import code for the product. Sample:\"taricImportCode\": \"TARIC12345\"\ntaricImportCodeEU
\nOPTIONALstring
String representing the TARIC import code for the product in the EU region. Sample:\"taricImportCodeEU\": \"TARICEU123\"\ntaricImportCodeUK
\nOPTIONALstring
String representing the TARIC import code for the product in the UK. Sample:\"taricImportCodeUK\": \"TARICUK123\"\nnationalCommodityCode
\nOPTIONALstring
String representing the national commodity code for the product. Sample:\"nationalCommodityCode\": \"NCC12345\"\nimStatCodeCH
\nOPTIONALobject
Object representing the Swiss import statistical code. Sample:\"imStatCodeCH\": {\"id\": 2, \"statCode\": \"099\"}\nexStatCodeCH
\nOPTIONALobject
Object representing the Swiss export statistical code. Sample:\"exStatCodeCH\": {\"id\": 2, \"statCode\": \"011\"}\ncommercialDescription
\nOPTIONALstring
String providing the commercial description of the product. Sample:\"commercialDescription\": \"Updated description\"\ncommercialDescriptionTR
\nOPTIONALstring
String providing the commercial description of the product in Turkish. Sample:\"commercialDescriptionTR\": \"Açıklama TR\"\ncommercialDescriptionEN
\nOPTIONALstring
String providing the commercial description of the product in English. Sample:\"commercialDescriptionEN\": \"Updated description in English\"\ncommercialDescriptionDE
\nOPTIONALstring
String providing the commercial description of the product in German. Sample:\"commercialDescriptionDE\": \"Aktualisierte Beschreibung auf Deutsch\"\nproductDescription
\nOPTIONALstring
String providing the product description. Sample:\"productDescription\": \"Updated product description\"\nproductDescriptionTR
\nOPTIONALstring
String providing the product description in Turkish. Sample:\"productDescriptionTR\": \"Ürün açıklaması TR\"\nproductDescriptionEN
\nOPTIONALstring
String providing the product description in English. Sample:\"productDescriptionEN\": \"Updated product description EN\"\nproductDescriptionDE
\nOPTIONALstring
String providing the product description in German. Sample:\"productDescriptionDE\": \"Aktualisierte Produktbeschreibung DE\"\nproductWh
\nOPTIONALstring
String representing the warehouse location of the product. Sample:\"productWh\": \"Warehouse Location\"\nrawMaterial
\nOPTIONALstring
String representing the raw material used in the product. Sample:\"rawMaterial\": \"Raw material used\"\ncomment
\nOPTIONALstring
String for additional comments regarding the product. Sample:\"comment\": \"General comment\"\nnetWeight
\nOPTIONALstring
String representing the net weight of the product. Sample:\"netWeight\": \"100.50\"\ngrossWeight
\nOPTIONALstring
String representing the gross weight of the product. Sample:\"grossWeight\": \"110.50\"\ntechnicalRemarks
\nOPTIONALstring
String providing technical remarks for the product. Sample:\"technicalRemarks\": \"Updated technical remarks\"\nlineSuppliers
\nOPTIONALobject array
Array of suppliers related to the product. Each object in the array contains supplier information. \nlineSuppliers/id
\nOPTIONALnumber
Unique identifier of the supplier. Sample:\"id\": 1\nlineSuppliers/supplierName
\nOPTIONALstring
Name of the supplier. Sample:\"supplierName\": \"Supplier A\"\nlineManufacturers
\nOPTIONALobject array
Array of manufacturers related to the product. Each object in the array contains manufacturer information. \nlineManufacturers/id
\nOPTIONALnumber
Unique identifier of the manufacturer. Sample:\"id\": 1\nlineManufacturers/manufacturerName
\nOPTIONALstring
Name of the manufacturer. Sample:\"manufacturerName\": \"Manufacturer A\"\nisSapIntegrated
\nOPTIONALboolean
Boolean indicating whether the product is integrated with SAP. Sample:\"isSapIntegrated\": true\n
Example Response
\n401 - Unauthorization
\nno Authorization header found\n\n400 - Bad Request
\n{\n \"error\": {\n \"statusCode\": 400,\n \"name\": \"BadRequestError\",\n \"message\": \"Invalid data \\\"string\\\" for parameter \\\"id\\\".\",\n \"code\": \"INVALID_PARAMETER_VALUE\",\n \"parameterName\": \"id\",\n \"status\": 400,\n \"expose\": true,\n \"stack\": \"BadRequestError: Invalid data \\\"string\\\" for parameter \\\"id\\\".\\n at Object.invalidData (/home/node/app/node_modules/@loopback/rest/dist/rest-http-error.js:14:30)\\n at coerceNumber (/home/node/app/node_modules/@loopback/rest/dist/coercion/coerce-parameter.js:118:34)\\n at coerceParameter (/home/node/app/node_modules/@loopback/rest/dist/coercion/coerce-parameter.js:53:22)\\n at buildOperationArguments (/home/node/app/node_modules/@loopback/rest/dist/parser.js:53:75)\\n at parseOperationArgs (/home/node/app/node_modules/@loopback/rest/dist/parser.js:29:12)\\n at process.processTicksAndRejections (node:internal/process/task_queues:95:5)\\n at async /home/node/app/node_modules/@loopback/rest/dist/providers/parse-params.provider.js:52:28\\n at async _0x33342f.interceptor (/home/node/app/node_modules/@loopback/express/dist/middleware-interceptor.js:82:25)\\n at async _0x267539.interceptor (/home/node/app/node_modules/@loopback/express/dist/middleware-interceptor.js:82:25)\\n at async /home/node/app/node_modules/@loopback/express/dist/middleware-interceptor.js:82:25\\n at async /home/node/app/node_modules/@loopback/express/dist/middleware-interceptor.js:82:25\\n at async /home/node/app/node_modules/@loopback/express/dist/middleware-interceptor.js:82:25\\n at async /home/node/app/node_modules/@loopback/rest/dist/providers/send.provider.js:39:32\\n at async MySequence.handle (/home/node/app/node_modules/@loopback/rest/dist/sequence.js:201:9)\\n at async MySequence.handle (/home/node/app/dist/sequence.js:1:3549)\\n at async HttpHandler._handleRequest (/home/node/app/node_modules/@loopback/rest/dist/http-handler.js:64:9)\"\n }\n}\n\nLogicust is a platform designed to optimize customs brokerage processes end-to-end and provide robust integration capabilities for business partners. The platform allows companies to efficiently manage item information within the system, assign these items to customs brokers, and enable brokers to quickly perform HS Code classification, tax calculations, and permit-related processes. These features not only enhance operational efficiency for companies but also ensure more streamlined and traceable workflows for brokers.
\nThird-Party Integration
\nLogicust’s integrated structure enables seamless communication with third-party applications (3rd Party). These integrations operate as follows:
\nAccess and Management of Item Information
\n- \n
Existing Items:
\n
For items already registered on the Logicust platform, third-party systems can use the/article-info(GET) endpoint with a specifiedclientIdentifierto access critical data such as GTIP classifications, tax details, and other essential information for all relevant items of a company. \nCreating New Items:
\n
If an item is not already registered on the Logicust system, its details can be submitted via the/classification-orders(POST) endpoint. This process enables Logicust to create the item within the platform and initiates the classification process by brokers. \nItem Details Retrieval:
\n
The/article-info/details(GET) endpoint provides detailed information regarding items, enabling queries related to shipping, taxes, costs, and more. This endpoint returns crucial data, including the designated GTIP code, available documents for selection, tax and permit Q&A, as well as applicable tax rates for the item in question. \n
Real-Time Updates and Notifications
\nLogicust shares all classification or data updates performed by brokers in real-time. This is achieved through the RabbitMQ messaging system, which broadcasts messages containing details about updated items and their modified fields.
\nThird-party systems listening to these messages can retrieve the latest details for specific items by calling the /article-info endpoint with the corresponding clientIdentifier and articleIdentifiers (provided as a string[] list). In this way, third-party systems benefit from Logicust’s data integrity and real-time updates.
Advantages of Integration
\nLogicust establishes a robust data flow between companies and third-party systems. The platform allows users to:
\n- \n
Easily manage existing items.
\n \nIntegrate missing items into the system.
\n \nInstantly share updates made by brokers.
\n \n
By ensuring transparency and data integrity, Logicust enables third-party applications to significantly increase efficiency, reduce time loss, and maintain seamless operations.
\n\n
Through this comprehensive structure, Logicust emerges as a powerful solution that modernizes and simplifies customs brokerage processes, making them more efficient and transparent.
\nThe Logicust integration process from start to finish is illustrated in the diagrams below:
\nSteps to Follow for Integrating with the Logicust System
\n1- In order to query item information in the Logicust system, the third-party system sends a GET request to the /article-info endpoint using the clientIdentifier.
2- If the queried item exists in the system, detailed GTIP classification, tax information, and related data are retrieved. If the item does not exist, Logicust prompts the third-party system to provide the required item information for classification.
\n3- For items not found in the system, a POST request is sent to the /classification-orders endpoint, including all necessary item details. Logicust processes this request and creates the item in the system, assigning it to a customs broker for classification.
4- The customs broker evaluates the item’s GTIP classification, tax rates, and required permits, ensuring compliance with customs regulations.
\n5- When updates are made by the customs broker, Logicust generates a real-time notification through RabbitMQ. This notification contains details about the updated item and the modified fields.
\n6- Third-party systems listening to RabbitMQ notifications can retrieve updated item information by sending a GET request to the /article-info endpoint with the clientIdentifier and a list of updated articleIdentifiers (in string array format).
7- This process ensures third-party systems always have access to the most accurate and up-to-date item information, facilitating seamless integration with Logicust.
\nThird-Party Integration for ERP Systems (SAP, IFS)
\nLogicust is a platform that streamlines customs brokerage operations and offers robust integration capabilities for third-party applications, such as ERP systems (e.g., SAP, IFS). This integration allows businesses to synchronize item data and updates between their ERP systems and Logicust, ensuring both systems stay aligned with minimal manual intervention.
\n\n
Integration Overview for ERP Systems:
\nLogicust provides two key endpoints for real-time synchronization of item data between ERP systems like SAP and IFS:
\n- \n
\n/article-info/delta-list (GET):
This endpoint allows ERP systems to fetch detailed delta data for articles that have been updated within a specified date range. By including client identifier and date range parameters in the query, ERP systems can retrieve updated service history, including changes to GTIP classifications, tax details, and other critical data. \n
\n/commodities/{id}/update (PATCH):
ERP systems can update commodity model instances used for classification via this endpoint. By sending a PATCH request with the commodity ID and updated details, both the ERP system and Logicust will synchronize catalog data, ensuring consistency. \n
\n
Advantages of Integration with ERP Systems:
\n- \n
Automatic Data Synchronization: Item data is automatically synced between Logicust and ERP systems, reducing manual work and errors.
\n \nReal-Time Updates: ERP systems receive immediate updates on changes in item classifications, taxes, and other relevant details.
\n \nSeamless Workflow: Both systems work together smoothly, enhancing the efficiency of customs processes, classification, and compliance.
\n \n
\n
By integrating with Logicust, ERP systems like SAP and IFS can optimize workflows, minimize data inconsistencies, and improve operational efficiency in real-time.
\nSteps to Follow for Synchronizing Data with Logicust System
\n- \n
ERP System Initiates the Process:
\n
The ERP system starts by initiating a data synchronization check with Logicust. It sends a request to Logicust to confirm if an update is required for the commodity data. \nData Sync Check:
\n
Logicust evaluates if there are any updates required for the commodity data.- \n
If updates are required: The system proceeds to check for updates.
\n \nIf no updates are required: The process ends, and no further action is taken.
\n \n
\nCheck for Updates:
\n
If updates are needed, the ERP system sends a request to the/article-info/delta-listendpoint with theclientIdanddateRangeas query parameters. This request retrieves a list of all the items that have been updated within the specified date range, including any changes to GTIP classifications, tax details, and other relevant data. \nCommodity Update Flow:
\n
Once the updates are identified, the system sends aPATCHrequest to the/commodities/{id}/updateendpoint, passing the commodity ID and updated details. This ensures that the ERP system and Logicust stay in sync with the latest data, updating the catalog with the new values. \nData Synchronization:
\n
After receiving the update information, Logicust synchronizes the updated commodity details with the ERP system, ensuring consistency across both systems. \nReal-Time Updates:
\n
Logicust ensures that real-time updates are applied to the commodity data. Once the updates are successfully processed, the system moves to the sync confirmation stage. \nSync Confirmation:
\n
The ERP system receives a sync confirmation indicating that the updates have been successfully applied, ensuring both systems are aligned. \nGet Current State:
\n
To verify the update, the ERP system sends aGETrequest to the/article-infoendpoint, including thecommodityIdparameter. This fetches the current state of the commodity data, ensuring that all updates are reflected correctly. \nSynchronized Catalog Data:
\n
The system returns the synchronized catalog data, confirming that the commodity data is now consistent across both the ERP system and Logicust. \n
This endpoint allows you to view the branch list.
\nResponse Body application/json
\nResponse upon successful request, the response will include:
\n- \n
- country_code string
Country code (ISO 3166-1 alpha-2). Sample: country_code: \"TR\" \n
\n
- \n
- title string
Name of the branch or company location. Sample: title: \"ABC Turkey\" \n
\n
- \n
- branch_code string
Unique branch code identifier. Sample: branch_code: \"XCYP3R\" \n
Example Response
\n401 - Unauthorization
\n{\n \"error\": {\n \"statusCode\": 401,\n \"name\": \"UnauthorizedError\",\n \"message\": \"Invalid or expired token\"\n }\n}\n\nRequest Payload application/json
\nThis endpoint allows the import of declarations. The request should include a payload in the raw request body type, containing informations such as:
\n- \n
- declaration_no
REQUIREDstring
Unique declaration number. Sample: declaration_no: \"TRTEST0003\" \n
\n
- \n
- declaration_date
REQUIREDstring
Declaration date inYYYY-MM-DDformat. Sample: declaration_date: \"2024-12-10\" \n
\n
- \n
- branch_code
REQUIREDstring
Code of the branch handling the declaration. Sample: branch_code: \"BRQJK2V\" \n
\n
- \n
- declarationItems/commodity_code
REQUIREDstring
Commodity classification code. Sample: commodity_code: \"12345678\" \n
\n
- \n
- declarationItems/invoice_number
REQUIREDarray
Invoice numbers associated with the declaration. Sample: invoice_number: [\"INV001\", \"INV002\"] \n
\n
- \n
- declarationItems/invoice_date
REQUIREDstring
Invoice date inYYYY-MM-DDformat. Sample: invoice_date: \"2024-12-05\" \n
\n
- \n
- declarationItems/hs_code
REQUIREDstring
Harmonized System (HS) code. Sample: hs_code: \"HS1234\" \n
\n
- \n
- declarationItems/cn_code
REQUIREDstring
Combined Nomenclature (CN) code. Sample: cn_code: \"CN5678\" \n
\n
- \n
- declarationItems/origin_country_code
REQUIREDstring
ISO country code of origin. Sample: origin_country_code: \"US\" \n
\n
- \n
- declarationItems/manifacturer
OPTIONALstring
Manufacturer name. Sample: manifacturer: \"ACME Corp\" \n
\n
- \n
- declarationItems/description
OPTIONALstring
Description of the item. Sample: description: \"High-quality widgets\" \n
\n
- \n
- declarationItems/requested_procedure
REQUIREDstring
Requested procedure for the item. Sample: requested_procedure: \"Import\" \n
\n
- \n
- declarationItems/previous_procedure
REQUIREDstring
Previous procedure before declaration. Sample: previous_procedure: \"Export\" \n
\n
- \n
- declarationItems/net_mass
REQUIREDstring
Net mass of the item. Sample: net_mass: \"150.5\" \n
\n
- \n
- declarationItems/supplementary_units
OPTIONALstring
Additional measurement units. Sample: supplementary_units: \"10\" \n
\n
- \n
- declarationItems/type_of_measurement_units
OPTIONALstring
Type of measurement units. Accepted values:kg,tonnes. Sample: type_of_measurement_units: \"kg\" \n
\n
- \n
- declarationItems/exporter/email
OPTIONALstring
Exporter email. Sample: email: \"exporter@example.com\" \n
\n
- \n
- declarationItems/exporter/phone
OPTIONALstring
Exporter phone number. Sample: phone: \"+123456789\" \n
\n
- \n
- declarationItems/exporter/company_title
REQUIREDstring
Exporter company name. Sample: company_title: \"Exporter Inc.\" \n
\n
- \n
- declarationItems/exporter/identification_number
REQUIREDstring
Exporter EORI number. Sample: identification_number: \"EXP123249\" \n
\n
- \n
- declarationItems/exporter/address/country_code
REQUIREDstring
Country code (ISO 3166-1 alpha-2). Sample: country_code: \"US\" \n
\n
- \n
- declarationItems/exporter/address/city
REQUIREDstring
City name. Sample: city: \"New York\" \n
\n
- \n
- declarationItems/exporter/address/subdivision
OPTIONALstring
State or subdivision. Sample: subdivision: \"NY\" \n
\n
- \n
- declarationItems/exporter/address/street
OPTIONALstring
Street name. Sample: street: \"Main Street\" \n
\n
- \n
- declarationItems/exporter/address/street_additional_line
OPTIONALstring
Additional address information. Sample: street_additional_line: \"Suite 100\" \n
\n
- \n
- declarationItems/exporter/address/address_number
OPTIONALstring
Address number. Sample: address_number: \"101\" \n
\n
- \n
- declarationItems/exporter/address/coordinate_type
OPTIONALstring
Type of coordinate reference. Sample: coordinate_type: \"GPS\" \n
\n
Response Body application/json
\nResponse upon successful import of declarations, the response will include:
\n- \n
- failed/declaration/declaration_no string
Unique declaration number for a failed declaration. Sample: declaration_no: \"DEC-2024001\" \n
\n
- \n
- failed/declaration/error/message string
Error message explaining the failure reason. Sample: message: \"branch is not found\" \n
\n
- \n
- created/declaration/declaration_no string
Unique declaration number for a successfully created declaration. Sample: declaration_no: \"DEC-2024003\" \n
\n
- \n
- created/declaration/importer/company_title string
Name of the importing company. Sample: company_title: \"XYZ Imports Ltd.\" \n
\n
- \n
- created/declaration/importer/identification_number string
Unique identification number for the importer. Sample: identification_number: \"123456789\" \n
\n
- \n
- created/declaration/importer/reporting_declarant_identification_number string
Reporting declarant identification number of the importer. Sample: reporting_declarant_identification_number: \"987654321\" \n
\n
- \n
- created/declaration/items/id string
Unique ID of the declared item. Sample: id: \"ITEM001\" \n
\n
- \n
- created/declaration/items/commodity_code string
Commodity classification code of the item. Sample: commodity_code: \"100110\" \n
\n
- \n
- upserted/declaration_no string
Unique declaration number for an upserted declaration. Sample: declaration_no: \"DEC-2024004\" \n
Example Response
\n422 - Unprocessable Content
\n{\n \"error\": {\n \"statusCode\": 422,\n \"message\": \"The request body is invalid. See error object `details` property for more info.\",\n \"code\": \"VALIDATION_FAILED\",\n \"details\": [\n {\n \"path\": \"/0\",\n \"code\": \"required\",\n \"message\": \"must have required property 'declaration_no'\",\n \"info\": {\n \"missingProperty\": \"declaration_no\"\n }\n }\n ],\n }\n}\n\n401 - Unauthorization
\n{\n \"error\": {\n \"statusCode\": 401,\n \"name\": \"UnauthorizedError\",\n \"message\": \"Invalid or expired token\"\n }\n}\n\nGreenpulse is a comprehensive software solution designed to help businesses with Green Deal reporting requirements, starting with CBAM. Greenpulse API provides an integration mechanism for software developers to integrate their existing customs software with it.
\nFiltering goods information
\nWe do not expect developers to know which declared item is subjected to which Green Deal reporting scheme. As you start feeding your declaration data into Greenpulse API, it filters and routes relevant declared items based on their reporting requirements.
\nDeclarations
\nDeclarations are always upserted. If a declaration has previously been received, only the new version is used for reporting. Please bear in mind, that Greenpulse Declaration API does not append declared items and only the final version is considered.
We expect to receive only the changed declarations. Upserting a declaration void previous emission matchings.
Branches
\nGreenpulse supports customs operations on multiple countries per organization. Some of the organizations use single customs process management software for multiple jurisdictions. That’s why we require a Branch Code per declaration data for routing.
You can obtain your Branch Code from your Greenpulse administrator.
Authentication
\nGreenpulse uses Access Tokens for API authentication. You can create and manage your tokens on Greenpulse Data Sources menu.
A OAuth2-compliant Token Endpoint that supports the urn:ietf:params:oauth:grant-type:uma-ticket grant type. Through this endpoint clients can send authorization requests and obtain an RPT with all permissions granted by Keycloak.
\nRequest Payload application/json
\n- \n
- grant_type
REQUIREDstring
Authentication and authorization method used by a client to obtain an access token from Keycloak, based on the OAuth 2.0 and OpenID Connect protocols. Default value is password. \n
\n
- \n
- username
REQUIREDstring
Username is used to log in to keycloak services, it is a string value chosen by the user. \n
\n
- \n
- password
REQUIREDstring
Password is used to log in to keycloak services, it is a string value chosen by the user. It is private and confidential. \n
\n
- \n
- client_id
REQUIREDstring
It refers the id of client at keycloak services which is user saved. \n
\n","urlObject":{"protocol":"https","path":["auth","realms","test-tariff","protocol","openid-connect","token"],"host":["test-kc","singlewindow","io"],"query":[],"variable":[]}},"response":[{"id":"9c672ebb-4c4f-420a-9fbc-c9013b18895f","name":"Keycloak Token TEST TARIFF","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"client_credentials","type":"text"},{"key":"username","value":"test@gmail.com","type":"text"},{"key":"password","value":"password","type":"text"},{"key":"client_id","value":"your-tariff-admin-user","type":"text"}]},"url":"https://test-kc.singlewindow.io/auth/realms/test-tariff/protocol/openid-connect/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"access_toke\",\n \"expires_in\": 43200,\n \"refresh_expires_in\": 43200,\n \"refresh_token\": \"refresh_toke\",\n \"token_type\": \"Bearer\",\n \"not-before-policy\": 0,\n \"session_state\": \"0552ed38-92d8-4571-ad25-6e5983bb5725\",\n \"scope\": \"profile email\"\n}"}],"_postman_id":"c30dc570-4ef3-4a63-9ee9-5d3aa36437e4"}],"id":"c699eba8-89c0-4ec8-b2df-061691f398f2","_postman_id":"c699eba8-89c0-4ec8-b2df-061691f398f2","description":""},{"name":"Commodity Info","id":"0bc9a968-0fff-4f26-bd90-fa1cdf5583cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://test-tariff.singlewindow.io/api/v2-0/tariff-query/commodity/info/TR/392690979018","description":"
REQUEST DESCRIPTION
\nThis endpoint provides detailed information about a specific commodity, including its classification, description, HS code, and applicable tariff and regulatory data.
\nResponse Body application/json
\n- \n
- commodities string/object/array object/integer
Contains all commodity information received as a result of the query. \n
\n
- \n
- commodities/code string
A unique identifier or code for the commodity. It can be 10, 8 or 11 digits due to its datasource country. \n
\n
- \n
- commodities/description string
A textual brief explanation of commodity. \n
\n
- \n
- commodities/start_date string
The date when the commodity classification becomes effective. \n
\n
- \n
- commodities/updated_at string/object/array object/integer
The timestamp of the last update for the commodity. \n
\n
- \n
- commodities/parent_id string/object/array object/integer
The identifier of the parent commodity if it belongs to a hierarchical structure. \n
\n
- \n
- commodities/translations string/object/array object/integer
An array of translated descriptions for different languages. \n
\n
- \n
- commodities/translations/language_code string/object/array object/integer
The language code for the translation. \n
\n
- \n
- commodities/translations/description string/object/array object/integer
The translated description of the commodity in the specified language. \n
Example Response
\n401 - Unauthorization
\nno Authorization header found\n\nREQUEST DESCRIPTION
\nThis endpoint returns the detailed information and statistical codes (stat codes) associated with a specific commodity, based on its tariff classification.
\nRequest Body Parameters application/cURL
\n- \n
- datasource-code
REQUIREDstring
Refers to a code that identifies the source of the data, it usually same as country code of the country where data came from. \n
\n
- \n
- commodity-code
REQUIREDstring
A unique identifier or code for the commodity. It can be 10, 8 or 11 digits due to its datasource country. \n
\n
- \n
- imex_indicator
REQUIREDstring
It can be B, E or I and it refers to export and import. B refers to both. \n
Response Body application/json
\n- \n
- id integer
Unique identifier of data within our systems database. \n
\n
- \n
- commodity_code string
A unique identifier or code for the commodity. It can be 10, 8 or 11 digits due to its datasource country. \n
\n
- \n
- stat_type string
Statistical type classification for the commodity. \n
\n
- \n
- stat_code string
Additional statistical code for classifying data. \n
\n
- \n
- number_of_indents string/object/array object/integer
Indenets are refers to the hierarchical level of a commodity within a classification system. It indicates how deep the commodity is nested within a structured tariff or statistical classification. \n
\n
- \n
- imex_indicator string
It can be B, E or I and it refers to export and import. B refers to both. \n
\n
- \n
- translations array
An array of translated descriptions for different languages. \n
\n
- \n
- translations/id integer
Unique identifier of each translation. \n
\n
- \n
- translations/tariff_stat_code_id string
Unique identifier of each stat_code in system database. \n
\n
- \n
- translations/description string
The translated description of the stat code in the specified language. \n
\n
- \n
- translations/language_code string
The language code for the translation. \n
\n
- \n
- translations/description_start_date string
The date when the description becomes effective. \n
\n
- \n
- translations/description_end_date string
The date when the description becomes inactive.Example Response \n
REQUEST DESCRIPTION
\nThis endpoint provides information about sanction measures that apply to specific commodities, countries, or entities.
\nRequest Body Parameters application/json
\n- \n
- measureType
REQUIREDstring
Contains information about the measure type. \n
Response Body application/json
\n- \n
- id integer
Unique identifier of the object. \n
\n
- \n
- datasource_code string
Indicates the data source. \n
\n
- \n
- owner_assigned_id string
Identifier assigned by the owner in the system. \n
\n
- \n
- is_import string
Indicates whether this is an import transaction. \n
\n
- \n
- is_export string
Indicates whether this is an export transaction. \n
\n
- \n
- revision_date string
The last update date of the data. \n
\n
- \n
- reduction_indicator string
A flag indicating a tax or tariff reduction. \n
\n
- \n
- is_excise string
Indicates whether it is subject to excise tax. \n
\n
- \n
- is_vat string
Indicates whether it is subject to value-added tax (VAT). \n
\n
- \n
- formatted_description string
A formatted description of the data. \n
\n
- \n
- base_duty string
The base tax/tariff amount. \n
\n
- \n
- base_duty_formatted string
The formatted base tax/tariff amount. \n
\n
- \n
- origin string
The origin country of the data or product. \n
\n
- \n
- was_deleted boolean
Indicates whether the data was deleted. \n
\n
- \n
- deleted_at string
The date when the data was deleted. (If deleted) \n
\n
- \n
- effective_start_date string
The start date of the data or regulation. \n
\n
- \n
- effective_end_date string
The end date of the data or regulation. \n
\n
- \n
- geographical_area_id integer
The identifier of the related geographical area in system database. \n
\n
- \n
- order_number string
The order or transaction number. \n
\n
- \n
- source_checksum string
A code used to verify if the data has changed. \n
\n
- \n
- created_at string
The creation date of the object. \n
\n
- \n
- updated_at string
The last update date of the object. \n
\n
- \n
- origin_relation string
The relation of the data or product to its origin. \n
\n
- \n
- measure_type_id string
The identifier of the measure type in system database. \n
\n
- \n
- footnoteViews array
A collection of entities which contains footnote details. \n
\n
- \n
- footnoteViews/id integer
Unique identifier of the footnote. \n
\n
- \n
- footnoteViews/measure_id string
Identifier of the related measure. \n
\n
- \n
- footnoteViews/footnote_id string
Identifier of the footnote. \n
\n
- \n
- footnoteViews/datasource_code string
Indicates the footnote data source country. \n
\n
- \n
- footnoteViews/owner_assigned_id string
Combined Identifier for footnote. \n
\n
- \n
- footnoteViews/code string
Value of footnote code. \n
\n
- \n
- footnoteViews/footnote_type_id string
Unique identifier of footnote type. \n
\n
- \n
- footnoteViews/description string
Text description of footnote. \n
\n
- \n
- footnoteViews/formatted_description string
Formatted text description of the footnote data. \n
\n
- \n
- footnoteViews/language_code string
The language code for the footnote translations. \n
\n
- \n
- footnoteViews/start_date string
The date when the footnote itself becomes effective. \n
\n
- \n
- footnoteViews/end_date string
The date when the footnote itself becomes inactive. \n
\n
- \n
- footnoteViews/updated_at string
The last update date of the data. \n
\n
- \n
- footnoteViews/description_start_date string
The date when the footnote description becomes effective. \n
\n
- \n
- footnoteViews/description_end_date string
The date when the footnote description becomes inactive. \n
\n
- \n
- measureType string
Contains information about the measure type. \n
\n
- \n
- measureType/id integer
Unique identifier of the measure type. \n
\n
- \n
- measureType/measure_type_code string
Code indicating measure type. \n
\n
- \n
- measureType/measure_type_description string
Text description of the measure type. \n
\n
- \n
- measureType/measure_type_short_descr string
Summary of text description of the measure type. \n
\n
- \n
- measureType/measure_type_serie_id string
Unique letter like id of measure types. \n
\n
- \n
- measureType/is_import string
Indicates if it applies to imports. \n
\n
- \n
- measureType/is_export string
Indicates if it applies to exports. \n
\n
- \n
- measureType/is_national string
Indicates if it applies to national or global. \n
\n
- \n
- measureType/category string
Represents the category in which the measure type exists. Example values ('control','tax'...) \n
\n
- \n
- measureType/display_type string
Represents how measure should be seen in the queries. \n
\n
- \n
- measureType/compliance_category string
Specifies the category of compliance related to the measure, indicating how it aligns with regulations, trade policies, or legal requirements. \n
\n
- \n
- measureType/origin_relation string
Refers to the relationship between a trade measure and the origin of goods. \n
\n
- \n
- measureType/display_order string
Numeric value that represents the display order. \n
\n
- \n
- measureType/created_at string
The timestamp indicating when the measure type created in the system. \n
\n
- \n
- measureType/updated_at string
The last update date of the data. \n
\n
- \n
- areaDetails array
Collection of geographical area details data. \n
\n
- \n
- areaDetails/id integer
Unique identifier of area detail data. \n
\n
- \n
- areaDetails/datasource_code string
Indicates the data source. \n
\n
- \n
- areaDetails/geographical_area_code string
Code of the geographical area. \n
\n
- \n
- areaDetails/geographical_area_abbrev string
The abbreviated or short code representing a geographical area. \n
\n
- \n
- areaDetails/geographical_area_descr string
Description of the geographical area. \n
\n
- \n
- areaDetails/geographical_area_type string
Indicates the classification or category of a geographical area. It can be G for geographical region, C for country. \n
\n
- \n
- areaDetails/start_date string
The date when the geographical area becomes effective. \n
\n
- \n
- areaDetails/end_date string
The date when the geographical area becomes inactive. \n
\n
- \n
- areaDetails/updated_at string
The last update date of the data. \n
\n
- \n
- legalActViews array
Contains details of legal regulations. \n
\n
- \n
- legalActViews/id integer
Unique identifier of the record of measure - legal act relation. \n
\n
- \n
- legalActViews/measure_id string
Unique id of measure which is for indicating legal act and measure relation. \n
\n
- \n
- legalActViews/legal_act_id integer
Unique identifier of the legal_act. \n
\n
- \n
- legalActViews/validity_start_date string
The timestamp indicating when the record or object was first created in the system. \n
\n
- \n
- legalActViews/validity_end_date string
The date when a measure, regulation, or rule stops being valid or applicable. \n
\n
- \n
- legalActViews/datasource_code string
Indicates the data source. \n
\n
- \n
- legalActViews/regulation_code string
A unique identifier or reference code assigned to a specific legal regulation. \n
\n
- \n
- legalActViews/officialjournal_number string
The reference number of the official journal or publication where a regulation, legal act, or measure was published. \n
\n
- \n
- legalActViews/officialjournal_page string
The specific page number in the official journal where the regulation, legal act, or measure is published. \n
\n
- \n
- legalActViews/published_date string
The date when a regulation, legal act, or measure was officially published or made public. \n
\n
- \n
- legalActViews/regulation_url string
The web address (URL) where the full text of a regulation, legal act, or measure can be accessed online. \n
\n
- \n
- legalActViews/language_code string
The language code for the translation of legal act. \n
\n
- \n
- additionalCodeView array
Contains additional code details. \n
\n
- \n
- additionalCodeView/id integer
Unique identifier of the additional code. \n
\n
- \n
- additionalCodeView/measure_id string
Unique identifier of measure which is related to additional code. \n
\n
- \n
- additionalCodeView/additional_code_id string
Unique identifier of the additional code. \n
\n
- \n
- additionalCodeView/owner_assigned_id string
Identifier assigned by the owner in the system. \n
\n
- \n
- additionalCodeView/code string
The additional code itself. \n
\n
- \n
- additionalCodeView/description string
Description of the additional code. \n
\n
- \n
- additionalCodeView/formatted_description string
Formatted description of the additional code. \n
\n
- \n
- additionalCodeView/datasource_code string
Indicates the data source. \n
\n
- \n
- additionalCodeView/language_code string
The language code for the translation. \n
Example Response
\n401 - Unauthorization
\nno Authorization header found\n\nREQUEST DESCRIPTION
\nThis endpoint returns the available configuration options for a specific product.
\nRequest Body Parameters application/cURL
\n- \n
- measureType
REQUIREDstring
Code of measure type. \n
Response Body application/json
\n- \n
- requirements array
Collection of requirements data. \n
\n
- \n
- requirements/measure_type_code string
Description Code indicating measure type. \n
\n
- \n
- requirements/group_code string
A classification code that groups related requirements together. \n
\n
- \n
- requirements/requirement_code string
Requirement code. \n
\n
- \n
- requirements/requirement_translations array
An array of translated requirements for different languages. \n
\n
- \n
- requirements/requirement_translations/language_code string
The language code for the translation. \n
\n
- \n
- requirements/requirement_translations/requirement string
Requirement description in different language. \n
\n
- \n
- requirements/action string
Specifies the type of action that must be taken to fulfill a particular requirement. It can be either submit documentation, pay duty tax, obtain licence or inspection required. \n
\n
- \n
- requirements/max_duty_expression string
Defines how the maximum duty tax is calculated within a trade measure. \n
\n
- \n
- requirements/min_duty_expression string
Defines how the minimum duty tax is calculated within a trade measure. \n
\n
- \n
- requirements/start_date string
The date when the requirement becomes effective. \n
\n
- \n
- requirements/end_date string
The date when the requirement becomes inactive. \n
\n
- \n
- measureTypes array
Contains information about the measure type. \n
\n
- \n
- measureTypes/id integer
Unique identifier of the measure type. \n
\n
- \n
- measureTypes/measure_type_code string
Code indicating measure type. \n
\n
- \n
- measureTypes/measure_type_description string
Text description of the measure type. \n
\n
- \n
- measureTypes/measure_type_short_descr string
Summary of text description of the measure type. \n
\n
- \n
- measureTypes/measure_type_serie_id string
Unique letter like id of measure types. \n
\n
- \n
- measureTypes/is_import boolean
Indicates if it applies to imports. \n
\n
- \n
- measureTypes/is_export boolean
Indicates if it applies to exports. \n
\n
- \n
- measureTypes/is_national boolean
Indicates if it applies to national or global. \n
\n
- \n
- measureTypes/category string
Represents the category in which the measure type exists. Example values ('control','tax'...) \n
\n
- \n
- measureTypes/display_type string
Represents how measure should be seen in the queries. \n
\n
- \n
- measureTypes/compliance_category string
Specifies the category of compliance related to the measure, indicating how it aligns with regulations, trade policies, or legal requirements. \n
\n
- \n
- measureTypes/origin_relation string
Refers to the relationship between a trade measure and the origin of goods. \n
\n
- \n
- measureTypes/display_order string
Numeric value that represents the display order. \n
\n
- \n
- measureTypes/created_at string
The timestamp indicating when the measure type created in the system. \n
\n
- \n
- measureTypes/updated_at string
The last update date of the data. \n
\n
- \n
- measureTypes/translations array
The language code for the translation. \n
\n
- \n
- measureTypes/translations/id integer
Unique identifier for translation id. \n
\n
- \n
- measureTypes/translations/measure_type_code string
Measure type code. \n
\n
- \n
- measureTypes/translations/measure_type_description string
Text description of measure type. \n
\n
- \n
- measureTypes/translations/language_code string
The language code for the translation of measure type. \n
\n
- \n
- measureTypes/translations/updated_at string
The last update date of the data. \n
\n
- \n
- vatRates string
The percentage rate of Value-Added Tax applicable to a product or service. \n
\n
- \n
- vatRates/10 string
Vat tax 10% percentage. \n
\n
- \n
- vatRates/20 string
Vat tax 20% percentage. \n
\n
- \n
- directives string
Official legal instructions or regulations issued by a governing body, such as the EU directives in trade and customs. \n
\n
- \n
- directives/measure_type_code string
Measure type code for related directive. \n
\n
- \n
- directives/directive_code string
Directive code. \n
\n
- \n
- directives/start_date string
The date when the directive itself becomes effective. \n
\n
- \n
- directives/end_date string
The date when the directive itself becomes inactive. \n
\n
- \n
- directives/descriptions array
Text description collection of directive. \n
\n
- \n
- directives/descriptions/description string
Each one of directive description. \n
\n
- \n
- directives/descriptions/language_code string
The language code for the translation of directive. \n
\n
- \n
- directives/directive_notes string
Additional explanations, comments, or clarifications related to a specific directive. \n
\n
- \n
- directives/directive_notes/note string
Text data of note. \n
\n
- \n
- directives/directive_notes/language_code string
Language code of notes. \n
\n
- \n
- directives/directive_notes/start_date string
The date when the directive note becomes effective. \n
\n
- \n
- directives/directive_notes/end_date string
The date when the directive note becomes inactive. \n
\n
- \n
- directives/legalbases string
The legal foundations or references that justify a regulation, measure, or directive. \n
\n
- \n
- directives/legalbases/regulation_code string
A unique identifier or reference number assigned to a specific regulation or legal act. \n
\n
- \n
- directives/legalbases/officialjournal_number string
The issue number of the Official Journal where a regulation, legal act, or measure was published. \n
\n
- \n
- directives/legalbases/officialjournal_page string
The specific page number in the official journal where a regulation, legal act, or measure is published. \n
\n
- \n
- directives/legalbases/published_date string
The date when a regulation, legal act, or measure was officially published or made publicly available. \n
\n
- \n
- directives/legalbases/regulation_url string
The web address (URL) where the full text of a regulation, legal act, or measure can be accessed online. \n
\n
- \n
- directives/legalbases/translations array
Translation collection of legalbases. \n
\n
- \n
- directives/legalbases/translations/regulation_code string
Translated regulation code of each legal base. \n
\n
- \n
- directives/legalbases/translations/language_code string
The language code for the footnote translations. \n
\n
- \n
- directives/measure_type_code string
Code indicating measure type. \n
\n
- \n
- directives/directive_code string
A unique identifier or reference number assigned to a specific directive issued by a governing body. \n
\n
- \n
- directives/start_date string
The date when the directive becomes effective. \n
\n
- \n
- directives/end_date string
The date when the directive becomes inactive. \n
\n
- \n
- directives/descriptions string
Collection of directive descriptions. \n
\n
- \n
- directives/descriptions/description string
Text description of directives. \n
\n
- \n
- directives/descriptions/language_code string
The language code for the directive translations. \n
\n
- \n
- commodity object
A basic good or raw material that can be bought and sold, typically used as an input in the production of other goods or services. \n
\n
- \n
- commodity/code string
A unique identifier or code for the commodity. It can be 10, 8 or 11 digits due to its datasource country. \n
\n
- \n
- commodity/description string
A textual brief explanation of commodity. \n
\n
- \n
- commodity/start_date string
The date when the commodity becomes effective. \n
\n
- \n
- commodity/updated_at string
The last update date of the data. \n
\n
- \n
- commodity/parent_id integer
A reference to the unique identifier of a parent entity in a hierarchical or relational structure. \n
\n
- \n
- commodity/translations array
An array of translated descriptions for different languages. \n
\n
- \n
- commodity/translations/language_code string
The language code for the translation. \n
\n
- \n
- commodity/translations/description string
A textual brief explanation of commodity in specific language. \n
Example Response
\n401 - Unauthorization
\nno Authorization header found\n\nREQUEST DESCRIPTION
\nThis endpoint allows querying for articles based on various search parameters such as article number, name, classification code, or status.
\nIt returns detailed information about each matching article, including identifiers, descriptions, validity, and any associated regulatory or catalog data.
\nRequest Body Parameters application/json
\n- \n
- article
REQUIREDstring
A specific section or provision within a legal document, regulation, treaty, or contract. \n
\n
- \n
- originCountryCode
OPTIONALstring
The origin country of the article data. \n
\n
- \n
- despatchCountryCode
REQUIREDstring
A code representing the country from which goods are dispatched or shipped. \n
\n
- \n
- destinationCountryCode
REQUIREDstring
A code representing the country to which goods are being delivered or shipped. \n
\n
- \n
- commodityCode
REQUIREDstring
A unique identifier or code for the commodity. It can be 10, 8 or 11 digits due to its datasource country. \n
\n
- \n
- measureType
REQUIREDstring
Refers to measure type, it can be 'import', 'export'. \n
\n
- \n
- articleConfiguration
OPTIONALarray
Array of article configuration data. \n
\n
- \n
- articleConfiguration/applies
REQUIREDstring
Refers to the specific conditions or context in which an article or regulation applies within a system or legal framework.
It can be etiher 'true' or 'false' \n
\n
- \n
- articleConfiguration/measure_type_code
REQUIRED/OPTIONAL/DEPENDINGstring/object/array object/integer
Desired measure type code. \n
\n
- \n
- articleConfiguration/requirement_code
REQUIREDstring
Requirement code of desired article. \n
Response Body application/json
\n- \n
- article string
A specific section or provision within a legal document, regulation, treaty, or contract. \n
\n
- \n
- originCountryCode string
A code representing the country from which goods are created in origin. \n
\n
- \n
- despatchCountryCode string
A code representing the country from which goods are dispatched or shipped. \n
\n
- \n
- destinationCountryCode string
A code representing the country to which goods are being delivered or shipped. \n
\n
- \n
- commodityCode string
A unique identifier or code for the commodity. It can be 10, 8 or 11 digits due to its datasource country. \n
\n
- \n
- taxes array
Array collection of related taxes data. \n
\n
- \n
- taxes/tax_identifier string
A unique identifier used to recognize and track a taxpayer or tax-related entity within a system. \n
\n
- \n
- taxes/measure_type_code string
Code indicating measure type. \n
\n
- \n
- taxes/duty_expression string
Describes the way a duty (tax or tariff) is calculated or applied to a good. \n
\n
- \n
- taxes/geographical_area_code string
Code of the geographical area. \n
\n
- \n
- taxes/additional_code string
Unique identifier of the additional code. \n
\n
- \n
- taxes/duty_expression_formatted string
A version of the duty_expression that is presented in a more user-friendly or readable format. \n
\n
- \n
- documents array
A string array that contains codes of documents. \n
\n
- \n
- documentScenarios array
A array of data that predefined situations or conditions under which certain documents are required, processed, or applied. \n
\n
- \n
- documentScenarios/providedDocuments array
A string array that contains codes of documents. \n
\n
- \n
- documentScenarios/taxes array
Array collection of related taxes data. \n
\n
- \n
- documentScenarios/taxes/tax_identifier string
A unique identifier used to recognize and track a taxpayer or tax-related entity within a system. \n
\n
- \n
- documentScenarios/taxes/measure_type_code string
Code indicating measure type. \n
\n
- \n
- documentScenarios/taxes/duty_expression string
Describes the way a duty (tax or tariff) is calculated or applied to a good. \n
\n
- \n
- documentScenarios/taxes/geographical_area_code string
Code of the geographical area. \n
\n
- \n
- documentScenarios/taxes/additional_code string
Unique identifier of the additional code which related that tax. \n
\n
- \n
- documentScenarios/taxes/duty_expression_formatted string
A version of the duty_expression that is presented in a more user-friendly or readable format. \n
\n
- \n
- controls array
A data set of control measures. \n
\n
- \n
- controls/measure_type_code string
Code indicating measure type. \n
\n
- \n
- controls/geographical_area_code string
Code of the geographical area. \n
\n
- \n
- controls/certificates string
Official documents issued by an authority that confirm certain facts, qualifications, or compliance with regulations. \n
\n
- \n
- controls/certificates/certificate_code string
Unique certification code. \n
\n
- \n
- controls/certificates/language_code string
The language code for the translation of certificate. \n
\n
- \n
- controls/certificates/description string
Translated text for description of certificate. \n
\n
- \n
- controls/certificates/certificate_type_code string
A unique code that categorizes a specific type of certificate used in trade, customs, or regulatory compliance. \n
\n
- \n
- controls/additional_code string
An additional code for control data in system database. \n
\n
- \n
- controls/controlApplies string
Indicates whether a specific control, restriction, or regulation is applicable to a product, trade transaction, or legal requirement.
It can be either 'true' or 'false' \n
\n
- \n
- controls/measure_type_code string
Code indicating measure type. \n
\n
- \n
- controls/footnotes array
A collection of entities which contains footnote details. \n
\n
- \n
- controls/footnotes/language_code string
The language code for the footnote translations. \n
\n
- \n
- controls/footnotes/description string
Text description of footnote. \n
\n
- \n
- controls/footnotes/id integer
Unique identifier of footnote. \n
\n
- \n
- controls/geographical_area_code string
Code of the geographical area. \n
\n
- \n
- controls/certificates array
Array of certificates data. \n
\n
- \n
- controls/certificates/certificate_code string
A unique identifier assigned to a specific certificate, used for classification and tracking in trade, customs, and regulatory compliance. \n
\n
- \n
- controls/certificates/language_code string
The language code for the translation. \n
\n
- \n
- controls/certificates/description string
Text description of certificate. \n
\n
- \n
- controls/certificates/certificate_type_code string
A unique code that categorizes a specific type of certificate used in trade, customs, or regulatory compliance. \n
\n
- \n
- controls/additional_code string
Additional code of control data. \n
\n
- \n
- controls/additional_code/code string
A unique identifier for additional code. \n
\n
- \n
- controls/additional_code/language_code string
The language code for the translation of additional code. \n
\n
- \n
- controls/additional_code/description string
Description of the additional code. \n
\n
- \n
- controls/controlApplies string
Indicates whether a specific control, restriction, or regulation is applicable to a product, trade transaction, or legal requirement.
It can be either 'true' or 'false' \n
\n
- \n
- controls/applyingDirectives string
Refers to the legal directives or regulations that are applicable to a specific product, transaction, or trade measure. \n
Fetch detailed information about a specific notification using its unique identifier.
\nRequest Body Parameters application/cURL
\n- \n
- eventCode
REQUIREDstring
Event code refers an unique identifier for an event. 'year-event_number' combination is used when creating an event number. Example: '2022-17196' \n
Response Body application/json
\n- \n
- id integer
Unique identifier for event. \n
\n
- \n
- event_code string
A unique identifier representing a specific event or action in a system, typically used in trade, customs, logistics, or regulatory processes \n
\n
- \n
- action_type string
A string value for the type of action taken in a system. Example 'addmeasures'. \n
\n
- \n
- notification_type string
Specifies the category or purpose of a notification in a system, often used in trade, customs, compliance, or logistics to inform users about important events or actions. \n
\n
- \n
- payload array
Array for information of the event. \n
\n
- \n
- payload/add_commodity_ids array
Refers to the unique identifiers (IDs) of commodities that have been added to a system, transaction, or regulatory process. \n
\n
- \n
- payload/remove_commodity_ids integer
Refers to the unique identifiers (IDs) of commodities that have been removed from a system, transaction, or regulatory process. \n
\n
- \n
- payload/measure_ids string
Unique identifier for affected measures. \n
\n
- \n
- payload/update_type string
Specifies the type or category of an update in system. Example 'addmeasures' \n
\n
- \n
- payload/effective_end_date string
The end date of the data. \n
\n
- \n
- related_review_code string
A unique identifier or code that links to a related review, assessment, or approval process. \n
\n
- \n
- created_by string
Name of the user who created that data. \n
\n
- \n
- username string
Username of the user who created that data which is for login purposes. \n
\n
- \n
- created_at string
The timestamp indicating when the measure type created in the system. \n
Example Response
\n400 - Bad Request
\n{\n \"error\": {\n \"statusCode\": 400,\n \"name\": \"BadRequestError\",\n \"message\": \"This event code did not match any existing records:ıfjkfjdk\",\n \"errorCode\": \"BAD_DUTY_EXPRESSION\",\n \"status\": 400,\n \"expose\": true,\n \"stack\": \"BadRequestError: This event code did not match any existing records:ıfjkfjdk\\n at Object.INVALID_EVENT_CODE (/home/node/app/tramas-tariff-query/dist/sw-errors.js:121:30)\\n at ProductCatalogueNotificationQueryService.getEventNotificationDetails (/home/node/app/tramas-tariff-query/dist/services/notifications/product-catalog-notification-query.service.js:29:40)\\n at process.processTicksAndRejections (node:internal/process/task_queues:95:5)\\n at async ProductCatalogueNotificationQueryControllerController.findByEventCode (/home/node/app/tramas-tariff-query/dist/controllers/notifications/product-catalogue-notification-query-controller.controller.js:28:21)\\n at async MySequence.handle (/home/node/app/tramas-tariff-query/dist/sequence.js:66:28)\\n at async HttpHandler._handleRequest (/home/node/app/node_modules/@loopback/rest/dist/http-handler.js:64:9)\"\n }\n}\n\nREQUEST DESCRIPTION
\nThis endpoint provides the mapped equivalent of a commodity from one data source to another.
\nRequest Body Parameters application/cURL
\n- \n
- mapping-to
REQUIREDstring
The country code for the country where the commodity's equivalent or counterpart is being mapped. \n
Response Body application/json
\n- \n
- mappedTo string
The country code for the country where the commodity's equivalent or counterpart is being mapped. \n
\n
- \n
- code string
A unique identifier or code for the commodity. It can be 10, 8 or 11 digits due to its datasource country. \n
\n
- \n
- description string
Text description of item that is given with that commodity_code. \n
\n
- \n
- translations array
An array of translated descriptions for different languages. \n
\n
- \n
- translations/language_code string
The language code for the translation. \n
\n
- \n
- translations/description string
The translated description of the stat code in the specified language. \n
Example Response
\n501 - Not Implemented
\n{\n \"error\": {\n \"statusCode\": 501,\n \"name\": \"NotImplementedError\",\n \"message\": \"Could not contact database - this is a much bigger problem than whatever is happening here\",\n \"errorCode\": \"INACCESSIBLE_DATABASE\",\n \"status\": 501,\n \"expose\": false,\n \"stack\": \"NotImplementedError: Could not contact database - this is a much bigger problem than whatever is happening here\\n at Object.<anonymous> (/home/node/app/tramas-tariff-query/dist/sw-errors.js:147:42)\\n at Module._compile (node:internal/modules/cjs/loader:1364:14)\\n at Module._extensions..js (node:internal/modules/cjs/loader:1422:10)\\n at Module.load (node:internal/modules/cjs/loader:1203:32)\\n at Module._load (node:internal/modules/cjs/loader:1019:12)\\n at Module.require (node:internal/modules/cjs/loader:1231:19)\\n at require (node:internal/modules/helpers:177:18)\\n at Object.<anonymous> (/home/node/app/tramas-tariff-query/dist/services/access-control.service.js:5:21)\\n at Module._compile (node:internal/modules/cjs/loader:1364:14)\\n at Module._extensions..js (node:internal/modules/cjs/loader:1422:10)\\n at Module.load (node:internal/modules/cjs/loader:1203:32)\\n at Module._load (node:internal/modules/cjs/loader:1019:12)\\n at Module.require (node:internal/modules/cjs/loader:1231:19)\\n at require (node:internal/modules/helpers:177:18)\\n at Object.<anonymous> (/home/node/app/tramas-tariff-query/dist/services/index.js:4:22)\\n at Module._compile (node:internal/modules/cjs/loader:1364:14)\"\n }\n}\n\nREQUEST DESCRIPTION
\nThis endpoint provides correlation data between standard commodity classifications (e.g., HS codes) and dual-use control list entries.
\nRequest Body Parameters application/cURL
\n- \n
- datasource_code
REQUIRED/OPTIONAL/DEPENDINGstring/object/array object/integer
Indicates the data source. \n
Response Body application/json
\n- \n
- id string
Unique identifier of the data. \n
\n
- \n
- commodity_code string
A unique identifier or code for the commodity. It can be 10, 8 or 11 digits due to its datasource country. \n
\n
- \n
- footnote_code string
Unique identifier assigned to a specific footnote. \n
\n
- \n
- dual_use_code string
A code that identifies goods, commodities, or technologies that have both civilian and military applications. These are referred to as dual-use goods and may require special export controls due to their potential military use. \n
\n
- \n
- start_date string
The date when the dual use itself becomes effective. \n
\n
- \n
- end_date string \n
The date when the dual use itself becomes inactive.
\nExample Response
\n401 - Unauthorization
\nno Authorization header found\n\nREQUEST DESCRIPTION
\nThis endpoint retrieves detailed information about a specific notification within the system.
\nResponse Body application/json
\n- \n
- commodity_code
REQUIREDstring
A unique identifier or code for the commodity. It can be 10, 8 or 11 digits due to its datasource country. \n
\n
- \n
- dualUseApplies string
A flag or indicator that specifies whether dual-use regulations apply to a particular commodity, product, or technology. It's either 'true' or 'false' \n
Example Response
\n401 - Unauthorization
\nno Authorization header found\n\nTariff – Trade Compliance & Customs Regulations
\nTariff is a digital trade solution designed to streamline cross-border trade processes within the EU, UK, Switzerland, and Türkiye. It provides businesses and trade professionals with real-time access to customs regulations, tax rates, tariff nomenclature, and product classifications, ensuring efficient and compliant import/export operations.
\nTRADE COMPLIANCE SERVICES
\n• Real-Time Updates – Ensures alignment with the latest customs regulations and tariff changes.
• Multi-Country Coverage – Supports customs data for the EU, UK, Switzerland, and Türkiye, with ongoing expansion plans. For more information about supported countries, please contact us.
• Bilingual Access – All trade regulations and tariff information are available in English, Turkish and German.
• Up-to-Date Tariff Nomenclature – Tracks and applies changes to tariff schedules as they are updated.
- \n
Basic Query
\n
Provides instant access to current tax rates and product compliance requirements for a given import/export route.
Includes:
• Current tax rates
• Relevant product compliance regulations \nPro Query
\n
Delivers a comprehensive regulatory breakdown for selected products, including conditions, legal bases, and validity periods.
Includes:
• Legal conditions and compliance requirements
• Start and end dates of applicable regulations
• Legal bases for trade compliance \nFind My Commodity Code
\n
Allows users to search for the correct customs code (HS code) by entering product-related keywords.
Includes:
• Matched HS codes based on input keywords
• Detailed product descriptions
Data Sources & Updates
• Official Government & Customs Authorities – All tariff and trade regulation data are sourced from official institutions.
• Frequent Updates – Information is updated daily, monthly, and annually, ensuring businesses always have the latest data.
Use Cases
• Trade Compliance: Ensures that businesses adhere to the latest customs regulations and tax rules.
• Product Classification: Helps users find the correct HS codes for their goods, ensuring accurate customs declarations. \nTax Calculation
\n
Provides instant insights into applicable tax rates across different trade routes, helping businesses estimate landed costs accurately and plan budgets effectively.
Includes:
• Import Duties – Standard tariffs, preferential rates (e.g., under FTAs), and anti-dumping duties
• VAT & Other Indirect Taxes – Country-specific VAT rates, excise duties, and environmental levies
• Preferential Treatment Check – Detects if goods are eligible for reduced or zero rates under trade agreements
• Route-Based Rate Comparison – Compare tax obligations for shipping the same product through different countries
• Total Landed Cost Visibility – Helps calculate the total cost of a shipment including duties, VAT, and fees \n
Get Token
\nThis endpoint is used to authenticate users for the Declarant Integration system. It returns an access token that must be used in subsequent API calls to authorize requests.
\nRequest Payload application/json
\n- \n
username
\nREQUIREDstring\n Username of the Transcode system user. Usually corresponds to the user's email or login identifier. \npassword
\nREQUIREDstring
Password corresponding to the username. Ensure it is securely stored and transmitted over HTTPS. \n
This endpoint is used to submit declaration data for export processes. It includes shipment details, consignee/consignor information, itemized invoice lines, associated documents, and routing data. This information is used for customs and logistics processing through the Transcode Integration platform.
\nRequest Payload application/json
\n- \n
- totalPayableAmountCurrency
OPTIONALstring
Currency code for the total payable amount (e.g., \"EUR\"). \n
\n
- \n
- exitVehicleCountry
OPTIONALstring
Country code (EDI format) of the vehicle's country of departure. \n
\n
- \n
- carrierName
OPTIONALstring
Name of the transport carrier responsible for the shipment. \n
\n
- \n
- customs
OPTIONALstring
Customs office code in EDI format, where declaration is processed. \n
\n
- \n
- countryOfExit
OPTIONALstring
Country code where the goods are exiting (EDI code format). \n
\n
- \n
- countryOfFirstDestination
OPTIONALstring
First destination country code after departure (EDI code format). \n
\n
- \n
- destinationCustomsOffice
OPTIONALstring
Customs office EDI code at the destination country for final processing. \n
\n
- \n
- deliveryPlace
OPTIONALstring
The named place where goods are to be delivered. \n
\n
- \n
- partyInfo
OPTIONALarray object
Contains consignor and consignee party information. \n
\n
- \n
- partyInfo/no
OPTIONALstring
Identifier for the party. \n
\n
- \n
- partyInfo/streetName
OPTIONALstring
Full address or street information. \n
\n
- \n
- partyInfo/nameTitle
REQUIREDstring
Legal name or title of the party (e.g., company name). \n
\n
- \n
- partyInfo/countryCode
REQUIREDstring
Country code of the party, in EDI format (e.g., \"052\" for Turkey). \n
\n
- \n
- partyInfo/cityAndCitySubdivisionName
OPTIONALstring
Name of city and district. \n
\n
- \n
- partyInfo/postalCode
OPTIONALstring
ZIP/postal code of the address. \n
\n
- \n
- partyInfo/telephone
OPTIONALstring
Contact number. \n
\n
- \n
- partyInfo/partyType
REQUIREDstring
Role of the party: \"Alici\" for Consignor, \"Gonderici\" for Consignee. \n
\n
- \n
- consignorTaxNo
OPTIONALstring
Consignor tax no. \n
\n
- \n
- carrierTaxNo
OPTIONALstring
Tax number or identifier of the transport carrier company. \n
\n
- \n
- items
REQUIREDarray object
List of items included in the declaration. \n
\n
- \n
- items/invoiceAmountCurrency
OPTIONALstring
Currency code for the invoice line (e.g., \"EUR\"). \n
\n
- \n
- items/invoiceAmount
OPTIONALnumber
Total value of the invoice item. \n
\n
- \n
- items/itemNo
OPTIONALstring
Item reference code. \n
\n
- \n
- items/invoiceLineNo
OPTIONALinteger
Line number in the invoice document. \n
\n
- \n
- items/itemDescription
OPTIONALstring
Description of the goods (commodity code description). \n
\n
- \n
- items/packageQuantity
OPTIONALinteger
Number of packages for the item. \n
\n
- \n
- items/netWeight
OPTIONALnumber
Net weight in kilograms. \n
\n
- \n
- items/containers
OPTIONALarray object
List of containers associated with the item. \n
\n
- \n
- items/containers/containerNo string
Unique container number used in shipping. \n
\n
- \n
- items/containers/countryCode string
ISO code of the country where the container is registered. \n
\n
- \n
- items/lineNumber
OPTIONALinteger
Unique line number for the item entry in the declaration. \n
\n
- \n
- items/itemQuantity
OPTIONALinteger
Quantity of individual goods in the item. \n
\n
- \n
- items/grossWeight
OPTIONALnumber
Gross weight. \n
\n
- \n
- items/invoiceId
OPTIONALstring
ID of the invoice that this item belongs to. \n
\n
- \n
- items/hscode
OPTIONALstring
HS (Harmonized System) code for the commodity, if applicable. \n
\n
- \n
- totalPackageQuantity
OPTIONALinteger
Total number of packages in the shipment. \n
\n
- \n
- guarantee
OPTIONALstring
GRN (Guarantee Reference Number) for customs guarantee. \n
\n
- \n
- declarationNo
OPTIONALstring
The official declaration number assigned by the system. \n
\n
- \n
- documents
REQUIREDarray
List of associated documents used in the declaration (e.g., invoices, transport docs). \n
\n
- \n
- documents/reference
REQUIREDstring
Reference number of the document. \n
\n
- \n
- documents/documentDate
REQUIREDstring
Date the document was issued. \n
\n
- \n
- documents/code
OPTIONALstring
Document type code, e.g., 100 = Invoice, 886 = Packing List. \n
\n
- \n
- documents/itemNo
OPTIONALinteger
Line number the document is related to. \n
\n
- \n
- declarationResponsibleReference
OPTIONALstring
Internal or external declaration number used for reference. \n
\n
- \n
- referenceNo
REQUIREDstring
Integration-level unique identifier. \n
\n
Notes
\nFields marked as NOT-USED are included for backward compatibility or future use, and should be ignored in integration logic.
This endpoint is used to authenticate users for the NCTS (New Computerised Transit System) integration. It provides a SOAP-based login request and returns an access token used in subsequent secured SOAP requests.
\n\n
Request Payload application/xml
\n- \n
Username
\nREQUIREDstring
The user’s login name for accessing NCTS services. \nPassword
\nREQUIREDstring
The corresponding password for the above username. \n
\n
Response Body application/xml
\n- \n
Success boolean
\n
Indicates whether login was successful (true) or not (false). \nErrorCode string
\n
An error code if authentication fails. \nMessage string
\n
A human-readable message describing success or error. \nAccessToken string
\n
Token to be used in subsequent API calls for authorization. \nRefreshToken string
\n
Token used to obtain a new access token when the current one expires. \nExpireIn integer
\n
Time in seconds until the access token expires. \nRefreshExpireIn integer
\n
Time in seconds until the refresh token expires. \n
This endpoint allows submission of a full NCTS declaration to the customs system via SOAP. It sends the declaration in a zipped, base64-encoded CC015B XML format, along with authentication credentials.
\n\n
Request Payload application/xml
\n- \n
- SendDeclarationRequest/UID
REQUIREDstring
A unique identifier for the declaration transaction. This helps with tracking and querying status later. \n
\n
- \n
- SendDeclarationRequest/ZippedXml
REQUIREDstring
The CC015B xml, zipped and base64-encoded. \n
\n
- \n
- SendDeclarationRequest/APIKEY
REQUIREDstring
Bearer token obtained from the NCTSGetTokenendpoint. Used for authenticating the declaration submission. \n
\n
Response Body application/xml
\n- \n
- Success boolean
Indicates whether the submission was successful. \n
\n
- \n
- ErrorCode string
Optional error code if the declaration submission fails. \n
\n
- \n
- Message string
Informational or error message related to the processing of the declaration. \n
\n
- \n
- Expense\n A list of declared or system-generated expenses associated with the customs declaration. Each object represents one cost item included in the declaration summary. \n
\n
- \n
- Expense/Credit\n The financial amount of the expense. \n
\n
- \n
- Expense/Currency\n ISO currency code representing the currency used for the expense (e.g., \"EUR\", \"USD\"). \n
\n
- \n
- Expense/Detail\n A short textual description of the type of expense. \n
This endpoint is used to retrieve the status messages associated with previously submitted NCTS declarations. It returns status updates, error codes, LRN/MRN values, and message tracking information for each declaration.
\n\n
Request Payload application/xml
\n- \n
- GetDeclarationStatusMessagesRequest/APIKEY
REQUIREDstring\n Access token received fromGetTokenservice. \n
\n
- \n
- GetDeclarationStatusMessagesRequest/UID
REQUIREDuuid\n Integration ref id. \n
\n
- \n
- GetDeclarationStatusMessagesRequest/MesajID
REQUIREDinteger\n Last message id, if zero (0), this means all messages. \n
\n
Response Body application/xml
\n- \n
- Success boolean
Whether the message retrieval was successful. \n
\n
- \n
- ErrorCode string
Code representing error condition if retrieval failed. \n
\n
- \n
- UID string
Unique declaration identifier. \n
\n
- \n
- RefNumHEA4 string
Internal reference number of the declaration. \n
\n
- \n
- LRN string
Local Reference Number. \n
\n
- \n
- MRN string
Movement Reference Number from customs. \n
\n
- \n
- MesajID integer
Incremental message ID used for pagination or sync. \n
\n
- \n
- MesajTipi string
Type of message (e.g., Arrival Notification, Release Notification). \n
\n
- \n
- MesajGelisTarihi string
Timestamp of when the message was received. \n
\n
- \n
- XmlData string
Raw XML content of the status message. \n
This endpoint is used to retrieve AI-processed integration documents such as analyzed declarations or automatically interpreted content. It serves as a data extraction tool from documents using Atez AI models.
\n\n
Request Payload application/json
\n- \n
- fileShare
REQUIREDstring
Publicly accessible URL pointing to the document to be processed by Atez AI \n
\n
- \n
- jobId
REQUIREDstring
Unique identifier for the document processing job. \n
\n
- \n
- mailAddress
REQUIREDstring
Email address to which processing status or results may be sent. Should be a valid email format. \n
\n
- \n
- response
REQUIREDarray object
AI-extracted data block containing structured information parsed from the uploaded document. Each object in the array represents a distinct field or set of values found. \n
\n","urlObject":{"protocol":"https","path":["api","tds","export-document","atez-ai-integration"],"host":["test-tds","singlewindow","io"],"query":[],"variable":[]}},"response":[{"id":"ecc102fa-56ef-452d-a114-808ba6ca7ca2","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"},{"key":"Authorization","value":"Bearer
This endpoint allows the submission of an 'Aviso' message, which typically contains pre-arrival or arrival notice for goods in the Verag logistics ecosystem.
\n\n
Request Payload application/json
\n- \n
username
\nREQUIREDstring\n Username of the Transcode system user. Usually corresponds to the user's email or login identifier. \npassword
\nREQUIREDstring\n Password corresponding to the username. Ensure it is securely stored and transmitted over HTTPS. \n
This endpoint is used to submit work order data to the Verag integration service, specifically related to Aviso operations. It includes vehicle identifiers, customs office information, route details, carrier information, and optional document attachments. The work order enables customs transit workflows and logistics operations between international customs zones.
\n\n
Request Payload application/json
\n- \n
- VERAG_LRN
REQUIREDstring
Logical Reference Number used for identifying the shipment uniquely across systems. \n
\n
- \n
- LicensePlateContainerNo
OPTIONALstring
Vehicle license plate or container number associated with the shipment. \n
\n
- \n
- DAKOSY
REQUIREDobject
Information block related to electronic messaging configuration. \n
\n
- \n
- DAKOSY/TemplateCode
OPTIONALstring
Code of the template used for electronic message formatting. \n
\n
- \n
- DAKOSY/IOPartner
REQUIREDstring
Partner system identifier for electronic message exchange. \n
\n
- \n
- DepartureCustomsOffice
OPTIONALstring
Code of the customs office where the goods are departing. \n
\n
- \n
- DestinationCustomsOffice
OPTIONALstring
Code of the destination customs office. \n
\n
- \n
- DatDeterminationLimit
OPTIONALstring
Deadline or estimated arrival date indd.MM.yyyyformat. \n
\n
- \n
- CoolingTemperature
OPTIONALstring
Temperature value for cold-chain goods, if applicable. \n
\n
- \n
- Carrier
REQUIREDobject
Transport company information. \n
\n
- \n
- Carrier/Name
REQUIREDstring
Name of the carrier company. \n
\n
- \n
- Carrier/Adress
REQUIREDstring
Carrier’s address information. \n
\n
- \n
- Carrier/Adress/Country
REQUIREDstring
ISO country code of the carrier's location. \n
\n
- \n
- Carrier/Adress/Postcode
OPTIONALstring
Postal code. \n
\n
- \n
- Carrier/Adress/City
OPTIONALstring
City name. \n
\n
- \n
- Carrier/Adress/Street
OPTIONALstring
Street address. \n
\n
- \n
- Guarantee
OPTIONALobject
Customs guarantee reference. \n
\n
- \n
- Guarantee/GRN
OPTIONALstring
Guarantee Reference Number. \n
\n
- \n
- Route
OPTIONALarray object
List of countries that are part of the shipment's route. \n
\n
- \n
- Route/Country
REQUIREDstring
ISO country code (e.g., \"TR\", \"DE\"). \n
\n
- \n
- TransitCustomsOffices
OPTIONALarray object
List of customs offices that the shipment will transit through. \n
\n
- \n
- TransitCustomsOffices/TransitCustomsOffice
REQUIREDstring
Customs office code of a transit location. \n
\n
- \n
- Attachments
REQUIREDarray
Container for supporting documents. \n
\n
- \n
- Attachments/Attachment
OPTIONALobject
A list of attached documents. \n
\n
- \n
- Attachments/Attachment/FileType
REQUIREDstring
Type of file (e.g., \"PDF\"). \n
\n
- \n
- Attachments/Attachment/DocumentType
OPTIONALstring
Category of document (e.g., \"OTHER\", \"INVOICE\") \n
\n
- \n
- Attachments/Attachment/base64BinaryStream
REQUIREDstring
Base64-encoded binary content of the document. \n
(Required)
\n"},{"key":"Accept","value":"*/*"}],"url":"https://test-tds.singlewindow.io/api/tds/integrations/verag/declarations?startDate=2025-01-01 00:00:00&endDate=2025-01-02 00:00:00&page=0&size=100&sort=createDate,DESC","description":"This endpoint retrieves declaration details related to NCTS (New Computerised Transit System) submissions from Verag's backend. It is used to obtain structured data related to previously submitted transit declarations.
\n","urlObject":{"protocol":"https","path":["api","tds","integrations","verag","declarations"],"host":["test-tds","singlewindow","io"],"query":[{"description":{"content":"(Required)
\n","type":"text/plain"},"key":"startDate","value":"2025-01-01 00:00:00"},{"description":{"content":"(Required)
\n","type":"text/plain"},"key":"endDate","value":"2025-01-02 00:00:00"},{"description":{"content":"(Required)
\n","type":"text/plain"},"key":"page","value":"0"},{"description":{"content":"(Required)
\n","type":"text/plain"},"key":"size","value":"100"},{"description":{"content":"(Required)
\n","type":"text/plain"},"key":"sort","value":"createDate,DESC"}],"variable":[]}},"response":[],"_postman_id":"c4b565f8-bba1-4247-b6aa-df33ed707dac"},{"name":"Get Declaration Info by MRN","id":"9e758886-2b0f-4f76-b457-18f713466abc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"API-KEY"},{"key":"value","value":"(Required)
\n"},{"key":"Accept","value":"*/*"}],"url":"https://test-tds.singlewindow.io/api/tds/integrations/verag/declarations/:mrn","description":"This endpoint retrieves detailed customs declaration information using a specific Movement Reference Number (MRN). It is typically used after a declaration has been created or updated and the MRN has been issued.
\n","urlObject":{"protocol":"https","path":["api","tds","integrations","verag","declarations",":mrn"],"host":["test-tds","singlewindow","io"],"query":[],"variable":[{"description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"VALUE","key":"mrn"}]}},"response":[],"_postman_id":"9e758886-2b0f-4f76-b457-18f713466abc"},{"name":"Get IE015 Message by Declaration ID","id":"33549c4a-c2aa-47a9-9ad8-e9e915803022","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"API-KEY"},{"key":"value","value":"(Required)
\n"},{"key":"Accept","value":"application/xml"}],"url":"https://test-tds.singlewindow.io/api/tds/integrations/verag/declarations/messages/ie015-by-id/:nctsDeclarationId","description":"Get IE015 Message by Declaration ID
\nThis endpoint retrieves the IE015 message associated with a given customs declaration.
The IE015 message is part of the electronic transit system and provides formal acknowledgment and registration of the declaration by customs.
(Required)
\n","type":"text/plain"},"type":"any","value":"VALUE","key":"nctsDeclarationId"}]}},"response":[],"_postman_id":"33549c4a-c2aa-47a9-9ad8-e9e915803022"},{"name":"Get IE015 Message by MRN","id":"4d741ce8-c828-4892-87ea-d6f5488b9957","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"API-KEY"},{"key":"value","value":"(Required)
\n"},{"key":"Accept","value":"application/xml"}],"url":"https://test-tds.singlewindow.io/api/tds/integrations/verag/declarations/messages/ie015-by-mrn/:mrn","description":"Get IE015 Message by MRN
\nThis endpoint retrieves the IE015 message related to a specific customs declaration identified by its Movement Reference Number (MRN).
The IE015 message confirms the receipt and registration of the declaration by customs authorities.
(Required)
\n","type":"text/plain"},"type":"any","value":"VALUE","key":"mrn"}]}},"response":[],"_postman_id":"4d741ce8-c828-4892-87ea-d6f5488b9957"}],"id":"cf0f81c6-5969-45ef-b68f-fe2054c45718","description":"This endpoint is used to retrieve detailed information about NCTS declarations that have been submitted through the Verag integration system. It allows clients to query the content and current status of a transit declaration, including metadata such as MRN, customs office codes, and transit-related details. This service is typically used after a declaration has been submitted, in order to verify its registration, review its contents, or use it for follow-up actions such as printing, cancellation, or message-based integration workflows.
\n","_postman_id":"cf0f81c6-5969-45ef-b68f-fe2054c45718"}],"id":"9120ed48-094e-4f88-8771-fa370d11e452","_postman_id":"9120ed48-094e-4f88-8771-fa370d11e452","description":""}],"id":"6290cba3-7e2e-4088-a956-713f9594211c","description":"Transcode by ATEZ Software Technologies is a cutting-edge software solution that streamlines the integration of customs and trade compliance data into your business processes. It facilitates smooth communication among businesses, customs authorities, and regulatory agencies, ensuring adherence to changing global trade regulations, such as ICS2 (Import Control System 2) for imports into the EU and NCTS5 (New Computerized Transit System 5) for efficient transit declaration management throughout Europe. Transcode is the next-gen solution for transit declaration.
\nTranscode’s Value Proposition
\nIn today’s fast-paced trade environment, businesses struggle with fragmented regulatory systems, manual data entry errors, and compliance bottlenecks that lead to costly delays. As customs authorities enforce stricter digital reporting requirements—such as ICS2 for import security filings and NCTS5 for transit declarations—companies must ensure their data is accurate, standardized, and submitted in real-time. Transcode eliminates these challenges by automating data exchange, validation, and submission, ensuring smooth customs clearance and transit operations.
\nKey Features
\n- \n
ICS2 & NCTS5 Compliance: Full support for ICS2 import security filings and NCTS5 transit declarations, ensuring smooth movement of goods across EU borders.
\n \nReal-time Data Processing: Automatically validates and submits trade and customs data, reducing manual effort and risk of non-compliance.
\n \nData Harmonization: Converts and maps trade data from multiple sources into formats required by different customs authorities.
\n \nUser-friendly Interface: Easy-to-use platform for managing trade data, reducing complexity for compliance teams.
\n \n
Advantages
\nTranscode makes customs declarations easier by swapping out manual, mistake-prone steps for AI-driven automation. In the past, filing meant typing in data by hand, uploading documents, checking things over and over, and resubmitting forms when there were mistakes. This caused holdups and increased the chance of breaking rules. With Transcode, Atez AI pulls out shipment info from export declaration documents, checks if everything complies, and lets you submit transit declarations while keeping an eye on them in real time. Using Atez AI cuts down on mistakes, gets approvals faster, and reduces running costs. Companies get the perks of quicker processing, fewer fines, and a clearer picture of the supply chain. This makes following customs rules more productive and budget friendly.
\nTranscode speeds up the customs declaration process compared to old-fashioned manual methods. In the past filing needed people to enter data manually, check for mistakes (which could take hours or days), and resubmit documents if information was wrong or missing. This led to risks of not following rules and expensive hold-ups. Now, Transcode uses AI to pull out shipment details from export declarations in seconds. It checks everything to make sure it's right, and processes submissions right away. This cuts down approval times from hours to just minutes. Businesses benefit from faster clearance, lower costs, fewer penalties, and greater visibility, making customs compliance seamless and efficient.
\nBusiness Impact
\n- \n
Reduced Delays & Penalties: Avoid customs rejections and transit disruptions with accurate, real-time data submissions.
\n \nEnhanced Efficiency: Automate compliance processes to minimize manual work and human errors.
\n \nRegulatory Transparency: Gain full visibility into customs and transit operations with real-time tracking and status updates.
\n \nFuture-proofed Compliance: Stay ahead of evolving EU trade regulations with a solution built for adaptability and growth.
\n \n