Update a supplier
const url = 'https://apibase.ecomweb.app/api/v1/stores/example/suppliers/1';const options = { method: 'PUT', headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'}, body: '{"name":"Sidotech","contact_name":"example","email":"example","phone":"example","address_line1":"example","address_line2":"example","province":"79","ward":"27199","country":"VN","note":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PUT \ --url https://apibase.ecomweb.app/api/v1/stores/example/suppliers/1 \ --header 'Content-Type: application/json' \ --header 'x-api-key: <x-api-key>' \ --data '{ "name": "Sidotech", "contact_name": "example", "email": "example", "phone": "example", "address_line1": "example", "address_line2": "example", "province": "79", "ward": "27199", "country": "VN", "note": "example" }'Changes the fields you send and returns the supplier. Send null for an optional field to clear it; name and country cannot be cleared. Renaming to a name another live supplier uses answers 409 with the code SUPPLIER_NAME_TAKEN.
Required scopes: write:purchase_orders
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The supplier ID.
The store’s ref, as returned by GET /stores.
Request Bodyrequired
Section titled “Request Bodyrequired”object
Supplier name
Example
SidotechName of the contact person.
Email address that purchase orders are sent to.
Phone number.
First address line.
Second address line.
Province code.
Example
79Ward code.
Example
27199Two-letter country code. Defaults to VN.
Internal note about the supplier.
Responses
Section titled “Responses”object
Supplier ID.
Supplier name. Unique among the store’s live suppliers.
Name of the contact person, or null.
Email address that purchase orders are sent to, or null.
Phone number, or null.
First address line, or null.
Second address line, or null.
Province code, or null.
Ward code, or null.
Two-letter country code.
Internal note about the supplier, or null.
When the supplier was archived, as an ISO 8601 timestamp, or null while the supplier is live.
When the supplier was created, as an ISO 8601 timestamp.
When the supplier was last updated, as an ISO 8601 timestamp.
Example generated
{ "id": 1, "name": "example", "contact_name": "example", "email": "example", "phone": "example", "address_line1": "example", "address_line2": "example", "province": "example", "ward": "example", "country": "example", "note": "example", "archived_at": "example", "created_at": "example", "updated_at": "example"}The request is malformed or failed validation.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The key is missing, invalid, revoked or expired.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The key may not do this: a missing scope, a readonly key, a publishable key on a Store API route, or a disallowed origin.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The resource does not exist in this store.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The request conflicts with the resource’s current state.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}