Update a Transaction Component

Change data of an individual component of a transaction.

Update a component.

Update the properties of the specified component. Handles updates partially.

patch

/components/{id}

Authorizations

Path parameters

idstringrequired

Body

hsnstring

HS Code of the product. The HS code consists of at least six digits and is used by customs to classify the product being shipped.

Example: 1201

quantitynumber

Quantity of the product, measured in the specified unit.

Example: 123.45

unitall of

Measurement unit of the product quantity. Can be one of: LTR, MTR, MTRSQR, MTRCUBE, KGM, TNE, PCS, PR, SET, PKG.

Example: KGM

descriptionstring

Short description of the product.

namePairsobject[] · default:

The name pairs of the product.

Example: [{"commonName":"soybean","scientificName":"Glycine max"},{"commonName":"edamame","scientificName":"Glycine max var. viridis"}]

dateOfProductionstring

ISO 8601. The time at which the product was produced., For time ranges, also specify the endDateOfProduction.

Example: 2021-01-01T00:00:00.000Z

endDateOfProductionstring

ISO 8601. The time at which a time-ranged production was finalized.

Example: 2022-01-01T00:00:00.000Z

supplierBusinessIdstring

Id of the supplier business for the transaction.

Example: 02c36247-1aad-41ba-aa49-f114ca4c263f

ddsReferencesobject[]

Identifiers of the upstream DDS references.

Example: [{"id":"24DKYIGLPU3439","verificationNumber":"4NAB3QYM"}]

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://api.tradeaware.live-eo.com/components/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "hsn": "1201",
    "quantity": 123.45,
    "unit": "KGM",
    "description": "text",
    "namePairs": [
      {
        "commonName": "soybean",
        "scientificName": "Glycine max"
      },
      {
        "commonName": "edamame",
        "scientificName": "Glycine max var. viridis"
      }
    ],
    "dateOfProduction": "2021-01-01T00:00:00.000Z",
    "endDateOfProduction": "2022-01-01T00:00:00.000Z",
    "supplierBusinessId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
    "ddsReferences": [
      {
        "id": "24DKYIGLPU3439",
        "verificationNumber": "4NAB3QYM"
      }
    ]
  }'

200

400

401

403

404

200

{
  "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
  "hsn": "18010000",
  "commodity": "oil palm",
  "quantity": 123.45,
  "unit": "KGM",
  "description": "text",
  "namePairs": [
    {
      "commonName": "soybean",
      "scientificName": "Glycine max"
    }
  ],
  "transactionId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
  "dateOfProduction": "2021-01-01T00:00:00.000Z",
  "endDateOfProduction": "2021-01-01T00:00:00.000Z",
  "createdAt": "2023-07-26T15:03:48Z",
  "updatedAt": "2023-07-28T09:13:37Z",
  "supplierBusiness": "[Circular Reference]"
}