Search Products

This endpoint retrieves a list of products for a specific declaration.

Endpoint

GET /api/v1/declarations/{declaration_id}/products

Path Parameters

Parameter	Type	Description
declaration_id	string	The unique identifier of the declaration

Query Parameters

Parameter	Type	Description
page	integer	Page number for pagination (default: 1)
per_page	integer	Number of items per page (default: 10)

Headers

Header	Value	Description
Authorization	Required. Bearer token for authentication
Content-Type	Required. Must be application/json
X-Target-Server	Required. Target server identifier

Response

Success Response (200 OK)

{
  "data": [
    {
      "id": "string",
      "declaration_id": "string",
      "gtip": {
        "code": "string",
        "item_information": "string"
      },
      "imex_type": "integer",
      "regime_code": "integer",
      "serial_number": "integer",
      "made_in_country": {
        "code": "string",
        "name": "string"
      },
      "gross_weight_kg": "number",
      "net_weight_kg": "number",
      "measurement": {
        "unit": "string",
        "value": "number"
      },
      "taxes": [
        {
          "id": "string",
          "code": "integer",
          "base": "number",
          "rate": "number",
          "amount": "number"
        }
      ],
      "quantity": "integer",
      "item_definition": {
        "box_type": "string",
        "box_count": "integer",
        "box_brand": "string",
        "trading_definition": "string"
      },
      "total_invoice": {
        "currency": "string",
        "amount": "number"
      },
      "documents": [
        {
          "id": "string",
          "name": "string",
          "url": "string",
          "type": "string",
          "hash": "string",
          "size": "integer",
          "created_at": "string"
        }
      ],
      "is_auto_generated": "boolean",
      "auto_fill_id": "string",
      "created_at": "string",
      "updated_at": "string",
      "deleted_at": "string"
    }
  ],
  "total": "integer",
  "page": "integer",
  "per_page": "integer"
}

Example Request

curl --request GET \
  --url '{{HOST}}/api/v1/declarations/67db101b6f7e65dcdd379d6f/products?page=1&per_page=10' \
  --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...' \
  --header 'X-Target-Server: declaration'

Example Response

{
  "data": [
    {
      "id": "683074668a67b1a6c70c8fb7",
      "declaration_id": "67db101b6f7e65dcdd379d6f",
      "gtip": {
        "code": "8471.30.00.00.00",
        "item_information": "Laptop computers"
      },
      "imex_type": 3,
      "regime_code": 1000,
      "serial_number": 1,
      "made_in_country": {
        "code": "TR",
        "name": "Türkiye"
      },
      "gross_weight_kg": 2.5,
      "net_weight_kg": 2,
      "measurement": {
        "unit": "GT",
        "value": 1
      },
      "taxes": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174002",
          "code": 5,
          "base": 1999.99,
          "rate": 18,
          "amount": 359.99
        }
      ],
      "quantity": 1,
      "item_definition": {
        "box_type": "AA",
        "box_count": 1,
        "box_brand": "Apple",
        "trading_definition": "MacBook Pro 16-inch"
      },
      "total_invoice": {
        "currency": "USD",
        "amount": 1999.99
      },
      "documents": [],
      "is_auto_generated": false,
      "auto_fill_id": null,
      "created_at": "2025-05-23T13:13:10.392Z",
      "updated_at": "2025-05-23T13:13:10.392Z",
      "deleted_at": null
    }
  ],
  "total": 3,
  "page": 1,
  "per_page": 10
}