List product services
const url = 'https://apibase.ecomweb.app/api/v1/stores/example/product-services?limit=20&offset=0&sort_by=sort_index&sort_order=asc';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/product-services?limit=20&offset=0&sort_by=sort_index&sort_order=asc' \ --header 'x-api-key: <x-api-key>'Returns every product service in the store as one array, ordered by sort_index unless you send sort_by and sort_order. Services are small badges, such as free shipping, that you can attach to products. The route is not paginated, so limit and offset have no effect.
Required scopes: read:products
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”Example
20Has no effect: the route returns every service.
Example
0Has no effect: the route returns every service.
Example
sort_indexService field to sort by, such as sort_index or name.
Example
ascSort order
Responses
Section titled “Responses”object
Service ID.
Display name of the service.
Longer text for a tooltip or details, or null.
URL of the service’s icon or badge image, or null.
URL opened when the badge is clicked, or null.
Position used to order services; lower values come first.
When the service was created, as an ISO 8601 timestamp.
When the service was last updated, as an ISO 8601 timestamp.
Example generated
[ { "id": 1, "name": "example", "description": "example", "icon_url": "example", "redirection_url": "example", "sort_index": 1, "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"}