Glue API: Update service points

Last updated:
Edit on GitHub

This endpoint lets you update service points.

Installation

Install the Service Points feature

Update a service point

PATCH /service-points

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-points

{
    "data": {
        "type": "service-points",
        "attributes": {
            "name": "Central store",
            "key": "cs",
            "isActive": "false",
            "stores": ["DE", "AT"]
        }
    }
}
ATTRIBUTE TYPE REQUIRED DESCRIPTION
name String This name is displayed on the Storefront.
key String Unique identifier of the service point.
isActive Boolean Defines if the service point is to be active. Inactive service points are not displayed on the Storefront.
stores Object Defines which stores the service point is displayed in.

Response

Response sample:

{
    "data": {
        "type": "service-points",
        "id": "924ed48a-b4f0-516a-9921-5e9fd2149638",
        "attributes": {
            "name": "Central store",
            "key": "cs",
            "isActive": false,
            "stores": [
                "DE",
                "AT"
            ]
        },
        "links": {
            "self": "https://glue-backend.mysprykershop.com/service-points/924ed48a-b4f0-516a-9921-5e9fd2149638"
        }
    }
}
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.