Skip to content

Latest commit

 

History

History
212 lines (164 loc) · 6.28 KB

glue-api-retrieve-shipment-types.md

File metadata and controls

212 lines (164 loc) · 6.28 KB
Raw
title description last_updated template
Glue API: Retrieve shipment types
Learn how to retrieve shipment types using Glue API
Nov 23, 2023
glue-api-storefront-guide-template

This endpoint lets you retrieve shipment types.

Installation

Install the Shipment feature

Retrieve shipment types

GET /shipment-types

Request

HEADER KEY HEADER VALUE REQUIRED DESCRIPTION
Authorization string For backend API. Alphanumeric string that authorizes the warehouse user to send requests to protected resources. Get it by authenticating as a warehouse user.
REQUEST API TYPE USAGE
GET https://glue-backend.mysprykershop.com/shipment-types Backend Retrieve all shipment types.
GET https://glue.mysprykershop.com/shipment-types Storefront Retrieve all shipment types.

Response

Backend: Retrieve shipment types 
{
    "data": [
        {
            "type": "shipment-types",
            "id": "174d9dc0-55ae-5c4b-a2f2-a419027029ef",
            "attributes": {
                "name": "Pickup",
                "key": "pickup",
                "isActive": true,
                "stores": [
                    "DE",
                    "AT"
                ]
            },
            "links": {
                "self": "https://glue-backend.mysprykershop.com/shipment-types/174d9dc0-55ae-5c4b-a2f2-a419027029ef"
            }
        },
        {
            "type": "shipment-types",
            "id": "9e1bd563-3106-52d1-9717-18e8d491e3b3",
            "attributes": {
                "name": "Delivery",
                "key": "delivery",
                "isActive": true,
                "stores": [
                    "DE",
                    "AT"
                ]
            },
            "links": {
                "self": "https://glue-backend.mysprykershop.com/shipment-types/9e1bd563-3106-52d1-9717-18e8d491e3b3"
            }
        }
    ],
    "links": {
        "self": "https://glue-backend.mysprykershop.com/shipment-types"
    }
}
Storefront: Retrieve shipment types 
{
    "data": [
        {
            "type": "shipment-types",
            "id": "9e1bd563-3106-52d1-9717-18e8d491e3b3",
            "attributes": {
                "name": "Delivery",
                "key": "delivery"
            },
            "links": {
                "self": "https://glue.mysprykershop.com/shipment-types/9e1bd563-3106-52d1-9717-18e8d491e3b3"
            }
        },
        {
            "type": "shipment-types",
            "id": "174d9dc0-55ae-5c4b-a2f2-a419027029ef",
            "attributes": {
                "name": "Pickup",
                "key": "pickup"
            },
            "links": {
                "self": "https://glue.mysprykershop.com/shipment-types/174d9dc0-55ae-5c4b-a2f2-a419027029ef"
            }
        }
    ],
    "links": {
        "self": "https://glue.mysprykershop.com/shipment-types"
    }
}

{% include pbc/all/glue-api-guides/{{page.version}}/shipment-types-response-attributes.md %}

Retrieve a shipment type

GET {% raw %}/shipment-types/{{shipment_type_id}}{% endraw %}

PATH PARAMETER DESCRIPTION
{% raw %}{{shipment_type_id}}{% endraw %} ID of a shipment type to retrieve. To get it, add a shipment type or retrieve shipment types.

Request

HEADER KEY HEADER VALUE REQUIRED DESCRIPTION
Authorization string For backend API. Alphanumeric string that authorizes the warehouse user to send requests to protected resources. Get it by authenticating as a warehouse user.
REQUEST API TYPE USAGE
GET https://glue-backend.mysprykershop.com/shipment-types/174d9dc0-55ae-5c4b-a2f2-a419027029ef Backend Retrieve a shipment type with the specified ID.
GET https://glue.mysprykershop.com/shipment-types/174d9dc0-55ae-5c4b-a2f2-a419027029ef Storefront Retrieve a shipment type with the specified ID.

Response

Backend: Retrieve a shipment typed with the specified ID 
{
    "data": {
        "type": "shipment-types",
        "id": "174d9dc0-55ae-5c4b-a2f2-a419027029ef",
        "attributes": {
            "name": "Pickup",
            "key": "pickup",
            "isActive": true,
            "stores": [
                "DE",
                "AT"
            ]
        },
        "links": {
            "self": "https://glue-backend.mysprykershop.com/shipment-types/174d9dc0-55ae-5c4b-a2f2-a419027029ef"
        }
    }
}
Storefront: Retrieve a shipment typed with the specified ID 
{
    "data": {
        "type": "shipment-types",
        "id": "174d9dc0-55ae-5c4b-a2f2-a419027029ef",
        "attributes": {
            "name": "Pickup",
            "key": "pickup"
        },
        "links": {
            "self": "https://glue.mysprykershop.com/shipment-types/174d9dc0-55ae-5c4b-a2f2-a419027029ef"
        }
    }
}

{% include pbc/all/glue-api-guides/{{page.version}}/shipment-types-response-attributes.md %}

Possible errors

CODE REASON
5501 The shipment type with the specified ID doesn't exist.

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