Update Parameters

curl --request PUT \
  --url https://nueborder.com/api/v1/v1/companies/{company_id}/reports/{report_id}/goods/params \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "item_number": "1",
  "parameter_id": "QPD21",
  "parameter_name": "Aluminium scrap usage",
  "parameter_value": "9",
  "parameter_value_type": "NUMERIC",
  "additional_information": "<string>",
  "companyID": 123,
  "createdAt": "<string>",
  "description": "Tonnes scrap used for producing 1 t of the product (total scrap including post-consumer scrap)",
  "internalReportID": 123,
  "organizationID": 123,
  "sequence_number": 1,
  "updatedAt": "<string>",
  "updatedBy": "<string>",
  "version": "<string>"
}
'

import requests

url = "https://nueborder.com/api/v1/v1/companies/{company_id}/reports/{report_id}/goods/params"

payload = {
    "item_number": "1",
    "parameter_id": "QPD21",
    "parameter_name": "Aluminium scrap usage",
    "parameter_value": "9",
    "parameter_value_type": "NUMERIC",
    "additional_information": "<string>",
    "companyID": 123,
    "createdAt": "<string>",
    "description": "Tonnes scrap used for producing 1 t of the product (total scrap including post-consumer scrap)",
    "internalReportID": 123,
    "organizationID": 123,
    "sequence_number": 1,
    "updatedAt": "<string>",
    "updatedBy": "<string>",
    "version": "<string>"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    item_number: '1',
    parameter_id: 'QPD21',
    parameter_name: 'Aluminium scrap usage',
    parameter_value: '9',
    parameter_value_type: 'NUMERIC',
    additional_information: '<string>',
    companyID: 123,
    createdAt: '<string>',
    description: 'Tonnes scrap used for producing 1 t of the product (total scrap including post-consumer scrap)',
    internalReportID: 123,
    organizationID: 123,
    sequence_number: 1,
    updatedAt: '<string>',
    updatedBy: '<string>',
    version: '<string>'
  })
};

fetch('https://nueborder.com/api/v1/v1/companies/{company_id}/reports/{report_id}/goods/params', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://nueborder.com/api/v1/v1/companies/{company_id}/reports/{report_id}/goods/params",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'item_number' => '1',
    'parameter_id' => 'QPD21',
    'parameter_name' => 'Aluminium scrap usage',
    'parameter_value' => '9',
    'parameter_value_type' => 'NUMERIC',
    'additional_information' => '<string>',
    'companyID' => 123,
    'createdAt' => '<string>',
    'description' => 'Tonnes scrap used for producing 1 t of the product (total scrap including post-consumer scrap)',
    'internalReportID' => 123,
    'organizationID' => 123,
    'sequence_number' => 1,
    'updatedAt' => '<string>',
    'updatedBy' => '<string>',
    'version' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://nueborder.com/api/v1/v1/companies/{company_id}/reports/{report_id}/goods/params"

	payload := strings.NewReader("{\n  \"item_number\": \"1\",\n  \"parameter_id\": \"QPD21\",\n  \"parameter_name\": \"Aluminium scrap usage\",\n  \"parameter_value\": \"9\",\n  \"parameter_value_type\": \"NUMERIC\",\n  \"additional_information\": \"<string>\",\n  \"companyID\": 123,\n  \"createdAt\": \"<string>\",\n  \"description\": \"Tonnes scrap used for producing 1 t of the product (total scrap including post-consumer scrap)\",\n  \"internalReportID\": 123,\n  \"organizationID\": 123,\n  \"sequence_number\": 1,\n  \"updatedAt\": \"<string>\",\n  \"updatedBy\": \"<string>\",\n  \"version\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://nueborder.com/api/v1/v1/companies/{company_id}/reports/{report_id}/goods/params")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"item_number\": \"1\",\n  \"parameter_id\": \"QPD21\",\n  \"parameter_name\": \"Aluminium scrap usage\",\n  \"parameter_value\": \"9\",\n  \"parameter_value_type\": \"NUMERIC\",\n  \"additional_information\": \"<string>\",\n  \"companyID\": 123,\n  \"createdAt\": \"<string>\",\n  \"description\": \"Tonnes scrap used for producing 1 t of the product (total scrap including post-consumer scrap)\",\n  \"internalReportID\": 123,\n  \"organizationID\": 123,\n  \"sequence_number\": 1,\n  \"updatedAt\": \"<string>\",\n  \"updatedBy\": \"<string>\",\n  \"version\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://nueborder.com/api/v1/v1/companies/{company_id}/reports/{report_id}/goods/params")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"item_number\": \"1\",\n  \"parameter_id\": \"QPD21\",\n  \"parameter_name\": \"Aluminium scrap usage\",\n  \"parameter_value\": \"9\",\n  \"parameter_value_type\": \"NUMERIC\",\n  \"additional_information\": \"<string>\",\n  \"companyID\": 123,\n  \"createdAt\": \"<string>\",\n  \"description\": \"Tonnes scrap used for producing 1 t of the product (total scrap including post-consumer scrap)\",\n  \"internalReportID\": 123,\n  \"organizationID\": 123,\n  \"sequence_number\": 1,\n  \"updatedAt\": \"<string>\",\n  \"updatedBy\": \"<string>\",\n  \"version\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "message": "Operation completed successfully",
  "status": 200
}

