Insert supplier

Insert New Supplier Registration

The goal of this API is to allow external systems to register suppliers from which they source products. The external system will provide the necessary information about the supplier, such as company name, address, VAT code, and other relevant details. Upon successful registration, the supplier will be stored in the 4ws.trade system.

This API enables external system to create a new supplier within the system. Once registered, this supplier can be subsequently utilized in the Insert product or the Update product for associating products.

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.

Required fields (such as supplier code and VAT code) must be provided by the external system.

Main Success Scenario

The external system sends a POST request to the API with the necessary supplier details.

If the supplier is successfully registered, a 200 HTTP status is returned with the supplier's internal ID and subject code.

Request sample

{
    "supplier_code": "EXA01SUPP",
    "supplier_company_name": "Example Supplier name.",
    "address": "Via Roma 2",
    "zip_code": "12932",
    "city": "Roma",
    "country": "IT",
    "region": "LAZ",
    "province": "RM",
    "language": "IT",
    "currency": "EUR",
    "company_vat_code": "IT2948302323",
    "email": "example@mail.com",
    "phone": "2384930982430",
    "website": "www.example.com",
    "invoice_address": "Via Giallo 1",
    "invoice_zip_code": "49394",
    "invoice_city": "Roma",
    "invoice_country": "IT",
    "invoice_region": "LAZ",
    "invoice_province": "RM",
    "invoice_subject_company_name": "Example Invoice Inc.",
    "payment_code": "CONTANTI",
    "barcode": "283902749023",
    "note": "This is an example."
}

Response on success:

{
  "supplier": {
    "prog_id": 178175,
    "subject_code": "EXA01SUPP"
  }
}

Alternate Flows

Unique Constraint Error: If the supplier code already exists, the system returns a 422 error with the message:

{
  "message": "Unique constraint error"
}

Missing Fields: If required fields are missing, the API will return a 400 error indicating the missing data.

Sequence Diagram

Best Practices

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

Code Examples in Node.js

Request

Header Params

Body Params application/json

Example

{
   "supplier_code": "{{supplier_code}}",
   "supplier_company_name": "{{supplier_company_name}}",
   "address": "{{address}}",
   "zip_code": "{{zip_code}}",
   "city": "{{city}}",
   "country": "{{country}}",
   "region": "{{region}}",
   "province": "{{province}}",
   "language": "{{language}}",
   "currency": "{{currency}}",
   "company_vat_code": "{{company_vat_code}}",
   "email": "{{email}}",
   "phone": "{{phone}}",
   "website": "{{website}}",
   "invoice_address": "{{invoice_address}}",
   "invoice_zip_code": "{{invoice_zip_code}}",
   "invoice_city": "{{invoice_city}}",
   "invoice_country": "{{invoice_country}}",
   "invoice_region": "{{invoice_region}}",
   "invoice_province": "{{invoice_province}}",
   "invoice_subject_company_name": "{{invoice_subject_company_name}}",
   "payment_code": "{{payment_code}}",
   "barcode": "{{barcode}}",
   "note": "{{note}}"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Insert New Supplier Registration#

Actors#

Preconditions#

Main Success Scenario#

Alternate Flows#

Sequence Diagram#

Code Examples in Node.js#

Request

Request Code Samples

Responses

Insert New Supplier Registration

Actors

Preconditions

Main Success Scenario

Alternate Flows

Sequence Diagram

Code Examples in Node.js