Skip to content

List a product's services

GET
/stores/{storeRef}/products/{productId}/services
curl --request GET \
--url https://apibase.ecomweb.app/api/v1/stores/example/products/1/services \
--header 'x-api-key: <x-api-key>'

Returns the services assigned to the product, ordered by sort_index, each with the time it was assigned.

Required scopes: read:products

productId
required
integer

The product ID.

storeRef
required
string

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

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
assigned_at
required

When the service was assigned to the product, 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",
"assigned_at": "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"
}

The resource does not exist in this store.

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"
}