Link Import Item

PUT/api/v1/imports/{importId}/link

Link a Kenya Revenue Authority import declaration record to a registered item in your eTIMS item registry. This connects the customs declaration to your Kenya Revenue Authority item code so that sales of this import are properly tracked.

Requires x-api-key

http://localhost:8100/api/v1/imports/{importId}/link

Path Parameters

FieldTypeRequiredDescription
importIdstringRequiredThe import item sequence number (itemSeq) from GET {{API_PATH}}/imports.

Request Body

FieldTypeRequiredDescription
itemCdstringRequiredYour Kenya Revenue Authority item code to link this import to.
hsCdstringOptionalHarmonized System (HS) code for customs.
taskCdstringOptionalTask code from the import declaration.
dclDestringOptionalDeclaration date in YYYYMMDD format.
qtynumberOptionalQuantity imported.
prcnumberOptionalUnit price.
regrIdstringOptionalRegistering user ID.
regrNmstringOptionalRegistering user name.

Request

{
  "itemCd": "GD0000000Z001",
  "hsCd": "8471300000",
  "taskCd": "TASK-001",
  "dclDe": "20240115",
  "qty": 10,
  "prc": 50000,
  "regrId": "USR01",
  "regrNm": "Admin"
}

Response

{
  "success": true,
  "data": {
    "success": true
  }
}
curl -X PUT http://localhost:8100/api/v1/imports/1/link \\
  -H "x-api-key: YOUR_API_KEY" \\
  -H "Content-Type: application/json" \\
  -d '{
    "itemCd": "GD0000000Z001",
    "hsCd": "8471300000",
    "taskCd": "TASK-001",
    "qty": 10,
    "prc": 50000,
    "regrId": "USR01",
    "regrNm": "Admin"
  }'