4WS Suite
Home
API Reference
API Reference
Data mangement API
Documents API
Home
API Reference
API Reference
Data mangement API
Documents API
Fourwayshop
Brand
Copy Page
Login
login
POST
Product
Brand
Get All Brands
GET
Get A Brand
GET
Insert brand
POST
Update brand
PATCH
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 All Price Lists
GET
Get Single Price List
GET
Get Prices by Price List Type
GET
Get Prices by Price List Code
GET
Get Entities by Price List Code
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 A Specific Supplier
Insert supplier
Update supplier
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
Brand
Copy Page
Get A Brand
GET
/api/v1/brands/{BRAND_CODE}
Try it
Run in Apidog
Run in Apidog
Last modified:
2025-02-07 14:36:10
Retrieve Specific Brand Details
#
This API allows an external system to retrieve detailed information about a specific product brand by providing the brand code as a parameter.
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 brand code provided in the request must exist in the 4ws.suite system.
Main Success Scenario
#
1.
The API client sends a GET request with the
BRAND_CODE
parameter in the URL.
2.
The platform retrieves and returns the details of the specified brand.
Response Example
Alternate Flows
#
Invalid Brand Code
: If the specified
BRAND_CODE
does not exist, the API returns an appropriate error response.
Response Example
Authentication Error
: If the client does not provide valid credentials, an authentication error is returned.
Rate Limiting
: If the API rate limits are exceeded, the client must respect the retry interval indicated in the response headers
Rate Limits
.
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
Path Params
Generate Code
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
cURL-Windows
Httpie
wget
PowerShell
curl
--location
'/api/v1/brands/'
Responses
🟢
200
Brands
application/json
Generate Code
Body
application/json
Generate Code
Example
{
"brand_code"
:
"84"
,
"description"
:
"Sud Brand"
}
Modified atÂ
2025-02-07 14:36:10
Previous
Get All Brands
Next
Insert brand