Backend API: Manage customer access

This document describes how to manage customer access using the Backend API. You can use these endpoints to build Back Office extensions and to keep the setting in step with a deployment or a configuration pipeline.

Customer access decides which content types a customer sees before they log in. A restricted content type is hidden from customers who are not logged in; an unrestricted one is visible to everyone. For what each content type covers on the Storefront, see Customer Access feature overview.

This is one shop-wide setting rather than a per-customer one, so the resource holds a single item and has no identifier.

Installation

These endpoints are provided by API Platform. To install and enable it, see Enable API Platform.

Retrieve customer access settings

To retrieve the current setting, send the request:

GET /customer-access

Request

Request sample: GET https://glue-backend.mysprykershop.com/customer-access

The response lists every content type configured for the project, whether it is restricted or not, so you never need to know the list of content types in advance.

Response

Response sample:

{
    "data": {
        "type": "customer-access",
        "id": "",
        "attributes": {
            "contentTypeAccess": [
                {
                    "contentType": "price",
                    "isRestricted": true
                },
                {
                    "contentType": "order-place-submit",
                    "isRestricted": true
                },
                {
                    "contentType": "add-to-cart",
                    "isRestricted": true
                },
                {
                    "contentType": "wishlist",
                    "isRestricted": false
                },
                {
                    "contentType": "shopping-list",
                    "isRestricted": false
                }
            ]
        },
        "links": {
            "self": "https://glue-backend.mysprykershop.com/customer-access"
        }
    }
}

Because the setting has a single item, data.id is empty.

The content types shipped with Spryker are price, order-place-submit, add-to-cart, wishlist, and shopping-list. A project can add more, and any content type a project adds is returned here alongside the others.

Update customer access settings

To change the setting, send the request:

PATCH /customer-access

Request

Request sample: PATCH https://glue-backend.mysprykershop.com/customer-access

{
    "data": {
        "type": "customer-access",
        "attributes": {
            "contentTypeAccess": [
                {
                    "contentType": "price",
                    "isRestricted": true
                },
                {
                    "contentType": "wishlist",
                    "isRestricted": false
                }
            ]
        }
    }
}

contentTypeAccess is a partial list: send only the content types you want to change. A content type you leave out keeps its current flag — it is neither reset nor removed. Sending the flag a content type already has succeeds and changes nothing.

An unknown content type is rejected rather than added as a new one, and nothing is saved. The response returns 422 with the error code 1226, and the error message names the content types the project is configured with. Sending the same content type twice in one request returns 422 with the error code 1227.

The change takes effect on the Storefront once it has been published to storage. The save triggers the publish, so no extra call is needed.

Response

A successful request returns the 200 OK status code.

The response describes the full current setting, including the content types you left out of the payload, with the same attributes as Retrieve customer access settings.

Other management options

• Manage customer access in the Back Office
• Customer Access feature overview
• Managing customer access to Storefront API resources
• Backend API: Manage customer groups

Possible errors

To view generic errors, see API errors and troubleshooting.