Skip to content

List product services

GET
/stores/{storeRef}/product-services
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

storeRef
required
string

The store’s ref, as returned by GET /stores.

limit
number
default: 20 >= 1

Example

20

Has no effect: the route returns every service.

offset
number
0

Example

0

Has no effect: the route returns every service.

sort_by
string

Example

sort_index

Service field to sort by, such as sort_index or name.

sort_order
string
default: asc
Allowed values: asc desc

Example

asc

Sort order

Media typeapplication/json
Array<object>
object
id
required

Service ID.

number
name
required

Display name of the service.

string
description
required

Longer text for a tooltip or details, or null.

string
nullable
icon_url
required

URL of the service’s icon or badge image, or null.

string
nullable
redirection_url
required

URL opened when the badge is clicked, or null.

string
nullable
sort_index
required

Position used to order services; lower values come first.

number
created_at
required

When the service was created, as an ISO 8601 timestamp.

string
updated_at
required

When the service was last updated, as an ISO 8601 timestamp.

string

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.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The key is missing, invalid, revoked or expired.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

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.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}