Glue API: Add shipment types

Last updated: July 30, 2026

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 add shipment types.

Installation

Install the Shipment feature

Add a shipment type point

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

{
    "data": {
        "type": "shipment-types",
        "attributes": {
            "name": "Locker pickup",
            "key": "l-pickup",
            "isActive": "true",
            "stores": ["DE", "AT"]
        }
    }
}

ATTRIBUTE	TYPE	REQUIRED	DESCRIPTION
name	String	✓	You will use it as a reference when adding shipment types to offers in the Merchant portal.
key	String	✓	Unique identifier of the shipment type.
isActive	Boolean	✓	Defines if the shipment type is active. You can only add active shipment types to offers.
stores	Object	✓	Defines the stores the shipment type is to be available for.

Response

Response sample:

{
    "data": {
        "type": "shipment-types",
        "id": "fa575a58-5119-5407-a00b-d1aa01fec63d",
        "attributes": {
            "name": "Locker pickup",
            "key": "l-pickup",
            "isActive": true,
            "stores": [
                "DE",
                "AT"
            ]
        },
        "links": {
            "self": "https://glue-backend.mysprykershop.com/shipment-types/fa575a58-5119-5407-a00b-d1aa01fec63d"
        }
    }
}

RESOURCE	ATTRIBUTE	TYPE	DESCRIPTION
shipment-types	name	String	You will use it to as a reference when adding shipment types to offers in the Merchant Portal.
shipment-types	key	String	Unique key of the shipment type. You will use it as a reference when adding shipment types to offers in the Merchant Portal.
shipment-types	isActive	Boolean	Defines if the shipment type is active. Only active shipment types are displayed in the Merchant Portal.
shipment-types	stores	Object	Defines the stores this shipment type is available for.

Possible errors

CODE	REASON
5502	A shipment type with the same key already exists.

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