Create a product service
const url = 'https://apibase.ecomweb.app/api/v1/stores/example/product-services';const options = { method: 'POST', headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'}, body: '{"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}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The store’s ref, as returned by GET /stores.
Request Bodyrequired
Section titled “Request Bodyrequired”object
Display name of the service
Example
Giao hàng nhanh chóngOptional description for tooltip or details
Example
Giao hàng trong vòng 24h tại nội thànhOptional icon/badge image URL
Example
https://example.com/icons/fast-delivery.svgOptional URL to redirect when clicking the service badge
Example
https://example.com/shipping-policyDisplay sort order
Example
0Responses
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"}