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 /services

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/services/37ef89d3-7792-533c-951c-981c6b56312c

{
    "data": {
        "type": "services",
        "attributes": {
            "isActive": false
        }
    }
}
ATTRIBUTE TYPE REQUIRED DESCRIPTION
isActive Boolean Defines if the service is to be active. Inactive services are not displayed on the Storefront.

Response

Response sample:

{
    "data": {
        "type": "services",
        "id": "37ef89d3-7792-533c-951c-981c6b56312c",
        "attributes": {
            "uuid": "37ef89d3-7792-533c-951c-981c6b56312c",
            "isActive": false,
            "key": "s1"
        },
        "links": {
            "self": "https://glue-backend.mysprykershop.com/services/37ef89d3-7792-533c-951c-981c6b56312c"
        }
    }
}
RESOURCE ATTRIBUTE TYPE DESCRIPTION
services uuid String Unique identifier of the service.
services isActive Boolean Defines if the service is active. Inactive services are not displayed on the Storefront.
services key String Unique key of the service. It’s used as a reference when assigning services to service points.

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.