Backend API: Update merchant profiles

A merchant user updates the profile of the merchant they are assigned to through the merchant-profile resource, and a Back Office user updates the profile of any merchant by its merchant reference through the merchant-profiles resource. Each resource lets its audience change what it can change in its own UI:

• A merchant user can update the same data as on the Merchant Portal profile page: the merchant details (name, email, registrationNumber, isOpenForRelationRequest), the Storefront URLs, the contact person, the public contact data, the address, and the localized texts.
• A Back Office user can update the profile data only. The merchant details, the store status, and the Storefront URLs are managed through the merchants resource; if they are sent, they are ignored.

Installation

The endpoints are provided by the MerchantProfile module and require the API Platform integration of the Backend API. For installation instructions, see Install the Merchant Profile Backend API.

Update the profile of your merchant

To update the profile of the merchant the authenticated merchant user is assigned to, send the request:

PATCH /merchant-profile

Request

The merchant of the authenticated user must be approved. A merchant user of a merchant that is still waiting for approval gets a 403 response, as in the Merchant Portal.

The update is partial: attributes you omit keep their stored values. An attribute set to null clears the stored value; null is rejected with a 422 error for the required attributes listed in the table below. Attributes that hold an object or a list behave as follows:

• address: the fields are merged. A field you omit keeps its stored value; null clears it. The address can’t be removed.
• merchantUrls: entries are merged by localeName. A URL can be replaced but not removed. Send the part of the URL after the locale prefix—for example, spryker. The prefix /{language code}/merchant/ is prepended automatically, as on the Merchant Portal profile page; a URL that already starts with it is stored as is. The response always contains the full URL.
• localizedAttributes: entries are merged by localeName, and within an entry by text. A text you omit keeps its stored value; null removes the text. Locales you omit stay untouched.

The following rules apply to a merchant user, as on the Merchant Portal profile page:

• merchantUrls and localizedAttributes accept only the locales of the stores the merchant is assigned to. The stores are listed in the stores attribute of the profile.
• A URL must be unique across the shop and must not contain whitespace or backslashes.
• The texts in localizedAttributes may contain only the HTML tags h1 to h6, br, and p.

Request sample: update the contact person and the German texts of your merchant

PATCH https://glue-backend.mysprykershop.com/merchant-profile

{
    "data": {
        "type": "merchant-profile",
        "attributes": {
            "contactPersonFirstName": "Harald",
            "contactPersonLastName": "Schmidt",
            "contactPersonPhone": "+49 30 208498350",
            "localizedAttributes": [
                {
                    "localeName": "de_DE",
                    "description": "Spryker ist der führende Anbieter für Unterhaltungselektronik.",
                    "deliveryTime": "1-3 Werktage"
                }
            ]
        }
    }
}

Request sample: rename your merchant, set its Storefront URLs, and clear the fax number

PATCH https://glue-backend.mysprykershop.com/merchant-profile

{
    "data": {
        "type": "merchant-profile",
        "attributes": {
            "name": "Spryker Systems",
            "faxNumber": null,
            "merchantUrls": [
                {
                    "localeName": "de_DE",
                    "url": "spryker-systems"
                },
                {
                    "localeName": "en_US",
                    "url": "spryker-systems"
                }
            ],
            "address": {
                "city": "Hamburg",
                "zipCode": "20095"
            }
        }
    }
}

merchantReference and stores can’t be changed. Required means the attribute can’t be cleared; you can still omit it to keep the stored value.

Response

The response contains the full profile as it is stored after the update, in the same structure as Retrieve the profile of your merchant.

Update a merchant profile

To update the profile of a merchant as a Back Office user, send the request:

PATCH /merchant-profiles/{{merchant_reference}}

The merchant does not have to be approved: a Back Office user updates the profile of a merchant that is still waiting for approval, as in the Back Office.

Request

The merge rules for address and localizedAttributes are the same as for Update the profile of your merchant, with the following differences:

• name, email, registrationNumber, isActive, isOpenForRelationRequest, and merchantUrls are read-only. If they are sent, they are ignored. To change them, use the merchants resource.
• localizedAttributes accepts every locale configured in the project, and the texts are not restricted to a set of HTML tags, as in the Back Office.

Request sample: update the public contact data and the English description of a merchant

PATCH https://glue-backend.mysprykershop.com/merchant-profiles/MER000001

{
    "data": {
        "type": "merchant-profiles",
        "id": "MER000001",
        "attributes": {
            "publicEmail": "[email protected]",
            "publicPhone": "+49 30 208498350",
            "localizedAttributes": [
                {
                    "localeName": "en_US",
                    "description": "Spryker is your partner for consumer electronics."
                }
            ]
        }
    }
}

Response

The response contains the full profile as it is stored after the update, in the same structure as Retrieve a merchant profile.

Possible errors

The request is validated as a whole: if any check fails, nothing is updated and all failed checks are returned in the errors array.

To view generic errors and status codes of the Backend API, see Backend API request and response reference.