Requires read_product access scope. More access scope
The Get Supplier Detail API retrieves the detailed information of a specific supplier by its unique identifier (id). This endpoint is useful for fetching supplier details such as name, URL, and creation and update timestamps for inventory or procurement management.This API is especially useful for:
Fetching supplier details for inventory tracking or procurement systems.
Validating supplier information for external systems.
Error responses in the API can be represented using two different fields: errors and error. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.
Field
Type
Example
Description
errors
Array
["invalid id"]
A list of errors encountered during the request processing.
Field
Type
Example
Description
error
Array
"store is not active"
Indicates an error encountered during the process.
Error Details
Status Code
Message
Possible Reason
Example Response
400
Bad Request
Invalid input format or request structure (e.g., missing required fields or incorrect data types).
Bad Request
Unauthorized
The request is missing valid authentication credentials or the credentials provided are invalid.
Unauthorized
Empty supplier_id
Missing required supplier_id
{"errors":["invalid id"]}
404
Supplier Not Found
The database query for retrieving the Supplier returned no result.
{ "errors": ["Supplier not found"] }
API Structure Overview
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!