{
  "message": "The JSON payload is invalid",
  "status": 400
}

{
  "message": "An internal server error occurred",
  "status": 500
}

PUT

companies

{company_id}

reports

{report_id}

goods

params

Update Parameters

curl --request PUT \
  --url https://nueborder.com/api/v1/v1/companies/{company_id}/reports/{report_id}/goods/params \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "item_number": "1",
  "parameter_id": "QPD21",
  "parameter_name": "Aluminium scrap usage",
  "parameter_value": "9",
  "parameter_value_type": "NUMERIC",
  "additional_information": "<string>",
  "companyID": 123,
  "createdAt": "<string>",
  "description": "Tonnes scrap used for producing 1 t of the product (total scrap including post-consumer scrap)",
  "internalReportID": 123,
  "organizationID": 123,
  "sequence_number": 1,
  "updatedAt": "<string>",
  "updatedBy": "<string>",
  "version": "<string>"
}
'

import requests

url = "https://nueborder.com/api/v1/v1/companies/{company_id}/reports/{report_id}/goods/params"

payload = {
    "item_number": "1",
    "parameter_id": "QPD21",
    "parameter_name": "Aluminium scrap usage",
    "parameter_value": "9",
    "parameter_value_type": "NUMERIC",
    "additional_information": "<string>",
    "companyID": 123,
    "createdAt": "<string>",
    "description": "Tonnes scrap used for producing 1 t of the product (total scrap including post-consumer scrap)",
    "internalReportID": 123,
    "organizationID": 123,
    "sequence_number": 1,
    "updatedAt": "<string>",
    "updatedBy": "<string>",
    "version": "<string>"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    item_number: '1',
    parameter_id: 'QPD21',
    parameter_name: 'Aluminium scrap usage',
    parameter_value: '9',
    parameter_value_type: 'NUMERIC',
    additional_information: '<string>',
    companyID: 123,
    createdAt: '<string>',
    description: 'Tonnes scrap used for producing 1 t of the product (total scrap including post-consumer scrap)',
    internalReportID: 123,
    organizationID: 123,
    sequence_number: 1,
    updatedAt: '<string>',
    updatedBy: '<string>',
    version: '<string>'
  })
};

