Insert Custom code

Insert Customs Code

This API allows external systems to add a new customs code to the 4ws.trade database. The system can specify details such as the customs code, descriptions in multiple languages, and the net weight of the product. The API ensures that customs codes are unique.

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 must be unique; if it already exists, the API will return an error.

Languages

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

Main Success Scenario

The external system sends a POST request to the API with the customs code data.

If the custom_code is unique and the request is valid, the system stores the customs code in the 4ws.trade database.

The API responds with the internal ID (prog_id) and the custom_code that was added.

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

Alternate Flows

If the custom_code already exists in the database, the API returns an HTTP 422 error with the message:

{
  "message": "Unique constraint error"
}

Sequence Diagram

Code Examples in Node.js

Example for adding a customs code:

Best Practices

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

This documentation outlines how external systems can add customs codes to the 4ws.trade database, including error handling, best practices, and examples in Node.js for implementation.

Request

Body Params application/json

Example

{
    "custom_code": "string",
    "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

Insert Custom code

Insert Customs Code#

Actors#

Preconditions#

Languages#

Main Success Scenario#

Alternate Flows#

Sequence Diagram#

Code Examples in Node.js#

Request

Request Code Samples

Responses

Insert Customs Code

Actors

Preconditions

Languages

Main Success Scenario

Alternate Flows

Sequence Diagram

Code Examples in Node.js