Skip to content

Create a product service

POST
/stores/{storeRef}/product-services
curl --request POST \
--url https://apibase.ecomweb.app/api/v1/stores/example/product-services \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--data '{ "name": "Giao hàng nhanh chóng", "description": "Giao hàng trong vòng 24h tại nội thành", "icon_url": "https://example.com/icons/fast-delivery.svg", "redirection_url": "https://example.com/shipping-policy", "sort_index": 0 }'

Creates a service badge. When sort_index is omitted or 0, the service is placed after the existing ones.

Required scopes: write:products

storeRef
required
string

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

Media typeapplication/json
object
name
required

Display name of the service

string
<= 255 characters

Example

Giao hàng nhanh chóng
description

Optional description for tooltip or details

string

Example

Giao hàng trong vòng 24h tại nội thành
icon_url

Optional icon/badge image URL

string
<= 500 characters

Example

https://example.com/icons/fast-delivery.svg
redirection_url

Optional URL to redirect when clicking the service badge

string
<= 500 characters

Example

https://example.com/shipping-policy
sort_index

Display sort order

number
0

Example

0
Media typeapplication/json
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"
}