fetch('https://nueborder.com/api/v1/v1/companies/{company_id}/reports/{report_id}/goods/params', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://nueborder.com/api/v1/v1/companies/{company_id}/reports/{report_id}/goods/params",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'item_number' => '1',
    'parameter_id' => 'QPD21',
    'parameter_name' => 'Aluminium scrap usage',
    'parameter_value' => '9',
    'parameter_value_type' => 'NUMERIC',
    'additional_information' => '<string>',
    'companyID' => 123,
    'createdAt' => '<string>',
    'description' => 'Tonnes scrap used for producing 1 t of the product (total scrap including post-consumer scrap)',
    'internalReportID' => 123,
    'organizationID' => 123,
    'sequence_number' => 1,
    'updatedAt' => '<string>',
    'updatedBy' => '<string>',
    'version' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://nueborder.com/api/v1/v1/companies/{company_id}/reports/{report_id}/goods/params"

	payload := strings.NewReader("{\n  \"item_number\": \"1\",\n  \"parameter_id\": \"QPD21\",\n  \"parameter_name\": \"Aluminium scrap usage\",\n  \"parameter_value\": \"9\",\n  \"parameter_value_type\": \"NUMERIC\",\n  \"additional_information\": \"<string>\",\n  \"companyID\": 123,\n  \"createdAt\": \"<string>\",\n  \"description\": \"Tonnes scrap used for producing 1 t of the product (total scrap including post-consumer scrap)\",\n  \"internalReportID\": 123,\n  \"organizationID\": 123,\n  \"sequence_number\": 1,\n  \"updatedAt\": \"<string>\",\n  \"updatedBy\": \"<string>\",\n  \"version\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://nueborder.com/api/v1/v1/companies/{company_id}/reports/{report_id}/goods/params")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"item_number\": \"1\",\n  \"parameter_id\": \"QPD21\",\n  \"parameter_name\": \"Aluminium scrap usage\",\n  \"parameter_value\": \"9\",\n  \"parameter_value_type\": \"NUMERIC\",\n  \"additional_information\": \"<string>\",\n  \"companyID\": 123,\n  \"createdAt\": \"<string>\",\n  \"description\": \"Tonnes scrap used for producing 1 t of the product (total scrap including post-consumer scrap)\",\n  \"internalReportID\": 123,\n  \"organizationID\": 123,\n  \"sequence_number\": 1,\n  \"updatedAt\": \"<string>\",\n  \"updatedBy\": \"<string>\",\n  \"version\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://nueborder.com/api/v1/v1/companies/{company_id}/reports/{report_id}/goods/params")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"item_number\": \"1\",\n  \"parameter_id\": \"QPD21\",\n  \"parameter_name\": \"Aluminium scrap usage\",\n  \"parameter_value\": \"9\",\n  \"parameter_value_type\": \"NUMERIC\",\n  \"additional_information\": \"<string>\",\n  \"companyID\": 123,\n  \"createdAt\": \"<string>\",\n  \"description\": \"Tonnes scrap used for producing 1 t of the product (total scrap including post-consumer scrap)\",\n  \"internalReportID\": 123,\n  \"organizationID\": 123,\n  \"sequence_number\": 1,\n  \"updatedAt\": \"<string>\",\n  \"updatedBy\": \"<string>\",\n  \"version\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "message": "Operation completed successfully",
  "status": 200
}

{
  "message": "The JSON payload is invalid",
  "status": 400
}

{
  "message": "An internal server error occurred",
  "status": 500
}

Authorizations

Authorization

string

header

required

Provide your Bearer token in the format: Bearer <your_api_key>

Path Parameters

company_id

string

required

Unique identifier for the company associated with the imported goods parameters

report_id

string

required

Unique identifier for the report associated with the imported goods parameters

Body

application/json

Payload containing imported goods parameters

Summary of Struct

item_number

string

required

Import Good Item Number, sequencial This element specifies the item number of every CBAM Good imported of the CBAM Report. It is a sequential number starting at 1. This element specifies the item number of every CBAM Good imported of the CBAM Report. It is a sequential number starting at 1. (1,2..)

Example:

"1"

parameter_id

string

required

ID of the parameter used ID of the parameter used (Min Length: 1, Max Length: 5)

Example:

"QPD21"

parameter_name

string

required

Name of the parameter used Name of the parameter used (Min Length: 1, Max Length: 256)

Example:

"Aluminium scrap usage"

parameter_value

string

required

The actual value of the parameter The actual value of the parameter (Min Length: 1, Max Length: 256)

Example:

"9"

parameter_value_type

string

required

The type of the parameter The type of the parameter (e.g., Percentage, numeric, text) (e.g., Percentage, numeric, text) (Min Length: 1, Max Length: 256)

Example:

"NUMERIC"

additional_information

string

Additional Information In this element, the Declarant can write any additional information that applies in the location where this is positioned. (Min Length: 1, Max Length: 512)

companyID

integer

Company identifier

createdAt

string

Creation time

description

string

A text element to describe the parameter A text element to describe the parameter (Min Length: 1, Max Length: 256)

Example:

"Tonnes scrap used for producing 1 t of the product (total scrap including post-consumer scrap)"

internalReportID

integer

Internal report ID

organizationID

integer

Organization identifier

sequence_number

integer

The sequential number of the parameter The sequential number of the parameter (Pattern: \d{1,5})

Example:

1

updatedAt

string

Last update time

updatedBy

string

Updater identifier

version

string

Report Versions

Response

Successfully updated or inserted imported goods parameters

A standard successful API response.

message

string

A detailed success message.

Example:

"Operation completed successfully"

status

integer

HTTP status code.

Example:

200

Get Parameters Get Quantity