4WS Suite
Home
API Reference
  • Data mangement API
  • Documents API
Home
API Reference
  • Data mangement API
  • Documents API
Fourwayshop
  1. Supplier
  • Login
    • login
      POST
  • Product
    • Brand
      • Get All Brands
      • Get A Brand
      • Insert brand
      • Update brand
    • Season
      • Get All Seasons
      • Get A Season
      • Insert season
      • Update season
    • Attribute
      • Get All Attribute Types
      • Get Attribute Type
      • Get Attribute
      • Insert attribute
      • Update attribute
    • Hierarchy
      • Insert hierarchy
      • Update hierarchy
    • Dimension groups
      • Insert dimension group
      • Update dimension group
    • Dimension
      • Insert dimension
      • Update dimension
      • Delete dimension
    • Product
      • Get products
      • Get product
      • Get product grouping
      • Get SKU's barcodes
      • Get product stock
      • Insert product
      • Update product
    • Activate dimensions on products
      • Insert active dimensions
      • Delete active dimensions
    • Barcode
      • Get SKU from barcode
      • Generate missing barcodes
      • Generate missing barcode for SKU
      • Insert barcode
      • Delete barcode
    • Prices
      • Get product prices
    • Price dimension groupings
      • Get Dimension Price Grouping
      • Get All Dimension Price Grouping
      • Insert dimension grouping
      • Update dimension grouping
      • Delete dimension grouping
    • Assortment
      • insert product assortment
      • delete product assortment
    • Image
      • Get images
      • Add image
      • Replace image
      • Delete image
    • Supplier
      • Get Item suppliers
      • Insert item supplier
      • Delete item supplier
      • Update item supplier
    • Custom category
      • Get Custom code
      • Insert Custom code
      • Update Custom code
    • Vat
      • Vat types
        • Get VAT type
        • Get VAT types
      • VATs
        • Get VATs
        • Get VATs by type
        • Get VAT
      • Vat rates
        • Get VAT rates
        • Get single VAT rates
    • Stock
      • Insert stock
      • Get stock
  • Price lists
    • Get price lists
      GET
    • Get price lists by type
      GET
    • Get price list
      GET
    • Get prices from price list
      GET
    • Get entities from price lists
      GET
    • Insert Price List
      POST
    • Insert Product Price
      POST
    • Insert Entity On Price Lists
      POST
    • Update price list
      PATCH
    • Delete all product prices
      DELETE
    • Delete single product price
      DELETE
    • Delete entity from a price lists
      DELETE
  • Supplier
    • Supplier contacts
    • Supplier addresses
    • Get Suppliers
      GET
    • Get A Specific Supplier
      GET
    • Insert supplier
      POST
    • Update supplier
      PATCH
  • Entities
    • Get entities
    • Get entity
    • Insert entity
    • Update entity
  • Miscellaneous
    • Get requests rate limits
  • Catalog
    • Get Catalogs details
    • Get Catalog details by Code
    • Get products by Catalog Code
  • Export
    • Get bulk CSV Export
  1. Supplier

Get A Specific Supplier

GET
/api/v1/suppliers/{SUPPLIER_CODE}
Last modified:2025-02-07 15:05:00

Retrive a Supplier#

This API allows the retrieval of the supplier details by specifying the SUBJECT_CODE. The response includes various details about the supplier, such as company name, address, contact information, and invoice data.

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 API client must provide a valid SUBJECT_CODE in the request path.
The client must have proper authorization to access supplier data.

Main Success Scenario#

1.
The API client sends a GET request with the SUBJECT_CODE to retrieve the supplier details.
2.
The 4ws.suite Platform processes the request and returns the supplier data, including various fields such as the company name, address, and VAT code.
3.
The response contains the details of the supplier.

Alternate Flows#

1.
Supplier Not Found: If the SUBJECT_CODE does not match any supplier in the system, the API will return an error with a message like "Supplier not found".
2.
Invalid SUBJECT_CODE Format: If the SUBJECT_CODE format is incorrect, the API will return an error indicating the invalid input.

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#

Example Node.js code to retrieve the supplier data using the API:

Request

Path Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/api/v1/suppliers/'

Responses

🟢200POST/PATCH/DELETE Errore record non trovato
application/json
Body

Example
{
    "supplier": {
        "supplier_code": "54",
        "supplier_company_name": "Brenda Ankunding",
        "address1": "Wales Pfefferbury Clwyd 821 Giovanna Mead Apt. 290",
        "address2": "Wales Jacobi-over-Russel Strathclyde 43 Roscoe Brae Apt. 791",
        "zip_code": "TH9 8BA",
        "city": "Long Zemlak",
        "country": "Saint Lucia",
        "region": null,
        "province": "England",
        "language": "laboris quis in",
        "currency": "QAR",
        "company_vat_code": "24",
        "payment_code": "63",
        "barcode": "9",
        "note_it": "Lorem esse eu mollit",
        "note_en": "magna quis",
        "note_de": "aliqua",
        "note_es": "ullamco aute",
        "note_fr": null,
        "note_pt": null,
        "note_ru": null,
        "note_ar": null,
        "note_ja": "Excepteur cillum nostrud commodo nulla",
        "note_zh": null,
        "courier": null
    }
}
Modified at 2025-02-07 15:05:00
Previous
Get Suppliers
Next
Insert supplier
Built with