List suppliers
const url = 'https://apibase.ecomweb.app/api/v1/stores/example/suppliers?limit=20&offset=0&status=active&include_archived=false';const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://apibase.ecomweb.app/api/v1/stores/example/suppliers?limit=20&offset=0&status=active&include_archived=false' \ --header 'x-api-key: <x-api-key>'Returns the store’s suppliers one page at a time. By default only live suppliers are returned; set status to archived or all to include archived ones. Use search to match a name, contact name or email.
Required scopes: read:purchase_orders
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The store’s ref, as returned by GET /stores.
Query Parameters
Section titled “Query Parameters”Maximum number of suppliers to return, from 1 to 100.
Number of suppliers to skip.
Matches name, contact name or email
Live suppliers only (default), archived ones only, or both. Takes precedence over include_archived.
Same as status=all when true. Ignored when status is set.
Responses
Section titled “Responses”object
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.
object
Total number of items matching the request.
Maximum number of items in this page.
Number of items skipped before this page.
Current page number, starting at 1.
Total number of pages.
Whether a next page exists.
Whether a previous page exists.
Example generated
{ "data": [ { "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" } ], "meta": { "total": 1, "limit": 1, "offset": 1, "page": 1, "totalPages": 1, "hasNext": true, "hasPrev": true }}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"}