Glue API: Retrieve business unit addresses

Last updated:
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 allows retrieving business unit addresses.

Retrieve a business unit address

To retrieve a business unit address, send the request:

GET /company-business-unit-addresses/{{business_unit_address_id}}

PATH PARAMETER DESCRIPTION
{{business_unit_address_id}} Unique identifier of a business unit address to retrieve.

Request

HEADER KEY TYPE REQUIRED DESCRIPTION
Authorization string ✓ String containing digits, letters, and symbols that authorize the company user. Authenticate as a company user to get the value.

Request sample: retrieve a business unit address

GET http://glue.mysprykershop.com/company-business-unit-addresses/eec036ee-b999-5753-a7dd-8d0710a2312f

Response

Response sample: retrieve a business unit address 
{
    "data": {
        "type": "company-business-unit-addresses",
        "id": "eec036ee-b999-5753-a7dd-8d0710a2312f",
        "attributes": {
            "address1": "Seeburger Str.",
            "address2": "270",
            "address3": "Block A 3 floor",
            "zipCode": "10115",
            "city": "Berlin",
            "phone": "4908892455",
            "iso2Code": null,
            "comment": ""
        },
        "links": {
            "self": "http://glue.mysprykershop.com/company-business-unit-addresses/eec036ee-b999-5753-a7dd-8d0710a2312f"
        }
    }
}
RESOURCE ATTRIBUTE TYPE DESCRIPTION
company-business-unit-addresses address1 String Specifies the first line of the business unit address.
company-business-unit-addresses address2 String Specifies the second line of the business unit address.
company-business-unit-addresses address3 String Specifies the third line of the business unit address.
company-business-unit-addresses zipCode String Specifies the ZIP code.
company-business-unit-addresses city String Specifies the city.
company-business-unit-addresses phone String Specifies the phone number of the business unit.
company-business-unit-addresses iso2Code String Specifies an ISO 2 country code to use.
company-business-unit-addresses comment String Specifies an optional comment to the business unit.

Possible errors

CODE REASON
001 Access token is invalid.
002 Access token is missing.
2001 Company business unit address is not found.
Note

If your current company account is not set, you may get the 404 status code.

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

Next steps