Update Custom code

Customs Code Update

This API allows an external system to update an existing customs code in the 4ws.trade database. The system can update multiple fields such as descriptions in various languages, active status, and net weight.

Actors

API Client: The system or user initiating the request.

4ws.trade: The backend system that processes the request.

Preconditions

The external system must have the necessary permissions and access to the document creation service, please refer to Authentication.

The custom_code to be updated must exist in the 4ws.trade database. If it does not exist, an error will be returned.

Languages

To understand how languages are managed, please refer to our Managing Languages Documentation.

Main Success Scenario

The external system sends a PATCH request with the updated data for a specific custom_code.

If the custom_code exists and the update is successful, the system returns the internal prog_id and the updated custom_code.

{
  "customCode": {
    "prog_id": 178175,                       // Internal ID of the updated customs code
    "custom_code": "12345678"                // Customs code that was updated
  }
}

Alternate Flows

Custom Code Not Found:
If the custom_code does not exist, the API returns an HTTP 422 error with the message:

{
  "message": "Custom code not found {custom_code}"
}

Validation Errors:
If the input data fails validation (e.g., invalid fields), the API will return an appropriate error message indicating the issue.

Sequence Diagram

Code Examples in Node.js

Example for updating a customs code:

Best Practices

Please refer to Best Practices for Error Handling in External System for best practices on implementation.

This documentation describes how to update an existing customs code in the 4ws.trade database using the API. It covers the success scenarios, error handling, best practices, and includes code examples for implementation in Node.js.

Request

Path Params

Body Params application/json

Example

{
    "description_it": "string",
    "description_en": "string",
    "description_de": "string",
    "description_es": "string",
    "description_fr": "string",
    "description_pt": "string",
    "description_ru": "string",
    "description_ar": "string",
    "description_ja": "string",
    "description_zh": "string",
    "active": true,
    "net_weight": 19
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Update Custom code

Customs Code Update#

Actors#

Preconditions#

Languages#

Main Success Scenario#

Alternate Flows#

Sequence Diagram#

Code Examples in Node.js#

Request

Request Code Samples

Responses

Customs Code Update

Actors

Preconditions

Languages

Main Success Scenario

Alternate Flows

Sequence Diagram

Code Examples in Node.js