Obtener una clasificación

curl --request GET \
  --url https://api.nomenclator.com.ar/v1/classifications/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.nomenclator.com.ar/v1/classifications/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "<string>",
  "status": "in_progress",
  "stage": "answers_intake",
  "failure_reason": "unexpected_format",
  "title": "<string>",
  "operation": "import",
  "country": "<string>",
  "description": "<string>",
  "external_reference": "<string>",
  "source": "app",
  "has_file": true,
  "file_has_text_layer": true,
  "cost_credits": 0,
  "candidates": [
    {
      "rank": 2,
      "ncm": "<string>",
      "description": "<string>",
      "product_name": "<string>",
      "confidence": 50,
      "confidence_band": "high",
      "is_provisional": true,
      "hierarchy": {
        "section": {
          "code": "<string>",
          "description": "<string>"
        },
        "chapter": {
          "code": "<string>",
          "description": "<string>"
        },
        "heading": {
          "code": "<string>",
          "description": "<string>"
        },
        "subheading": {
          "code": "<string>",
          "description": "<string>"
        }
      },
      "rationale": "<string>",
      "applied_rules": [
        "<string>"
      ],
      "cited_notes": [
        {
          "id": "<string>",
          "text": "<string>"
        }
      ],
      "discarded_alternatives": [
        {
          "ncm": "<string>",
          "description": "<string>",
          "reason": "<string>"
        }
      ],
      "missing_data": [
        "<string>"
      ],
      "sim": {
        "status": "verifying",
        "code": "<string>",
        "options": [
          {
            "code": "<string>",
            "description": "<string>"
          }
        ],
        "verified_at": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "candidates_are_provisional": true,
  "chosen_ncm": "<string>",
  "chosen_sim_code": "<string>",
  "questions": [
    {
      "id": "<string>",
      "text": "<string>",
      "options": [
        "<string>"
      ]
    }
  ],
  "answers": [
    {
      "question_id": "<string>",
      "question_text": "<string>",
      "answer": "<string>"
    }
  ],
  "tariffs": {
    "found": true,
    "operation": "import",
    "import_duty_intrazone": 123,
    "import_duty_extrazone": 123,
    "import_duty_applicable": 123,
    "duty_kind": "intrazone",
    "statistical_rate": 123,
    "aec": 123,
    "source": "<string>",
    "queried_at": "2023-11-07T05:31:56Z"
  },
  "reviewed": {
    "by_user_id": "<string>",
    "by_name": "<string>",
    "at": "2023-11-07T05:31:56Z",
    "note_internal": "<string>"
  },
  "feedback": {
    "ncm": "<string>",
    "matches_chosen": true,
    "at": "2023-11-07T05:31:56Z"
  },
  "refined_from": "<string>",
  "refined_to": "<string>",
  "version_id": "<string>",
  "retry_of": "<string>",
  "pdf_url": "<string>",
  "author": {
    "type": "user",
    "user_id": "<string>",
    "name": "<string>"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "resolved_at": "2023-11-07T05:31:56Z",
  "deleted_at": "2023-11-07T05:31:56Z"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "detail": "<string>",
  "instance": "<string>",
  "request_id": "<string>",
  "errors": [
    {
      "field": "<string>",
      "code": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "detail": "<string>",
  "instance": "<string>",
  "request_id": "<string>",
  "errors": [
    {
      "field": "<string>",
      "code": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "detail": "<string>",
  "instance": "<string>",
  "request_id": "<string>",
  "errors": [
    {
      "field": "<string>",
      "code": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "detail": "<string>",
  "instance": "<string>",
  "request_id": "<string>",
  "errors": [
    {
      "field": "<string>",
      "code": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "detail": "<string>",
  "instance": "<string>",
  "request_id": "<string>",
  "errors": [
    {
      "field": "<string>",
      "code": "<string>",
      "message": "<string>"
    }
  ]
}

GET

classifications

{id}

Obtener una clasificación

curl --request GET \
  --url https://api.nomenclator.com.ar/v1/classifications/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.nomenclator.com.ar/v1/classifications/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "<string>",
  "status": "in_progress",
  "stage": "answers_intake",
  "failure_reason": "unexpected_format",
  "title": "<string>",
  "operation": "import",
  "country": "<string>",
  "description": "<string>",
  "external_reference": "<string>",
  "source": "app",
  "has_file": true,
  "file_has_text_layer": true,
  "cost_credits": 0,
  "candidates": [
    {
      "rank": 2,
      "ncm": "<string>",
      "description": "<string>",
      "product_name": "<string>",
      "confidence": 50,
      "confidence_band": "high",
      "is_provisional": true,
      "hierarchy": {
        "section": {
          "code": "<string>",
          "description": "<string>"
        },
        "chapter": {
          "code": "<string>",
          "description": "<string>"
        },
        "heading": {
          "code": "<string>",
          "description": "<string>"
        },
        "subheading": {
          "code": "<string>",
          "description": "<string>"
        }
      },
      "rationale": "<string>",
      "applied_rules": [
        "<string>"
      ],
      "cited_notes": [
        {
          "id": "<string>",
          "text": "<string>"
        }
      ],
      "discarded_alternatives": [
        {
          "ncm": "<string>",
          "description": "<string>",
          "reason": "<string>"
        }
      ],
      "missing_data": [
        "<string>"
      ],
      "sim": {
        "status": "verifying",
        "code": "<string>",
        "options": [
          {
            "code": "<string>",
            "description": "<string>"
          }
        ],
        "verified_at": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "candidates_are_provisional": true,
  "chosen_ncm": "<string>",
  "chosen_sim_code": "<string>",
  "questions": [
    {
      "id": "<string>",
      "text": "<string>",
      "options": [
        "<string>"
      ]
    }
  ],
  "answers": [
    {
      "question_id": "<string>",
      "question_text": "<string>",
      "answer": "<string>"
    }
  ],
  "tariffs": {
    "found": true,
    "operation": "import",
    "import_duty_intrazone": 123,
    "import_duty_extrazone": 123,
    "import_duty_applicable": 123,
    "duty_kind": "intrazone",
    "statistical_rate": 123,
    "aec": 123,
    "source": "<string>",
    "queried_at": "2023-11-07T05:31:56Z"
  },
  "reviewed": {
    "by_user_id": "<string>",
    "by_name": "<string>",
    "at": "2023-11-07T05:31:56Z",
    "note_internal": "<string>"
  },
  "feedback": {
    "ncm": "<string>",
    "matches_chosen": true,
    "at": "2023-11-07T05:31:56Z"
  },
  "refined_from": "<string>",
  "refined_to": "<string>",
  "version_id": "<string>",
  "retry_of": "<string>",
  "pdf_url": "<string>",
  "author": {
    "type": "user",
    "user_id": "<string>",
    "name": "<string>"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "resolved_at": "2023-11-07T05:31:56Z",
  "deleted_at": "2023-11-07T05:31:56Z"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "detail": "<string>",
  "instance": "<string>",
  "request_id": "<string>",
  "errors": [
    {
      "field": "<string>",
      "code": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "detail": "<string>",
  "instance": "<string>",
  "request_id": "<string>",
  "errors": [
    {
      "field": "<string>",
      "code": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "detail": "<string>",
  "instance": "<string>",
  "request_id": "<string>",
  "errors": [
    {
      "field": "<string>",
      "code": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "detail": "<string>",
  "instance": "<string>",
  "request_id": "<string>",
  "errors": [
    {
      "field": "<string>",
      "code": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "detail": "<string>",
  "instance": "<string>",
  "request_id": "<string>",
  "errors": [
    {
      "field": "<string>",
      "code": "<string>",
      "message": "<string>"
    }
  ]
}

Qué mirar según status:

`status`	Campos que importan
`in_progress`	`stage`
`pending_data`	`questions`; y `candidates` con `candidates_are_provisional: true` si hay propuesta provisional
`resolved`	`candidates`, `chosen_ncm`, `chosen_sim_code`, `tariffs`, `pdf_url`
`failed`	`failure_reason`

En cada opción de candidates, confidence va de 0 a 100 y confidence_band la resume en high, medium o low. sim.status dice si la apertura SIM está verificada: mirá aperturas SIM.

Autorizaciones

Authorization

string

header

requerido

API key de tu organización, creada en la app en Ajustes → API. Se manda como Authorization: Bearer nmc_live_…, nunca en la query string. Alcances: read (solo leer) y classify (clasificar y leer).

Parámetros de ruta

string

requerido

Id público de la clasificación, el que devolvió el 202 al crearla.

Pattern: ^cls_[23456789ABCDEFGHJKMNPQRSTVWXYZ]{12}$

Respuesta

La clasificación.

string

requerido

Id público de la clasificación.

Pattern: ^cls_[23456789ABCDEFGHJKMNPQRSTVWXYZ]{12}$

status

enum<string>

requerido

Estado: in_progress, pending_data, resolved, failed o abandoned. Pueden sumarse valores.

Opciones disponibles:

in_progress,

pending_data,

resolved,

failed,

abandoned

stage

enum<string> | null

requerido

Etapa en curso. Solo con status in_progress; si no, null.

Opciones disponibles:

answers_intake,

extraction,

retrieval,

verdict,

validation,

sim

failure_reason

enum<string> | null

requerido

Motivo de la falla. Solo con status failed; si no, null.

Opciones disponibles:

unexpected_format,

no_valid_candidates,

timed_out,

service_unavailable,

unreadable_pdf,

persist_failed

title

string | null

requerido

Nombre del producto que identificó el clasificador. null si no lo devolvió.

operation

enum<string>

requerido

import para importación, export para exportación.

Opciones disponibles:

import,

export

country

string

requerido

País en ISO 3166-1 alfa-2: de origen en una importación, de destino en una exportación.

Pattern: ^[A-Z]{2}$

description

string | null

requerido

La descripción que se mandó.

external_reference

string | null

requerido

Tu referencia, si la mandaste.

source

enum<string>

requerido

Por dónde se creó: app o api.

Opciones disponibles:

app,

api

has_file

boolean

requerido

true si tiene ficha técnica adjunta.

file_has_text_layer

boolean | null

requerido

false si la ficha no tiene texto legible. null sin ficha.

cost_credits

integer

requerido

Créditos del plan que consumió: 0 o 1. Las clasificaciones por API se facturan en el medidor.

Rango requerido: 0 <= x <= 1

candidates

object[]

requerido

Las opciones de NCM, ordenadas. Vacío hasta que haya dictamen o propuesta provisional.

Maximum array length: 3

Show child attributes

candidates_are_provisional

boolean

requerido

true si candidates es una propuesta provisional.

chosen_ncm

string | null

requerido

NCM de la opción elegida.

Pattern: ^\d{8}$

chosen_sim_code

string | null

requerido

Apertura SIM de la opción elegida.

Pattern: ^\d{10}$

questions

object[]

requerido

Preguntas del clasificador. Solo con status pending_data.

Maximum array length: 5

Show child attributes

answers

object[]

requerido

Las respuestas que se dieron a las preguntas.

Maximum array length: 5

Show child attributes

tariffs

object

requerido

Aranceles de la opción elegida. null si todavía no se consultaron.

Option 1
Option 2
Option 3

Show child attributes

reviewed

object | null

requerido

Quién marcó el dictamen como revisado y cuándo. null si no está revisado.

Show child attributes

feedback

object | null

requerido

El NCM que se declaró finalmente, si alguien lo cargó.

Show child attributes

refined_from

string | null

requerido

Si es una versión refinada, el id de la original.

Pattern: ^cls_[23456789ABCDEFGHJKMNPQRSTVWXYZ]{12}$

refined_to

string | null

requerido

Si tiene una versión refinada, su id.

Pattern: ^cls_[23456789ABCDEFGHJKMNPQRSTVWXYZ]{12}$

version_id

string | null

requerido

Id de la versión del refinamiento.

Pattern: ^clv_[23456789ABCDEFGHJKMNPQRSTVWXYZ]{12}$

retry_of

string | null

requerido

Si es un reintento, el id de la clasificación que falló.

Pattern: ^cls_[23456789ABCDEFGHJKMNPQRSTVWXYZ]{12}$

pdf_url

string<uri> | null

requerido

URL del dictamen. Solo con status resolved.

author

object

requerido

Quién la creó: una persona o una key de la API.

Option 1
Option 2

Show child attributes

created_at

string<date-time>

requerido

Cuándo se creó.

resolved_at

string<date-time> | null

requerido

Cuándo se resolvió.

deleted_at

string<date-time> | null

requerido

Siempre null: las eliminadas no se devuelven.

Empezá acá

Conceptos

Clasificaciones

Referencia arancelaria

Cuenta

Obtener una clasificación

Autorizaciones

Parámetros de ruta

Respuesta