Glue API: Update service types

Last updated:
Edit on GitHub
This page describes the API endpoint contract, which is the same regardless of the serving infrastructure. Storefront API endpoints are served by API Platform (recommended) or the legacy Glue infrastructure; Backend API endpoints currently run on the Glue infrastructure.

This endpoint lets you update service types.

Installation

Install the Service Points feature

Update a service type

PATCH /service-types

Request

HEADER KEY HEADER VALUE REQUIRED DESCRIPTION
Authorization string ✓ Alphanumeric string that authorizes the warehouse user to send requests to protected resources. Get it by authenticating as a warehouse user.

Request sample: PATCH https://glue-backend.mysprykershop.com/service-types/7a263a50-12a3-5ef4-86f4-366f20783180

{
    "data": {
        "type": "service-types",
        "attributes": {
            "name": "Demos"
        }
    }
}
ATTRIBUTE TYPE REQUIRED DESCRIPTION
name String Name.

Response

Response sample:

{
    "data": {
        "type": "service-types",
        "id": "7a263a50-12a3-5ef4-86f4-366f20783180",
        "attributes": {
            "name": "Demos",
            "key": "demo"
        },
        "links": {
            "self": "https://glue-backend.mysprykershop.com/service-types/7a263a50-12a3-5ef4-86f4-366f20783180"
        }
    }
}
RESOURCE ATTRIBUTE TYPE DESCRIPTION
service-points name String This name is displayed on the Storefront.
service-points key String Unique identifier of the service point.
service-points isActive Boolean Defines if the service point is active. If it’s inactive, customers can’t select it.
service-points stores Object Defines the stores the service point is available in.

Possible errors

CODE REASON
5403 The service point with the specified ID doesn’t exist.

To view generic errors that originate from the Glue Application, see Reference information: GlueApplication errors.