Requires create_product access scope. More access scope
The Update Supplier API updates the details of an existing supplier by its unique identifier (id). This endpoint is useful for modifying supplier information such as the URL, allowing users to maintain accurate supplier data.This API is especially useful for:
Updating supplier information for procurement or inventory purposes.
Ensuring supplier records are up-to-date with accurate data.
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 supplier ID provided in the request does not exist.
{ "errors": [ "Supplier not found"]}
API Structure Overview
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!
