Glue API: Add service points

Last updated:
Edit on GitHub

This endpoint lets you add service points.

Installation

Install the Service Points feature

Add a service point

POST /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: POST https://glue-backend.mysprykershop.com/service-points

{
    "data": {
        "type": "service-points",
        "attributes": {
            "name": "Central store",
            "key": "cs",
            "isActive": "true",
            "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": true,
            "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
5404 A service point with the same key already exists.

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