Spryker Documentation

Glue API: Retrieve Marketplace orders

Thu, 14 May 2026 09:14:23 +0000

Every registered customer can retrieve the list of orders for their account, as well as the detailed order information, including every step of the calculation and addresses used in the orders. In your development, this resource can help you to: - Make the order history available to customers. - Make order details available to enable reordering functionality. The **Marketplace Order Management API** lets you retrieve all orders made by a registered customer. ## Installation For detailed information about the modules that provide the API functionality and related installation instructions, see [**Install the Order Management Glue API**](/docs/pbc/all/order-management-system/latest/base-shop/install-and-upgrade/install-glue-api/install-the-order-management-glue-api.html) ## Retrieve all orders To retrieve a list of all orders made by a registered customer, send the request: *** `GET` **/orders** *** ### Request | HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | | ------------- | ------------ | -------- | -------------------------------- | | Authorization | string | ✓ | Alphanumeric string that authorizes the customer to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/latest/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | | QUERY PARAMETER | DESCRIPTION | POSSIBLE VALUES | | ---------------- | ---------------------- | ----------------------------- | | offset | The offset of the order at which to begin the response. Works only together with page[limit]. To work correctly, the value should be devisable by the value of page[limit]. The default value is 0. | From `0` to any. | | limit | The maximum number of entries to return. Works only together with page[offset]. The default value is 10. | From `1` to any. | | include | Adds resource relationships to the request. | merchants | | REQUEST | USAGE | | --------------------- | ------------------ | | `GET https://glue.mysprykershop.com/orders` | Retrieve all orders. | | `GET https://glue.mysprykershop.com/orders?page[limit]=10` | Retrieve 10 orders. | | `GET https://glue.mysprykershop.com/orders?page[offset]=10&page[limit]=10` | Retrieve 10 orders starting from the eleventh order. | | `GET https://glue.mysprykershop.com/orders?page[offset]=20` | Retrieve all orders starting from the twenty first order. | | `GET https://glue.mysprykershop.com/orders?include=merchants` | Retrieve all orders with the merchants included. | ### Response

Response sample: retrieve all orders

Response sample: retrieve all orders with the merchants included

```json { "data": [ { "type": "orders", "id": "DE--5", "attributes": { "merchantReferences": [], "itemStates": [ "closed" ], "createdAt": "2020-10-19 15:26:37.868585", "currencyIsoCode": "EUR", "priceMode": "GROSS_MODE", "totals": { "expenseTotal": 500, "discountTotal": 9701, "taxTotal": 10962, "subtotal": 92013, "grandTotal": 82812, "canceledTotal": 0, "remunerationTotal": 0 } }, "links": { "self": "https://glue.mysprykershop.com/orders/DE--5?include=merchants" } }, { "type": "orders", "id": "DE--4", "attributes": { "merchantReferences": [], "itemStates": [ "shipped" ], "createdAt": "2020-10-19 15:25:57.909985", "currencyIsoCode": "EUR", "priceMode": "GROSS_MODE", "totals": { "expenseTotal": 500, "discountTotal": 14841, "taxTotal": 0, "subtotal": 143412, "grandTotal": 129071, "canceledTotal": 0, "remunerationTotal": 0 } }, "links": { "self": "https://glue.mysprykershop.com/orders/DE--4?include=merchants" } }, { "type": "orders", "id": "DE--3", "attributes": { "merchantReferences": [], "itemStates": [ "closed" ], "createdAt": "2020-10-19 15:25:14.861031", "currencyIsoCode": "EUR", "priceMode": "GROSS_MODE", "totals": { "expenseTotal": 1500, "discountTotal": 9147, "taxTotal": 2893, "subtotal": 91474, "grandTotal": 83827, "canceledTotal": 0, "remunerationTotal": 0 } }, "links": { "self": "https://glue.mysprykershop.com/orders/DE--3?include=merchants" } }, { "type": "orders", "id": "DE--2", "attributes": { "merchantReferences": [ "MER000002", "MER000001" ], "itemStates": [ "new" ], "createdAt": "2020-10-19 15:16:21.879286", "currencyIsoCode": "EUR", "priceMode": "GROSS_MODE", "totals": { "expenseTotal": 1590, "discountTotal": 3959, "taxTotal": 4957, "subtotal": 39586, "grandTotal": 37217, "canceledTotal": 0, "remunerationTotal": 0 } }, "links": { "self": "https://glue.mysprykershop.com/orders/DE--2?include=merchants" }, "relationships": { "merchants": { "data": [ { "type": "merchants", "id": "MER000002" }, { "type": "merchants", "id": "MER000001" } ] } } }, { "type": "orders", "id": "DE--1", "attributes": { "merchantReferences": [ "MER000001", "MER000002", "MER000006", "MER000005" ], "itemStates": [ "confirmed" ], "createdAt": "2020-10-19 15:14:51.183582", "currencyIsoCode": "EUR", "priceMode": "GROSS_MODE", "totals": { "expenseTotal": 4080, "discountTotal": 11884, "taxTotal": 12651, "subtotal": 113944, "grandTotal": 106140, "canceledTotal": 0, "remunerationTotal": 0 } }, "links": { "self": "https://glue.mysprykershop.com/orders/DE--1?include=merchants" }, "relationships": { "merchants": { "data": [ { "type": "merchants", "id": "MER000002" }, { "type": "merchants", "id": "MER000001" }, { "type": "merchants", "id": "MER000006" }, { "type": "merchants", "id": "MER000005" } ] } } } ], "links": { "self": "https://glue.mysprykershop.com/orders?include=merchants" }, "included": [ { "type": "merchants", "id": "MER000002", "attributes": { "merchantName": "Video King", "merchantUrl": "/en/merchant/video-king", "contactPersonRole": "Country Manager DE", "contactPersonTitle": "Ms", "contactPersonFirstName": "Martha", "contactPersonLastName": "Farmer", "contactPersonPhone": "+31 123 345 678", "logoUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/videoking-logo.png", "publicEmail": "hi@video-king.nl", "publicPhone": "+31 123 345 777", "description": "Video King is a premium provider of video equipment. In business since 2010, we understand the needs of video professionals and enthusiasts and offer a wide variety of products with competitive prices. ", "bannerUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/videoking-banner.png", "deliveryTime": "2-4 days", "latitude": "4.838470", "longitude": "51.558107", "faxNumber": "+31 123 345 733", "legalInformation": { "terms": "

General Terms

(1) This privacy policy has been compiled to better serve those who are concerned with how their 'Personally identifiable information' (PII) is being used online. PII, as used in US privacy law and information security, is information that can be used on its own or with other information to identify, contact, or locate a single person, or to identify an individual in context. Please read our privacy policy carefully to get a clear understanding of how we collect, use, protect or otherwise handle your Personally Identifiable Information in accordance with our website.

(2) We do not collect information from visitors of our site or other details to help you with your experience.

Using your Information

We may use the information we collect from you when you register, make a purchase, sign up for our newsletter, respond to a survey or marketing communication, surf the website, or use certain other site features in the following ways:

To personalize user's experience and to let us deliver the type of content and product offerings in which you are most interested.

Protecting visitor information

Our website is scanned on a regular basis for security holes and known vulnerabilities in order to make your visit to our site as safe as possible. Your personal information is contained behind secured networks and is only accessible by a limited number of persons who have special access rights to such systems, and are required to keep the information confidential. In addition, all sensitive/credit information you supply is encrypted via Secure Socket Layer (SSL) technology.

", "cancellationPolicy": "You have the right to withdraw from this contract within 14 days without giving any reason. The withdrawal period will expire after 14 days from the day on which you acquire, or a third party other than the carrier and indicated by you acquires, physical possession of the last good. You may use the attached model withdrawal form, but it's not obligatory. To meet the withdrawal deadline, it's sufficient for you to send your communication concerning your exercise of the right of withdrawal before the withdrawal period has expired.", "imprint": "

Video King

Gilzeweg 24
4854SG Bavel
NL

Phone: +31 123 45 6789
Email: hi@video-king.nl

Represented by
Managing Director: Max Mustermann
Register Court: Amsterdam
Register Number: 1234.4567

", "dataPrivacy": "Video King values the privacy of your personal data." } }, "links": { "self": "https://glue.mysprykershop.com/merchants/MER000002" } }, { "type": "merchants", "id": "MER000001", "attributes": { "merchantName": "Spryker", "merchantUrl": "/en/merchant/spryker", "contactPersonRole": "E-Commerce Manager", "contactPersonTitle": "Mr", "contactPersonFirstName": "Harald", "contactPersonLastName": "Schmidt", "contactPersonPhone": "+49 30 208498350", "logoUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/spryker-logo.png", "publicEmail": "info@spryker.com", "publicPhone": "+49 30 234567891", "description": "Spryker is the main merchant at the Demo Marketplace.", "bannerUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/spryker-banner.png", "deliveryTime": "1-3 days", "latitude": "13.384458", "longitude": "52.534105", "faxNumber": "+49 30 234567800", "legalInformation": { "terms": "

Spryker Systems GmbH

Julie-Wolfthorn-Straße 1
10115 Berlin
DE

Phone: +49 (30) 2084983 50
Email: info@spryker.com

Represented by
Managing Directors: Alexander Graf, Boris Lokschin
Register Court: Hamburg
Register Number: HRB 134310

", "dataPrivacy": "Spryker Systems GmbH values the privacy of your personal data." } }, "links": { "self": "https://glue.mysprykershop.com/merchants/MER000001" } }, { "type": "merchants", "id": "MER000006", "attributes": { "merchantName": "Sony Experts", "merchantUrl": "/en/merchant/sony-experts", "contactPersonRole": "Brand Manager", "contactPersonTitle": "Ms", "contactPersonFirstName": "Michele", "contactPersonLastName": "Nemeth", "contactPersonPhone": "030/123456789", "logoUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/sonyexperts-logo.png", "publicEmail": "support@sony-experts.com", "publicPhone": "+49 30 234567691", "description": "Capture your moment with the best cameras from Sony. From pocket-size to professional-style, they all pack features to deliver the best quality pictures.Discover the range of Sony cameras, lenses and accessories, and capture your favorite moments with precision and style with the best cameras can offer.", "bannerUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/sonyexperts-banner.png", "deliveryTime": "1-3 days", "latitude": "11.547788", "longitude": "48.131058", "faxNumber": "+49 30 234567600", "legalInformation": { "terms": "

Sony Experts

Matthias-Pschorr-Straße 1
80336 München
DE

Phone: 030 1234567
Email: support@sony-experts.com

Represented by
Managing Director: Max Mustermann
Register Court: Munich
Register Number: HYY 134306

", "dataPrivacy": "Sony Experts values the privacy of your personal data." } }, "links": { "self": "https://glue.mysprykershop.com/merchants/MER000006" } }, { "type": "merchants", "id": "MER000005", "attributes": { "merchantName": "Budget Cameras", "merchantUrl": "/en/merchant/budget-cameras", "contactPersonRole": "Merchandise Manager", "contactPersonTitle": "Mr", "contactPersonFirstName": "Jason", "contactPersonLastName": "Weidmann", "contactPersonPhone": "030/123456789", "logoUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/budgetcameras-logo.png", "publicEmail": "support@budgetcamerasonline.com", "publicPhone": "+49 30 234567591", "description": "DSLR and mirrorless cameras are by far the most popular with filmmakers on a tight budget when you can't afford multiple specialist cameras.Budget Cameras is offering a great selection of digital cameras with the lowest prices.", "bannerUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/budgetcameras-banner.png", "deliveryTime": "2-4 days", "latitude": "10.004663", "longitude": "53.552463", "faxNumber": "+49 30 234567500", "legalInformation": { "terms": "

Budget Cameras

Spitalerstraße 3
20095 Hamburg
DE

Phone: 030 1234567
Email: support@budgetcamerasonline.com

Represented by
Managing Director: Max Mustermann
Register Court: Hamburg
Register Number: HXX 134305

", "dataPrivacy": "Budget Cameras values the privacy of your personal data." } }, "links": { "self": "https://glue.mysprykershop.com/merchants/MER000005" } } ] } ```

{% include /pbc/all/glue-api-guides/latest/orders-response-attributes.md %} For the attributes of the included resources, see [Retrieving merchants](/docs/pbc/all/merchant-management/latest/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html). ## Retrieve an order To retrieve detailed information about an order, send the request: *** `GET` {% raw %}**/orders/*{{order_id}}***{% endraw %} *** | PATH PARAMETER | DESCRIPTION | | ------------------ | ------------------------------ | | {% raw %}***{{order_id}}***{% endraw %} | Unique identifier of an order. [Retrieve all orders](/docs/pbc/all/order-management-system/latest/base-shop/glue-api-retrieve-orders.html) to get it. | ### Request | HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | | ------------- | ------------ | -------- | ---------------------- | | Authorization | string | ✓ | Alphanumeric string that authorizes the customer to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/latest/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | | String parameter | Description | Possible values | | ---------------- | -------------------- | --------------------- | | include | Adds resource relationships to the request. | order-shipments, concrete-products, abstract-products, merchants | | REQUEST | USAGE | | ----------------- | ------------------ | | `GET https://glue.mysprykershop.com/orders/DE--6` | Retrieve information about the `DE--6` order. | | `GET https://glue.mysprykershop.com/orders/DE--6?include=order-shipments` | Retrieve information about the order with the ID `DE--6` with order shipments included. | | `GET https://glue.mysprykershop.com/orders/DE--3?include=merchants` | Retrieve order `DE--3` with the merchants included.| ### Response

Response sample: retrieve information about the order

```json { "data": { "type": "orders", "id": "DE--6", "attributes": { "merchantReferences": [], "itemStates": [ "payment pending" ], "createdAt": "2021-01-05 13:43:23.000000", "currencyIsoCode": "EUR", "priceMode": "GROSS_MODE", "totals": { "expenseTotal": 1180, "discountTotal": 0, "taxTotal": 12173, "subtotal": 75064, "grandTotal": 76244, "canceledTotal": 0, "remunerationTotal": 0 }, "billingAddress": { "salutation": "Mr", "firstName": "Spencor", "middleName": null, "lastName": "Hopkin", "address1": "Julie-Wolfthorn-Straße", "address2": "1", "address3": "new address", "company": "spryker", "city": "Berlin", "zipCode": "10115", "poBox": null, "phone": "+49 (30) 2084 98350", "cellPhone": null, "description": null, "comment": null, "email": null, "country": "Germany", "iso2Code": "DE" }, "shippingAddress": null, "items": [ { "merchantReference": null, "state": "payment pending", "name": "Samsung Galaxy S5 mini", "sku": "066_23294028", "sumPrice": 39353, "quantity": 1, "unitGrossPrice": 39353, "sumGrossPrice": 39353, "taxRate": "19.00", "unitNetPrice": 0, "sumNetPrice": 0, "unitPrice": 39353, "unitTaxAmountFullAggregation": 6283, "sumTaxAmountFullAggregation": 6283, "refundableAmount": 39353, "canceledAmount": 0, "sumSubtotalAggregation": 39353, "unitSubtotalAggregation": 39353, "unitProductOptionPriceAggregation": 0, "sumProductOptionPriceAggregation": 0, "unitExpensePriceAggregation": 0, "sumExpensePriceAggregation": null, "unitDiscountAmountAggregation": 0, "sumDiscountAmountAggregation": 0, "unitDiscountAmountFullAggregation": 0, "sumDiscountAmountFullAggregation": 0, "unitPriceToPayAggregation": 39353, "sumPriceToPayAggregation": 39353, "taxRateAverageAggregation": "19.00", "taxAmountAfterCancellation": null, "orderReference": null, "uuid": "3db99597-99a0-58a9-a0ea-696e8da0026e", "isReturnable": false, "idShipment": 11, "bundleItemIdentifier": null, "relatedBundleItemIdentifier": null, "salesOrderConfiguredBundle": null, "salesOrderConfiguredBundleItem": null, "metadata": { "superAttributes": { "color": "Blue" }, "image": "https://images.icecat.biz/img/gallery_mediums/23294028_3275.jpg" }, "salesUnit": null, "calculatedDiscounts": [], "productOptions": [], "amount": null }, { "merchantReference": null, "state": "payment pending", "name": "Sony Xperia Z3 Compact", "sku": "076_24394207", "sumPrice": 35711, "quantity": 1, "unitGrossPrice": 35711, "sumGrossPrice": 35711, "taxRate": "19.00", "unitNetPrice": 0, "sumNetPrice": 0, "unitPrice": 35711, "unitTaxAmountFullAggregation": 5702, "sumTaxAmountFullAggregation": 5702, "refundableAmount": 35711, "canceledAmount": 0, "sumSubtotalAggregation": 35711, "unitSubtotalAggregation": 35711, "unitProductOptionPriceAggregation": 0, "sumProductOptionPriceAggregation": 0, "unitExpensePriceAggregation": 0, "sumExpensePriceAggregation": null, "unitDiscountAmountAggregation": 0, "sumDiscountAmountAggregation": 0, "unitDiscountAmountFullAggregation": 0, "sumDiscountAmountFullAggregation": 0, "unitPriceToPayAggregation": 35711, "sumPriceToPayAggregation": 35711, "taxRateAverageAggregation": "19.00", "taxAmountAfterCancellation": null, "orderReference": null, "uuid": "40274175-4398-5927-8980-48ead5053e69", "isReturnable": false, "idShipment": 12, "bundleItemIdentifier": null, "relatedBundleItemIdentifier": null, "salesOrderConfiguredBundle": null, "salesOrderConfiguredBundleItem": null, "metadata": { "superAttributes": { "color": "White" }, "image": "https://images.icecat.biz/img/norm/medium/24394207-3552.jpg" }, "salesUnit": null, "calculatedDiscounts": [ { "unitAmount": 786, "sumAmount": 786, "displayName": "10% Discount for all orders above", "description": "Get a 10% discount on all orders above certain value depending on the currency and net/gross price. This discount is not exclusive and can be combined with other discounts.", "voucherCode": null, "quantity": 1 } ], "productOptions": [], "amount": null } ], "expenses": [ { "type": "SHIPMENT_EXPENSE_TYPE", "name": "Express", "sumPrice": 590, "unitGrossPrice": 590, "sumGrossPrice": 590, "taxRate": "19.00", "unitNetPrice": 0, "sumNetPrice": 0, "canceledAmount": null, "unitDiscountAmountAggregation": null, "sumDiscountAmountAggregation": null, "unitTaxAmount": 94, "sumTaxAmount": 94, "unitPriceToPayAggregation": 590, "sumPriceToPayAggregation": 590, "taxAmountAfterCancellation": null, "idShipment": 11, "idSalesExpense": 11 }, { "type": "SHIPMENT_EXPENSE_TYPE", "name": "Express", "sumPrice": 590, "unitGrossPrice": 590, "sumGrossPrice": 590, "taxRate": "19.00", "unitNetPrice": 0, "sumNetPrice": 0, "canceledAmount": null, "unitDiscountAmountAggregation": null, "sumDiscountAmountAggregation": null, "unitTaxAmount": 94, "sumTaxAmount": 94, "unitPriceToPayAggregation": 590, "sumPriceToPayAggregation": 590, "taxAmountAfterCancellation": null, "idShipment": 12, "idSalesExpense": 12 } ], "payments": [ { "amount": 76244, "paymentProvider": "DummyPayment", "paymentMethod": "Invoice" } ], "shipments": [], "calculatedDiscounts": [], "bundleItems": [] }, "links": { "self": "https://glue.mysprykershop.com/orders/DE--6" } } } ```

Response sample: retrieve information about the order with order shipments included

```json { "data": { "type": "orders", "id": "DE--6", "attributes": { "merchantReferences": [ "MER000005", "MER000002" ], "itemStates": [ "sent to merchant", "delivered" ], "createdAt": "2021-06-18 13:44:23.895154", "currencyIsoCode": "EUR", "priceMode": "GROSS_MODE", "totals": { "expenseTotal": 2500, "discountTotal": 0, "taxTotal": 6976, "subtotal": 41191, "grandTotal": 43691, "canceledTotal": 0, "remunerationTotal": 0 }, "billingAddress": { "salutation": "Ms", "firstName": "Sonia", "middleName": null, "lastName": "Wagner", "address1": "Kirncher Str.", "address2": "7", "address3": "", "company": "Acme Corporation", "city": "Berlin", "zipCode": "10247", "poBox": null, "phone": "4902890031", "cellPhone": null, "description": null, "comment": "", "email": null, "country": "Germany", "iso2Code": "DE" }, "shippingAddress": { "salutation": "Ms", "firstName": "Sonia", "middleName": null, "lastName": "Wagner", "address1": "Kirncher Str.", "address2": "7", "address3": "", "company": "Acme Corporation", "city": "Berlin", "zipCode": "10247", "poBox": null, "phone": "4902890031", "cellPhone": null, "description": null, "comment": "", "email": null, "country": "Germany", "iso2Code": "DE" }, "items": [ { "merchantReference": "MER000005", "state": "sent to merchant", "name": "Sony Cyber-shot DSC-W830", "sku": "018_21081477", "sumPrice": 31140, "quantity": 1, "unitGrossPrice": 31140, "sumGrossPrice": 31140, "taxRate": "19.00", "unitNetPrice": 0, "sumNetPrice": 0, "unitPrice": 31140, "unitTaxAmountFullAggregation": 4972, "sumTaxAmountFullAggregation": 4972, "refundableAmount": 31140, "canceledAmount": 0, "sumSubtotalAggregation": 31140, "unitSubtotalAggregation": 31140, "unitProductOptionPriceAggregation": 0, "sumProductOptionPriceAggregation": 0, "unitExpensePriceAggregation": 0, "sumExpensePriceAggregation": null, "unitDiscountAmountAggregation": 0, "sumDiscountAmountAggregation": 0, "unitDiscountAmountFullAggregation": 0, "sumDiscountAmountFullAggregation": 0, "unitPriceToPayAggregation": 31140, "sumPriceToPayAggregation": 31140, "taxRateAverageAggregation": "19.00", "taxAmountAfterCancellation": null, "orderReference": null, "uuid": "349f3ce2-0396-5ed4-a2df-c9e053cb3350", "isReturnable": false, "idShipment": 11, "bundleItemIdentifier": null, "relatedBundleItemIdentifier": null, "productOfferReference": "offer66", "salesOrderConfiguredBundle": null, "salesOrderConfiguredBundleItem": null, "metadata": { "superAttributes": { "color": "Pink" }, "image": "https://d2s0ynfc62ej12.cloudfront.net/b2c/21081477-Sony.jpg" }, "salesOrderItemConfiguration": null, "salesUnit": null, "calculatedDiscounts": [], "productOptions": [], "amount": null }, { "merchantReference": "MER000002", "state": "delivered", "name": "Sony Cyber-shot DSC-W830", "sku": "020_21081478", "sumPrice": 10051, "quantity": 1, "unitGrossPrice": 10051, "sumGrossPrice": 10051, "taxRate": "19.00", "unitNetPrice": 0, "sumNetPrice": 0, "unitPrice": 10051, "unitTaxAmountFullAggregation": 1605, "sumTaxAmountFullAggregation": 1605, "refundableAmount": 10051, "canceledAmount": 0, "sumSubtotalAggregation": 10051, "unitSubtotalAggregation": 10051, "unitProductOptionPriceAggregation": 0, "sumProductOptionPriceAggregation": 0, "unitExpensePriceAggregation": 0, "sumExpensePriceAggregation": null, "unitDiscountAmountAggregation": 0, "sumDiscountAmountAggregation": 0, "unitDiscountAmountFullAggregation": 0, "sumDiscountAmountFullAggregation": 0, "unitPriceToPayAggregation": 10051, "sumPriceToPayAggregation": 10051, "taxRateAverageAggregation": "19.00", "taxAmountAfterCancellation": null, "orderReference": null, "uuid": "2b8ded00-2831-5557-83a2-3d29fc7c9ae8", "isReturnable": true, "idShipment": 12, "bundleItemIdentifier": null, "relatedBundleItemIdentifier": null, "productOfferReference": "offer27", "salesOrderConfiguredBundle": null, "salesOrderConfiguredBundleItem": null, "metadata": { "superAttributes": { "color": "Black" }, "image": "https://d2s0ynfc62ej12.cloudfront.net/b2c/21081478-Sony.jpg" }, "salesOrderItemConfiguration": null, "salesUnit": null, "calculatedDiscounts": [], "productOptions": [], "amount": null } ], "expenses": [ { "type": "SHIPMENT_EXPENSE_TYPE", "name": "Next-Day", "sumPrice": 1500, "unitGrossPrice": 1500, "sumGrossPrice": 1500, "taxRate": "19.00", "unitNetPrice": 0, "sumNetPrice": 0, "canceledAmount": null, "unitDiscountAmountAggregation": null, "sumDiscountAmountAggregation": null, "unitTaxAmount": 240, "sumTaxAmount": 240, "unitPriceToPayAggregation": 1500, "sumPriceToPayAggregation": 1500, "taxAmountAfterCancellation": null, "idShipment": 12, "idSalesExpense": 12 }, { "type": "SHIPMENT_EXPENSE_TYPE", "name": "Premium", "sumPrice": 1000, "unitGrossPrice": 1000, "sumGrossPrice": 1000, "taxRate": "19.00", "unitNetPrice": 0, "sumNetPrice": 0, "canceledAmount": null, "unitDiscountAmountAggregation": null, "sumDiscountAmountAggregation": null, "unitTaxAmount": 159, "sumTaxAmount": 159, "unitPriceToPayAggregation": 1000, "sumPriceToPayAggregation": 1000, "taxAmountAfterCancellation": null, "idShipment": 11, "idSalesExpense": 11 } ], "payments": [ { "amount": 43691, "paymentProvider": "DummyMarketplacePayment", "paymentMethod": "Marketplace Invoice" } ], "shipments": [], "calculatedDiscounts": [], "bundleItems": [] }, "links": { "self": "https://glue.mysprykershop.com/orders/DE--6" } } } ```

Response sample: retrieve an with the merchants included

```json { "data": { "type": "orders", "id": "DE--2", "attributes": { "merchantReferences": [ "MER000002", "MER000001" ], "itemStates": [ "new" ], "createdAt": "2020-10-19 15:16:21.879286", "currencyIsoCode": "EUR", "priceMode": "GROSS_MODE", "totals": { "expenseTotal": 1590, "discountTotal": 3959, "taxTotal": 4957, "subtotal": 39586, "grandTotal": 37217, "canceledTotal": 0, "remunerationTotal": 0 }, "billingAddress": { "salutation": "Ms", "firstName": "Sonia", "middleName": null, "lastName": "Wagner", "address1": "Kirncher Str.", "address2": "7", "address3": "", "company": "Acme Corporation", "city": "Berlin", "zipCode": "10247", "poBox": null, "phone": "4902890031", "cellPhone": null, "description": null, "comment": "", "email": null, "country": "Germany", "iso2Code": "DE" }, "shippingAddress": null, "items": [ { "merchantReference": "MER000002", "state": "new", "name": "Toshiba CAMILEO S30", "sku": "205_6350138", "sumPrice": 11611, "quantity": 1, "unitGrossPrice": 11611, "sumGrossPrice": 11611, "taxRate": "7.00", "unitNetPrice": 0, "sumNetPrice": 0, "unitPrice": 11611, "unitTaxAmountFullAggregation": 684, "sumTaxAmountFullAggregation": 684, "refundableAmount": 10450, "canceledAmount": 0, "sumSubtotalAggregation": 11611, "unitSubtotalAggregation": 11611, "unitProductOptionPriceAggregation": 0, "sumProductOptionPriceAggregation": 0, "unitExpensePriceAggregation": 0, "sumExpensePriceAggregation": null, "unitDiscountAmountAggregation": 1161, "sumDiscountAmountAggregation": 1161, "unitDiscountAmountFullAggregation": 1161, "sumDiscountAmountFullAggregation": 1161, "unitPriceToPayAggregation": 10450, "sumPriceToPayAggregation": 10450, "taxRateAverageAggregation": "7.00", "taxAmountAfterCancellation": null, "orderReference": null, "uuid": "d5e948d9-f470-5b9a-b1c7-c1321761312a", "isReturnable": false, "bundleItemIdentifier": null, "relatedBundleItemIdentifier": null, "salesOrderConfiguredBundle": null, "salesOrderConfiguredBundleItem": null, "metadata": { "superAttributes": { "color": "Grey" }, "image": "https://images.icecat.biz/img/gallery_mediums/img_6350138_medium_1481633011_6285_13738.jpg" }, "salesUnit": null, "calculatedDiscounts": [ { "unitAmount": 1161, "sumAmount": 1161, "displayName": "10% Discount for all orders above", "description": "Get a 10% discount on all orders above certain value depending on the currency and net/gross price. This discount is not exclusive and can be combined with other discounts.", "voucherCode": null, "quantity": 1 } ], "productOptions": [], "amount": null }, { "merchantReference": "MER000001", "state": "new", "name": "Samsung Galaxy Note 4", "sku": "061_24752508", "sumPrice": 27975, "quantity": 1, "unitGrossPrice": 27975, "sumGrossPrice": 27975, "taxRate": "19.00", "unitNetPrice": 0, "sumNetPrice": 0, "unitPrice": 27975, "unitTaxAmountFullAggregation": 4020, "sumTaxAmountFullAggregation": 4020, "refundableAmount": 25177, "canceledAmount": 0, "sumSubtotalAggregation": 27975, "unitSubtotalAggregation": 27975, "unitProductOptionPriceAggregation": 0, "sumProductOptionPriceAggregation": 0, "unitExpensePriceAggregation": 0, "sumExpensePriceAggregation": null, "unitDiscountAmountAggregation": 2798, "sumDiscountAmountAggregation": 2798, "unitDiscountAmountFullAggregation": 2798, "sumDiscountAmountFullAggregation": 2798, "unitPriceToPayAggregation": 25177, "sumPriceToPayAggregation": 25177, "taxRateAverageAggregation": "19.00", "taxAmountAfterCancellation": null, "orderReference": null, "uuid": "dedc66da-9af9-504f-bdfc-e45b23118786", "isReturnable": false, "bundleItemIdentifier": null, "relatedBundleItemIdentifier": null, "salesOrderConfiguredBundle": null, "salesOrderConfiguredBundleItem": null, "metadata": { "superAttributes": { "color": "Black" }, "image": "https://images.icecat.biz/img/norm/medium/24752508-8866.jpg" }, "salesUnit": null, "calculatedDiscounts": [ { "unitAmount": 2798, "sumAmount": 2798, "displayName": "10% Discount for all orders above", "description": "Get a 10% discount on all orders above certain value depending on the currency and net/gross price. This discount is not exclusive and can be combined with other discounts.", "voucherCode": null, "quantity": 1 } ], "productOptions": [], "amount": null } ], "expenses": [ { "type": "SHIPMENT_EXPENSE_TYPE", "name": "Express", "sumPrice": 590, "unitGrossPrice": 590, "sumGrossPrice": 590, "taxRate": "19.00", "unitNetPrice": 0, "sumNetPrice": 0, "canceledAmount": null, "unitDiscountAmountAggregation": null, "sumDiscountAmountAggregation": null, "unitTaxAmount": 94, "sumTaxAmount": 94, "unitPriceToPayAggregation": 590, "sumPriceToPayAggregation": 590, "taxAmountAfterCancellation": null }, { "type": "SHIPMENT_EXPENSE_TYPE", "name": "Air Sonic", "sumPrice": 1000, "unitGrossPrice": 1000, "sumGrossPrice": 1000, "taxRate": "19.00", "unitNetPrice": 0, "sumNetPrice": 0, "canceledAmount": null, "unitDiscountAmountAggregation": null, "sumDiscountAmountAggregation": null, "unitTaxAmount": 159, "sumTaxAmount": 159, "unitPriceToPayAggregation": 1000, "sumPriceToPayAggregation": 1000, "taxAmountAfterCancellation": null } ], "payments": [ { "amount": 37217, "paymentProvider": "DummyMarketplacePayment", "paymentMethod": "Marketplace Invoice" } ], "shipments": [], "calculatedDiscounts": { "10% Discount for all orders above": { "unitAmount": null, "sumAmount": 3959, "displayName": "10% Discount for all orders above", "description": "Get a 10% discount on all orders above certain value depending on the currency and net/gross price. This discount is not exclusive and can be combined with other discounts.", "voucherCode": null, "quantity": 2 } }, "bundleItems": [] }, "links": { "self": "https://glue.mysprykershop.com/orders/DE--2?include=merchants" }, "relationships": { "merchants": { "data": [ { "type": "merchants", "id": "MER000002" }, { "type": "merchants", "id": "MER000001" } ] } } }, "included": [ { "type": "merchants", "id": "MER000002", "attributes": { "merchantName": "Video King", "merchantUrl": "/en/merchant/video-king", "contactPersonRole": "Country Manager DE", "contactPersonTitle": "Ms", "contactPersonFirstName": "Martha", "contactPersonLastName": "Farmer", "contactPersonPhone": "+31 123 345 678", "logoUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/videoking-logo.png", "publicEmail": "hi@video-king.nl", "publicPhone": "+31 123 345 777", "description": "Video King is a premium provider of video equipment. In business since 2010, we understand the needs of video professionals and enthusiasts and offer a wide variety of products with competitive prices. ", "bannerUrl": "https://d2s0ynfc62ej12.cloudfront.net/merchant/videoking-banner.png", "deliveryTime": "2-4 days", "latitude": "4.838470", "longitude": "51.558107", "faxNumber": "+31 123 345 733", "legalInformation": { "terms": "

Video King

Gilzeweg 24
4854SG Bavel
NL

Phone: +31 123 45 6789
Email: hi@video-king.nl

Represented by
Managing Director: Max Mustermann
Register Court: Amsterdam
Register Number: 1234.4567

", "dataPrivacy": "Spryker Systems GmbH values the privacy of your personal data." } }, "links": { "self": "https://glue.mysprykershop.com/merchants/MER000001" } } ] } ```

{% include /pbc/all/glue-api-guides/latest/orders-response-attributes.md %} {% include /pbc/all/glue-api-guides/latest/order-shipments-response-attributes.md %} For the attributes of other included resources, see [Retrieving merchants](/docs/pbc/all/merchant-management/latest/marketplace/manage-using-glue-api/glue-api-retrieve-merchants.html).

Glue API: Search by customers as an agent assist

Thu, 14 May 2026 07:50:35 +0000

Search by customers to find out information about them. This endpoint is mostly used by [agent assists](/docs/pbc/all/user-management/latest/base-shop/agent-assist-feature-overview.html) to find out the customer reference needed to [impersonate a customer](/docs/pbc/all/user-management/latest/base-shop/manage-using-glue-api/glue-api-impersonate-customers-as-an-agent-assist.html#impersonate-a-customer). ## Installation For detailed information on the modules that provide the API functionality and related installation instructions, see: - [Install the Agent Assist Glue API](/docs/pbc/all/user-management/latest/base-shop/install-and-upgrade/install-the-agent-assist-glue-api.html) - [Install the Customer Account Management + Agent Assist feature](/docs/pbc/all/customer-relationship-management/latest/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-agent-assist-feature.html) - [Install the Customer Account Management feature](/docs/pbc/all/customer-relationship-management/latest/base-shop/install-and-upgrade/install-features/install-the-customer-account-management-feature.html) ## Search by customers To search by customers, send the request: *** `GET` **/agent-customer-search** *** ### Request | HEADER KEY | TYPE | REQUIRED | DESCRIPTION | | --- | --- | --- | --- | | X-Agent-Authorization | string | ✓ | String containing digits, letters, and symbols that authorize the agent assist. [Authenticate as an agent assist](/docs/pbc/all/identity-access-management/latest/manage-using-glue-api/glue-api-authenticate-as-an-agent-assist.html#authenticate-as-an-agent-assist) to get the value. | | STRING PARAMETER | DESCRIPTION | POSSIBLE VALUES | | --- | --- | --- | | q | The value to search for in the list of customers. If you enter a part of an email address, first name, or last name, the endpoint returns all the customer entries partially matching the search query. To search by a customer reference, enter full customer reference. | {% raw %}{{{% endraw %}customerEmail{% raw %}}}{% endraw %}, {% raw %}{{{% endraw %}firstName{% raw %}}}{% endraw %}, {% raw %}{{{% endraw %}customerReference{% raw %}}}{% endraw %}, {% raw %}{{{% endraw %}lastName{% raw %}}}{% endraw %} | | page[offset] | The offset of the item at which to begin the response.
Works only together with `page[limit]`.
To work correctly, the value should be devisable by the value of `page[limit]`.
The default value is `0`. | From `0` to any. | | page[limit] | The maximum number of entries to return.
Works only together with `page[offset]`.
The default value is `10`. | From `1` to any. | | REQUEST | USAGE | | --- | --- | | `GET http://glue.mysprykershop.com/agent-customer-search` | Return the list of all customers. | | `GET http://glue.mysprykershop.com/agent-customer-search?page[limit]=5&page[offset]=5` | Return a list of 5 customer entries starting from the sixth entry. | | `GET http://glue.mysprykershop.com/agent-customer-search?q=sonia@acme.com` | Search for the customer with the `sonia@acme.com` email address. | | `GET http://glue.mysprykershop.com/agent-customer-search?q=spencor` | Search for the customer with the `spencor` name. | | `GET http://glue.mysprykershop.com/agent-customer-search?q=DE--5` | Search for the customer with the `DE--5` customer reference. | ### Response

Response sample: return the list of all customers

```json { "data": [ { "type": "agent-customer-search", "id": null, "attributes": { "customers": [ { "customerReference": "DE--1", "email": "spencor.hopkin@spryker.com", "firstName": "Spencor", "lastName": "Hopkin" }, { "customerReference": "DE--2", "email": "maria.williams@acme.com", "firstName": "Maria", "lastName": "Williams" }, { "customerReference": "DE--3", "email": "maggie.may@acme.com", "firstName": "Maggie", "lastName": "May" }, { "customerReference": "DE--4", "email": "bill.martin@acme.com", "firstName": "Bill", "lastName": "Martin" }, { "customerReference": "DE--5", "email": "george.freeman@acme.com", "firstName": "George", "lastName": "Freeman" }, { "customerReference": "DE--6", "email": "henry.tudor@acme.com", "firstName": "Henry", "lastName": "Tudor" }, { "customerReference": "DE--7", "email": "anne.boleyn@acme.com", "firstName": "Anne", "lastName": "Boleyn" }, { "customerReference": "DE--8", "email": "andrew@ottom.de", "firstName": "Andrew", "lastName": "Wedner" }, { "customerReference": "DE--9", "email": "Ahill@ottom.de", "firstName": "Ahill", "lastName": "Grant" }, { "customerReference": "DE--10", "email": "Alexa@ottom.de", "firstName": "Alexa", "lastName": "Simons" } ] }, "links": { "self": "http://glue.mysprykershop.com/agent-customer-search" } } ], "links": { "self": "http://glue.mysprykershop.com/agent-customer-search", "last": "http://glue.mysprykershop.com/agent-customer-search?page[offset]=20&page[limit]=10", "first": "http://glue.mysprykershop.com/agent-customer-search?page[offset]=0&page[limit]=10", "next": "http://glue.mysprykershop.com/agent-customer-search?page[offset]=10&page[limit]=10" } } ```

Response sample: search for a customer with page limit and page offset

```json { "data": [ { "type": "agent-customer-search", "id": null, "attributes": { "customers": [ { "customerReference": "DE--6", "email": "henry.tudor@acme.com", "firstName": "Henry", "lastName": "Tudor" }, { "customerReference": "DE--7", "email": "anne.boleyn@acme.com", "firstName": "Anne", "lastName": "Boleyn" }, { "customerReference": "DE--8", "email": "andrew@ottom.de", "firstName": "Andrew", "lastName": "Wedner" }, { "customerReference": "DE--9", "email": "Ahill@ottom.de", "firstName": "Ahill", "lastName": "Grant" }, { "customerReference": "DE--10", "email": "Alexa@ottom.de", "firstName": "Alexa", "lastName": "Simons" } ] }, "links": { "self": "http://glue.mysprykershop.com/agent-customer-search?page[offset]=5&page[limit]=5" } } ], "links": { "self": "http://glue.mysprykershop.com/agent-customer-search?page[offset]=5&page[limit]=5", "last": "http://glue.mysprykershop.com/agent-customer-search?page[offset]=25&page[limit]=5", "first": "http://glue.mysprykershop.com/agent-customer-search?page[offset]=0&page[limit]=5", "prev": "http://glue.mysprykershop.com/agent-customer-search?page[offset]=0&page[limit]=5", "next": "http://glue.mysprykershop.com/agent-customer-search?page[offset]=10&page[limit]=5" } } ```

Response sample: search for a customer by email address

```json { "data": [ { "type": "agent-customer-search", "id": null, "attributes": { "customers": [ { "customerReference": "DE--21", "email": "sonia@acme.com", "firstName": "Sonia", "lastName": "Wagner" } ] }, "links": { "self": "http://glue.mysprykershop.com/agent-customer-search?q=sonia@acme.com" } } ], "links": { "self": "http://glue.mysprykershop.com/agent-customer-search?q=sonia@acme.com", "last": "http://glue.mysprykershop.com/agent-customer-search?q=sonia@acme.com&page[offset]=0&page[limit]=10", "first": "http://glue.mysprykershop.com/agent-customer-search?q=sonia@acme.com&page[offset]=0&page[limit]=10" } } ```

Response sample: search for a customer by name

```json { "data": [ { "type": "agent-customer-search", "id": null, "attributes": { "customers": [ { "customerReference": "DE--1", "email": "spencor.hopkin@spryker.com", "firstName": "Spencor", "lastName": "Hopkin" } ] }, "links": { "self": "http://glue.mysprykershop.com/agent-customer-search?q=spencor" } } ], "links": { "self": "http://glue.mysprykershop.com/agent-customer-search?q=spencor", "last": "http://glue.mysprykershop.com/agent-customer-search?q=spencor&page[offset]=0&page[limit]=10", "first": "http://glue.mysprykershop.com/agent-customer-search?q=spencor&page[offset]=0&page[limit]=10" } } ```

Response sample: search for a customer by customer reference

```json { "data": [ { "type": "agent-customer-search", "id": null, "attributes": { "customers": [ { "customerReference": "DE--5", "email": "george.freeman@acme.com", "firstName": "George", "lastName": "Freeman" } ] }, "links": { "self": "http://glue.mysprykershop.com/agent-customer-search?q=de--5" } } ], "links": { "self": "http://glue.mysprykershop.com/agent-customer-search?q=de--5", "last": "http://glue.mysprykershop.com/agent-customer-search?q=de--5&page[offset]=0&page[limit]=10", "first": "http://glue.mysprykershop.com/agent-customer-search?q=de--5&page[offset]=0&page[limit]=10" } } ```

| ATTRIBUTE | TYPE | DESCRIPTION | | --- | --- | --- | | customerReference | string | Unique customer identifier. | | email | string | Email address of the customer. | | firstName | string | First name of the customer. | | lastName | string | Last name of the customer. | ## Possible errors | CODE | REASON | | --- | --- | | 001 | Access token is invalid.| | 4103 | Agent access token is missing; or the action is available to an agent user only.| To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/integrations/spryker-glue-api/storefront-api/api-references/reference-information-storefront-application-errors.html). ## Next steps After you've found the reference of the customer you want to assist, impersonate the customer to perform any actions available to them. See [Impersonate customers as an agent assist](/docs/pbc/all/user-management/latest/base-shop/manage-using-glue-api/glue-api-impersonate-customers-as-an-agent-assist.html) for details.

Set up Keycloak for local development

Thu, 14 May 2026 07:42:41 +0000

This guide sets up a local Keycloak instance alongside your Spryker Docker environment. Keycloak runs as an additional Docker service, is backed by the existing MariaDB instance, and is automatically provisioned with a realm, three OAuth2 clients, and test users on first boot — no manual UI configuration required. This is a local development setup only. For production IdP configuration, refer to your IdP's documentation. ## Prerequisites - A working local Spryker Docker environment booted with `docker/sdk boot deploy.dev.yml` --- ## Step 1 — Add the Keycloak service Docker SDK supports merging additional Compose files into the main stack. Create `keycloak-docker-compose.yml` in the project root with the Keycloak service and a database initializer: **`keycloak-docker-compose.yml`** ```yaml services: keycloak-db-init: image: mariadb:11.8 command: - sh - -c - | until mariadb -h database -u root -psecret -e 'SELECT 1' 2>/dev/null; do echo 'Waiting for database...' sleep 2 done mariadb -h database -u root -psecret -e " CREATE DATABASE IF NOT EXISTS keycloak CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci; DROP USER IF EXISTS 'keycloak'@'%'; CREATE USER 'keycloak'@'%' IDENTIFIED BY 'keycloak-secret'; GRANT ALL PRIVILEGES ON keycloak.* TO 'keycloak'@'%'; FLUSH PRIVILEGES; " echo 'Keycloak database and user ready.' sleep infinity healthcheck: test: ["CMD-SHELL", "mariadb -h database -u keycloak -pkeycloak-secret -e 'USE keycloak'"] interval: 5s timeout: 5s retries: 10 networks: - private keycloak: image: quay.io/keycloak/keycloak:25.0 depends_on: keycloak-db-init: condition: service_healthy environment: KC_DB: mariadb KC_DB_URL: jdbc:mariadb://database:3306/keycloak KC_DB_USERNAME: keycloak KC_DB_PASSWORD: keycloak-secret KEYCLOAK_ADMIN: admin KEYCLOAK_ADMIN_PASSWORD: admin KC_HTTP_PORT: 28080 KC_HOSTNAME_STRICT: false KC_HTTP_ENABLED: true command: start-dev --import-realm ports: - "28080:28080" volumes: - ./data/keycloak:/opt/keycloak/data/import networks: public: aliases: - keycloak.spryker.local private: aliases: - keycloak.spryker.local ``` The `keycloak-db-init` service waits for the shared MariaDB to be available, then creates a dedicated `keycloak` database and user. The `keycloak` service depends on it being healthy before starting. The `--import-realm` flag tells Keycloak to import any JSON files found in `/opt/keycloak/data/import` on startup. The `./data/keycloak` directory is mounted there — this is where the realm configuration lives (see step 3). --- ## Step 2 — Hook into deploy.dev.yml Tell Docker SDK to merge your custom Compose file into the stack by adding the following to `deploy.dev.yml`: **`deploy.dev.yml`** ```yaml docker: compose: yamls: - keycloak-docker-compose.yml ``` Docker SDK merges this file with the generated one during `docker/sdk boot`, so the Keycloak service starts alongside the rest of the stack. --- ## Step 3 — Configure the realm Create the realm configuration file that Keycloak imports on first boot. This file defines the realm settings, one OAuth2 client per Spryker application, and test users. **`data/keycloak/spryker-realm.json`** ```json { "realm": "spryker", "enabled": true, "sslRequired": "none", "registrationAllowed": false, "loginWithEmailAllowed": true, "duplicateEmailsAllowed": false, "resetPasswordAllowed": true, "editUsernameAllowed": false, "bruteForceProtected": true, "roles": { "realm": [ { "name": "user", "description": "Standard user privileges" }, { "name": "admin", "description": "Administrator privileges" } ] }, "defaultRoles": ["user"], "users": [ { "username": "admin@spryker.local", "email": "admin@spryker.local", "firstName": "Admin", "lastName": "Spryker", "enabled": true, "emailVerified": true, "credentials": [{ "type": "password", "value": "change123" }], "realmRoles": ["user"] }, { "username": "sonia@acme.com", "email": "sonia@acme.com", "firstName": "Sonia", "lastName": "Wagner", "enabled": true, "emailVerified": true, "credentials": [{ "type": "password", "value": "change123" }], "realmRoles": ["user", "admin"] }, { "username": "herald@spryker.com", "email": "herald@spryker.com", "firstName": "Harald", "lastName": "Schmidt", "enabled": true, "emailVerified": true, "credentials": [{ "type": "password", "value": "change123" }], "realmRoles": ["user", "admin"] } ], "clients": [ { "clientId": "spryker-yves", "name": "Spryker Yves Storefront", "description": "OAuth2 client for Yves storefront authentication", "enabled": true, "clientAuthenticatorType": "client-secret", "secret": "spryker-yves-secret", "publicClient": false, "protocol": "openid-connect", "standardFlowEnabled": true, "implicitFlowEnabled": false, "directAccessGrantsEnabled": false, "serviceAccountsEnabled": false, "redirectUris": ["http://yves.eu.spryker.local/*"], "webOrigins": ["http://yves.eu.spryker.local"], "defaultClientScopes": ["openid", "profile", "email"] }, { "clientId": "spryker-zed", "name": "Spryker Zed Backoffice", "description": "OAuth2 client for Zed backoffice authentication", "enabled": true, "clientAuthenticatorType": "client-secret", "secret": "spryker-zed-secret", "publicClient": false, "protocol": "openid-connect", "standardFlowEnabled": true, "implicitFlowEnabled": false, "directAccessGrantsEnabled": true, "serviceAccountsEnabled": false, "redirectUris": [ "http://backoffice.eu.spryker.local/*", "http://zed.eu.spryker.local/*" ], "webOrigins": [ "http://backoffice.eu.spryker.local", "http://zed.eu.spryker.local" ], "defaultClientScopes": ["openid", "profile", "email"] }, { "clientId": "spryker-merchant-portal", "name": "Spryker Merchant Portal", "description": "OAuth2 client for Merchant Portal authentication", "enabled": true, "clientAuthenticatorType": "client-secret", "secret": "spryker-merchant-portal-secret", "publicClient": false, "protocol": "openid-connect", "standardFlowEnabled": true, "implicitFlowEnabled": false, "directAccessGrantsEnabled": false, "serviceAccountsEnabled": false, "redirectUris": ["http://mp.eu.spryker.local/*"], "webOrigins": ["http://mp.eu.spryker.local"], "defaultClientScopes": ["openid", "profile", "email"] } ] } ``` ### What this configures **Realm** — a `spryker` realm with brute-force protection enabled and self-registration disabled. **Clients** — one per application, all using the Authorization Code flow (`standardFlowEnabled: true`) with a confidential client secret: | Client ID | Surface | Secret | |---|---|---| | `spryker-yves` | Storefront | `spryker-yves-secret` | | `spryker-zed` | Back-office | `spryker-zed-secret` | | `spryker-merchant-portal` | Merchant Portal | `spryker-merchant-portal-secret` | The `defaultClientScopes: ["openid", "profile", "email"]` ensures Keycloak returns the `email`, `given_name`, and `family_name` claims that Spryker requires. No additional claim mapping is needed. **Test users** — three pre-configured users, all with password `change123`: | Name | Email | Use for | |---|---|---| | Sonia Wagner | `sonia@acme.com` | Storefront login | | Admin Spryker | `admin@spryker.local` | Back-office login | | Harald Schmidt | `herald@spryker.com` | Merchant Portal login | Make sure the email address of the Merchant Portal test user exists in Spryker's database before testing. Storefront and Back-office users are created automatically on first SSO login. --- ## Step 4 — Set environment variables Add the following to the `image.environment` section of `deploy.dev.yml`. The client names (`SSO_YVES`, `SSO_ZED`, `SSO_MP`) follow the `SPRYKER_OAUTH_{CLIENT_NAME}_{FIELD}` convention described in [Add an OAuth provider](/docs/pbc/all/oauth/latest/install-and-upgrade/add-an-oauth-provider.html). **`deploy.dev.yml`** ```yaml image: environment: SPRYKER_OAUTH_SSO_YVES_BASE_URL: 'http://keycloak.spryker.local:28080' SPRYKER_OAUTH_SSO_YVES_REALM: 'spryker' SPRYKER_OAUTH_SSO_YVES_CLIENT_ID: 'spryker-yves' SPRYKER_OAUTH_SSO_YVES_CLIENT_SECRET: 'spryker-yves-secret' SPRYKER_OAUTH_REDIRECT_URI_YVES: 'http://yves.eu.spryker.local/login/oauth-callback' SPRYKER_OAUTH_SSO_ZED_BASE_URL: 'http://keycloak.spryker.local:28080' SPRYKER_OAUTH_SSO_ZED_REALM: 'spryker' SPRYKER_OAUTH_SSO_ZED_CLIENT_ID: 'spryker-zed' SPRYKER_OAUTH_SSO_ZED_CLIENT_SECRET: 'spryker-zed-secret' SPRYKER_OAUTH_REDIRECT_URI_ZED: 'http://backoffice.eu.spryker.local/security-oauth-user/login' SPRYKER_OAUTH_SSO_MP_BASE_URL: 'http://keycloak.spryker.local:28080' SPRYKER_OAUTH_SSO_MP_REALM: 'spryker' SPRYKER_OAUTH_SSO_MP_CLIENT_ID: 'spryker-merchant-portal' SPRYKER_OAUTH_SSO_MP_CLIENT_SECRET: 'spryker-merchant-portal-secret' SPRYKER_OAUTH_REDIRECT_URI_MERCHANT_PORTAL: 'http://mp.eu.spryker.local/security-merchant-portal-gui/oauth-login' ``` These values must match the client IDs, secrets, and redirect URIs defined in `spryker-realm.json`. {% info_block warningBox "Cloud environments" %} For non-local environments, do not add secrets to `deploy.*.yml`. Store them in your secure secrets manager instead — for example, AWS Parameter Store provided by your Spryker cloud environment. {% endinfo_block %} --- ## Verification 1. Boot the stack: ```bash docker/sdk boot deploy.dev.yml docker/sdk up ``` 2. Confirm Keycloak is running by opening `http://keycloak.spryker.local:28080`. Log in with `admin` / `admin` and verify the `spryker` realm and its three clients exist. 3. Test each application: | Surface | URL | Test user | |---|---|---| | Storefront | `http://yves.eu.spryker.local/login` | Sonia Wagner — `sonia@acme.com` | | Back-office | `http://backoffice.eu.spryker.local/security-gui/login` | Admin Spryker — `admin@spryker.local` | | Merchant Portal | `http://mp.eu.spryker.local/security-merchant-portal-gui/login` | Harald Schmidt — `herald@spryker.com` | On each login page, click the SSO button, authenticate with the test user credentials (`change123`), and confirm you are redirected back and logged in. For troubleshooting Keycloak-specific issues, refer to the [Keycloak documentation](https://www.keycloak.org/documentation).

Retrieve subscriptions to availability notifications

Thu, 14 May 2026 07:42:41 +0000

This endpoint allows retrieving subscriptions to availability notifications of a registered customer. ## Installation For detailed information on the modules that provide the API functionality and related installation instructions, see [Install the Availability Notification Glue API](/docs/pbc/all/warehouse-management-system/latest/base-shop/install-and-upgrade/install-features/install-the-availability-notification-glue-api.html). ## Retrieve subscriptions to availability notifications To retrieve subscriptions to availability notifications, send the request: --- `GET` **/my-availability-notifications/** --- ### Request | HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | |-|-|-|-| | Authorization | string | ✓ | Alphanumeric string that authorizes the customer or company user to send requests to protected resources. Get it by authenticating as a customer. | Request sample: retrieve subscriptions to availability notifications `GET https://glue.mysprykershop.com/my-availability-notifications` ### Response

Response sample: retrieve subscriptions to availability notifications

```json { "data": [ { "type": "availability-notifications", "id": "05f2004950e01a056537384a405ec9a0", "attributes": { "localeName": "en_US", "email": "sonia@acme.com", "sku": "213_123" }, "links": { "self": "https://glue.69.demo-spryker.com:80/availability-notifications/05f2004950e01a056537384a405ec9a0" } }, { "type": "availability-notifications", "id": "0fdc733c5d91ef9645e5a9b7114b37d8", "attributes": { "localeName": "en_US", "email": "sonia@acme.com", "sku": "190_25111746" }, "links": { "self": "https://glue.69.demo-spryker.com:80/availability-notifications/0fdc733c5d91ef9645e5a9b7114b37d8" } } ], "links": [] } ```

## Other management options There is an alternative way to retrieve subscriptions to availability notifications of a registered customer. For details, see [Managing customers](/docs/pbc/all/identity-access-management/latest/manage-using-glue-api/glue-api-create-customers.html#create-a-customer). ## Possible errors | CODE | REASON | |-|-| | 001 | Access token is invalid. | | 002 | Access token is missing. | To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/integrations/spryker-glue-api/storefront-api/api-references/reference-information-storefront-application-errors.html).

Retrieve subscriptions to availability notifications

Thu, 14 May 2026 07:42:41 +0000

Response sample: retrieve subscriptions to availability notifications

Glue API: Retrieve shipments when checking out purchases

Thu, 14 May 2026 07:42:41 +0000

This document describes how to retrieve order shipments when checking out through the Glue API. For full information about the endpoint, see [Check out purchases](/docs/pbc/all/cart-and-checkout/latest/base-shop/manage-using-glue-api/check-out/glue-api-check-out-purchases.html) This endpoint allows finalizing the checkout process by placing an order. After sending a request, the cart is deleted, and you cannot make any changes in the checkout data. Use this endpoint for checkouts that can be performed in one pass or for finalizing a checkout after [Submit checkout data](/docs/pbc/all/cart-and-checkout/latest/base-shop/manage-using-glue-api/check-out/glue-api-submit-checkout-data.html). ## Installation For detailed information on the modules that provide the API functionality and related installation instructions, see: - [Install the Checkout Glue API](/docs/pbc/all/order-management-system/latest/base-shop/install-and-upgrade/install-glue-api/install-the-checkout-glue-api.html) - [Install the Shipment Glue API](/docs/pbc/all/carrier-management/latest/base-shop/install-and-upgrade/install-the-shipment-glue-api.html) ## Place an order To place an order, send the request: *** `POST` **/checkout** *** ### Request {% info_block warningBox "Cart deletion" %} By default, if checkout is successful, the order is placed, and the cart is deleted automatically. {% endinfo_block %} | HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | | --- | --- | --- | --- | | X-Anonymous-Customer-Unique-Id | String | Required when checking out a [guest cart](/docs/pbc/all/cart-and-checkout/latest/base-shop/manage-using-glue-api/manage-guest-carts/glue-api-manage-guest-carts.html). | A guest user's unique identifier. For security purposes, we recommend passing a hyphenated alphanumeric value, but you can pass any. If you are sending automated requests, you can configure your API client to generate this value. | | Authorization | String | Required when checking out a [cart of registered user](/docs/pbc/all/cart-and-checkout/latest/base-shop/manage-using-glue-api/manage-carts-of-registered-users/glue-api-manage-items-in-carts-of-registered-users.html). | An alphanumeric string that authorizes the customer to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/latest/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | | QUERY PARAMETER | DESCRIPTION | POSSIBLE VALUES | | --- | --- | --- | | include | Adds resource relationships to the request. | orders, order-shipments | {% info_block infoBox "Included resources" %} To retrieve order shipments, include `orders` and `order-shipments`. {% endinfo_block %}

Request sample: check out with one shipment, order information, and shipment information

`POST https://glue.mysprykershop.com/checkout?include=orders,order-shipments` ```json { "data": { "type": "checkout", "attributes": { "customer": { "salutation": "Mr", "email": "sonia@acme.com", "firstName": "Sonia", "lastName": "Wagner" }, "idCart": "fe660d66-b7ec-5d88-8cd2-1a9a004c90b5", "billingAddress": { "salutation": "Mr", "firstName": "Spencor", "lastName": "Hopkin", "address1": "Julie-Wolfthorn-Strasse", "address2": "1", "address3": "new address", "zipCode": "10115", "city": "Berlin", "iso2Code": "DE", "company": "spryker", "phone": "+49 (30) 2084 98350" }, "payments": [ { "dummyPaymentInvoice": { "dateOfBirth": "08.04.1986" }, "paymentMethodName": "Invoice", "paymentProviderName": "DummyPayment" } ], "shipments": [ { "items": [ "066_23294028" ], "shippingAddress": { "salutation": "Mrs", "firstName": "Sonia", "lastName": "Wagner", "address1": "Julie-Wolfthorn-Strasse", "address2": "1", "address3": "new one", "zipCode": "10115", "city": "Berlin", "iso2Code": "DE", "company": "spryker", "phone": "+49 (30) 2084 98350" }, "idShipmentMethod": 2, "requestedDeliveryDate": "2021-09-29" } ] } } } ```

{% include pbc/all/glue-api-guides/latest/checkout-request-attributes.md %} ### Response

Response sample: check out with a split shipment, order information, and shipment information

```json { "data": { "type": "checkout", "id": null, "attributes": { "orderReference": "DE--10", "redirectUrl": null, "isExternalRedirect": null }, "links": { "self": "https://glue.mysprykershop.com/checkout?include=orders,order-shipments" }, "relationships": { "orders": { "data": [ { "type": "orders", "id": "DE--10" } ] } } }, "included": [ { "type": "order-shipments", "id": "18", "attributes": { "itemUuids": [ "34d4ea2b-7327-5fe3-843f-ca7e27fa1e81" ], "methodName": "Express", "carrierName": "Spryker Dummy Shipment", "requestedDeliveryDate": "2021-09-29", "shippingAddress": { "salutation": "Mrs", "firstName": "Sonia", "middleName": null, "lastName": "Wagner", "address1": "Julie-Wolfthorn-Strasse", "address2": "1", "address3": "new one", "company": "spryker", "city": "Berlin", "zipCode": "10115", "poBox": null, "phone": "+49 (30) 2084 98350", "cellPhone": null, "description": null, "comment": null, "email": null, "country": "Germany", "iso2Code": "DE" } }, "links": { "self": "https://glue.mysprykershop.com/order-shipments/18" } }, { "type": "orders", "id": "DE--10", "attributes": { "merchantReferences": [], "itemStates": [ "payment pending" ], "createdAt": "2021-01-18 13:07:24.000000", "currencyIsoCode": "EUR", "priceMode": "GROSS_MODE", "totals": { "expenseTotal": 590, "discountTotal": 0, "taxTotal": 6377, "subtotal": 39353, "grandTotal": 39943, "canceledTotal": 0, "remunerationTotal": 0 }, "billingAddress": { "salutation": "Mr", "firstName": "Sonia", "middleName": null, "lastName": "Wagner", "address1": "Julie-Wolfthorn-Strasse", "address2": "1", "address3": "new address", "company": "spryker", "city": "Berlin", "zipCode": "10115", "poBox": null, "phone": "+49 (30) 2084 98350", "cellPhone": null, "description": null, "comment": null, "email": null, "country": "Germany", "iso2Code": "DE" }, "shippingAddress": null, "items": [ { "merchantReference": null, "state": "payment pending", "name": "Samsung Galaxy S5 mini", "sku": "066_23294028", "sumPrice": 39353, "quantity": 1, "unitGrossPrice": 39353, "sumGrossPrice": 39353, "taxRate": "19.00", "unitNetPrice": 0, "sumNetPrice": 0, "unitPrice": 39353, "unitTaxAmountFullAggregation": 6283, "sumTaxAmountFullAggregation": 6283, "refundableAmount": 39353, "canceledAmount": 0, "sumSubtotalAggregation": 39353, "unitSubtotalAggregation": 39353, "unitProductOptionPriceAggregation": 0, "sumProductOptionPriceAggregation": 0, "unitExpensePriceAggregation": 0, "sumExpensePriceAggregation": null, "unitDiscountAmountAggregation": 0, "sumDiscountAmountAggregation": 0, "unitDiscountAmountFullAggregation": 0, "sumDiscountAmountFullAggregation": 0, "unitPriceToPayAggregation": 39353, "sumPriceToPayAggregation": 39353, "taxRateAverageAggregation": "19.00", "taxAmountAfterCancellation": null, "orderReference": null, "uuid": "34d4ea2b-7327-5fe3-843f-ca7e27fa1e81", "isReturnable": false, "idShipment": 18, "bundleItemIdentifier": null, "relatedBundleItemIdentifier": null, "salesOrderConfiguredBundle": null, "salesOrderConfiguredBundleItem": null, "metadata": { "superAttributes": { "color": "Blue" }, "image": "https://images.icecat.biz/img/gallery_mediums/23294028_3275.jpg" }, "salesUnit": null, "calculatedDiscounts": [], "productOptions": [], "amount": null } ], "expenses": [ { "type": "SHIPMENT_EXPENSE_TYPE", "name": "Express", "sumPrice": 590, "unitGrossPrice": 590, "sumGrossPrice": 590, "taxRate": "19.00", "unitNetPrice": 0, "sumNetPrice": 0, "canceledAmount": null, "unitDiscountAmountAggregation": null, "sumDiscountAmountAggregation": null, "unitTaxAmount": 94, "sumTaxAmount": 94, "unitPriceToPayAggregation": 590, "sumPriceToPayAggregation": 590, "taxAmountAfterCancellation": null, "idShipment": 18, "idSalesExpense": 18 } ], "payments": [ { "amount": 39943, "paymentProvider": "DummyPayment", "paymentMethod": "Invoice" } ], "shipments": [ { "shipmentMethodName": "Express", "carrierName": "Spryker Dummy Shipment", "deliveryTime": null, "defaultGrossPrice": 590, "defaultNetPrice": 0, "currencyIsoCode": "EUR" } ], "calculatedDiscounts": [], "bundleItems": [] }, "links": { "self": "https://glue.mysprykershop.com/orders/DE--10" }, "relationships": { "order-shipments": { "data": [ { "type": "order-shipments", "id": "18" } ] } } } ] } ```

| ATTRIBUTE | TYPE | DESCRIPTION | | --- | --- | --- | | orderReference | String | The unique identifier of the order. | | redirectUrl | String | The URL to perform the payment verification requested by the selected payment method. After completing verification, ensure to [update payment data](/docs/pbc/all/cart-and-checkout/latest/base-shop/manage-using-glue-api/check-out/glue-api-update-payment-data.html#update-payment-data). If the value is `null` or empty, no additional verification is required. | | isExternalRedirect | Boolean | If true, the customer is redirected to an external URL. | {% include pbc/all/glue-api-guides/latest/order-shipments-response-attributes.md %} {% include pbc/all/glue-api-guides/latest/orders-response-attributes.md %} ## Possible errors | STATUS | REASONS | | --- | --- | | 400 | Bad request. This error can occur because of the following reasons:

The POST data is incorrect;
Neither **Authorization** nor **X-Anonymous-Customer-Unique-Id** headers were provided in the request.

| | 404 | Order not found. | | 422 | Order payment is not updated. Checkout data is incorrect. | | 1101 | Checkout data is invalid. | | 1102 | Order cannot be placed. | | 1103 | Cart not found. | | 1104 | Cart is empty. | | 1105 | One of Authorization or X-Anonymous-Customer-Unique-Id headers is required. | | 1106 | Unable to delete cart. | | 1107 | Multiple payments are not allowed. | | 1108 | Payment method "%s" of payment provider "%s" is invalid. |

Glue API: Manage customers

Thu, 14 May 2026 07:42:41 +0000

The Customer API allows creating customers and manage their account data. This includes the possibility to maintain a set of customer addresses as separate resources. In the checkout process, you can retrieve and use these address resources to speed up the buying process. The API supports authentication via OAuth 2.0 and password restoration. In your development, these resources can help you: - Retrieve relevant customer information. for any page where it's needed. - Retrieve customer subscriptions to availability notifications. - Enable customer registration. - Allow customer login and authentication. - Enrich customer profiles with additional data such as addresses. ## Installation For details on the modules that provide the API functionality and how to install them, see [Glue API: Customer Access Feature Integration](/docs/pbc/all/identity-access-management/latest/install-and-upgrade/install-the-customer-account-management-glue-api.html). ## Retrieve customers To retrieve customers, send the request: *** `GET` **/customers/** *** ### Request | HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | | --- | --- | --- | --- | | Authorization | string | ✓ | Alphanumeric string that authorizes the customer to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/latest/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | Request sample: retrieve customers `GET https://glue.mysprykershop.com/customers` ### Response

Response sample: retrieve customers

```json { "data": [ { "type": "customers", "id": "DE--21", "attributes": { "firstName": "Sonia", "lastName": "Wagner", "email": "sonia@acme.com", "gender": "Female", "dateOfBirth": null, "salutation": "Ms", "createdAt": "2020-10-07 07:02:32.683823", "updatedAt": "2020-10-07 07:02:32.683823" }, "links": { "self": "https://glue.mysprykershop.com/customers/DE--21" } } ], "links": { "self": "http://glue.mysprykershop.com/customers" } } ```

{% include /pbc/all/glue-api-guides/latest/customers-response-attributes.md %} ## Retrieve a customer To retrieve information about a customer, send the request: --- `GET` **/customers/*{% raw %}{{{% endraw %}customerReference{% raw %}}}{% endraw %}*** --- | PATH PARAMETER| DESCRIPTION | | --- | --- | | ***{% raw %}{{{% endraw %}customerReference{% raw %}}}{% endraw %}*** | Unique identifier of the customer to get information for. This parameter is returned as the `id` attribute when [creating a customer](/docs/pbc/all/identity-access-management/latest/manage-using-glue-api/glue-api-create-customers.html#create-a-customer). | ### Request | HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | | --- | --- | --- | --- | | Authorization | string | ✓ | Alphanumeric string that authorizes the customer to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/latest/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | Request sample: Retrieve a customer `GET http://glue.mysprykershop.com/customers/DE-25` ### Response

Response sample: retrieve a customer

```json { "data": { "type": "customers", "id": "DE--25", "attributes": { "firstName": "John", "lastName": "Doe", "gender": null, "dateOfBirth": null, "salutation": "Mr", "createdAt": "2018-11-06 08:15:02.694668", "updatedAt": "2018-11-06 08:15:02.694668" }, "links": { "self": "http://glue.mysprykershop.com/customers/DE--25" } } } ```

{% include /pbc/all/glue-api-guides/latest/customers-response-attributes.md %} ## Edit a customer To edit a customer account, send the request: --- `PATCH` **/customers/*{% raw %}{{{% endraw %}customerReference{% raw %}}}{% endraw %}*** --- | PATH PARAMETER | DESCRIPTION | | --- | --- | | ***{% raw %}{{{% endraw %}customerReference{% raw %}}}{% endraw %}*** | Unique identifier of the customer to edit. This parameter is returned as the `id` attribute when [creating a customer](/docs/pbc/all/identity-access-management/latest/manage-using-glue-api/glue-api-create-customers.html#create-a-customer). If you've already created a customer, [retrieve customers](#retrieve-customers) to get it. | ### Request | HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | | --- | --- | --- | --- | | Authorization | string | ✓ | Alphanumeric string that authorizes the customer which you want to edit. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/latest/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | Request sample: edit a customer `PATCH http://glue.mysprykershop.com/customers/DE-25` ```json { "data" : { "type": "customers" "attributes": { "lastName": "Johnson", "email": "sonia@acme.com", } } } ``` ### Response

Response sample: edit a customer

```json { "data": { "type": "customers", "id": "DE--25", "attributes": { "firstName": null, "lastName": "Johnson", "salutation": null, "email": "sonia@acme.com" }, "links": { "self": "http://mysprykershop.com/customers/DE--25" } } } ```

{% include /pbc/all/glue-api-guides/latest/customers-response-attributes.md %} ## Anonymize a customer To anonymize a customer, send the request: --- `DELETE` **/customers/*{% raw %}{{{% endraw %}customerReference{% raw %}}}{% endraw %}*** --- | PATH PARAMETER | DESCRIPTION | | --- | --- | | ***{% raw %}{{{% endraw %}customerReference{% raw %}}}{% endraw %}*** | Unique identifier of the customer to anonimyze. This parameter is returned as the `id` attribute when [creating a customer](/docs/pbc/all/identity-access-management/latest/manage-using-glue-api/glue-api-create-customers.html#create-a-customer). If you've already created a customer, [retrieve customers](#retrieve-customers) to get it. | ### Request | HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | | --- | --- | --- | --- | | Authorization | string | ✓ | Alphanumeric string that authorizes the customer which you want to anonymize. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/latest/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | Request sample: anonymize a customer `DELETE http://mysprykershop.com/customers/DE-25` ### Response If the customer is anonymized successfully, the endpoint returns the `204 No Content` status code. ## Retrieve subscriptions to availability notifications To retrieve subscriptions to availability notifications, send the request: --- `GET` **/customers/*{% raw %}{{{% endraw %}customerReference{% raw %}}}{% endraw %}*/availability-notifications** --- | PATH PARAMETER | DESCRIPTION | |-|-| | ***{% raw %}{{{% endraw %}customerReference{% raw %}}}{% endraw %}*** | Unique identifier of the customer to retrieve the subscriptions of. This parameter is returned as the id attribute when creating a customer or retrieving a customer. | | HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | |-|-|-|-| | Authorization | string | ✓ | Alphanumeric string that authorizes the customer or company user to send requests to protected resources. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/latest/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | ### Request Request sample: retrieve subscriptions to availability notifications `GET https://glue.mysprykershop.com/customers/DE--21/availability-notifications` ### Response

Response sample: retrieve subscriptions to availability notifications

```json { "data": [ { "type": "availability-notifications", "id": "d634981b8d1930f7db6e2780b7d5600a", "attributes": { "localeName": "en_US", "email": "sonia@acme.com", "sku": "190_25111746" }, "links": { "self": "https://glue.69.demo-spryker.com:80/availability-notifications/d634981b8d1930f7db6e2780b7d5600a" } } ], "links": { "self": "https://glue.69.demo-spryker.com:80/customers/DE--21/availability-notifications" } } ```

| ATTRIBUTE | TYPE | DESCRIPTION | |-|-|-| | localeName | string | Locale of the subscribed customer. | | email | string | Customer email where the product availability email notifications are sent to. | | sku | string | SKU of the product the user receives notifications about. | ## Other management options There is an alternative way to retrieve existing subscriptions, for details see [Retrieve subscriptions to availability notifications](/docs/pbc/all/warehouse-management-system/latest/base-shop/manage-using-glue-api/glue-api-retrieve-subscriptions-to-availability-notifications.html). ## Possible errors | CODE | REASON | | --- | --- | | 001 | Access token is invalid. | | 002 | Access token is missing. | | 400 | Customer with the same email address already exists. | | 402 | Customer with the specified ID was not found. | | 405 | Customer reference is missing. | | 406 | New password and password confirmation do not match. | | 410 | Failed to save changes. | | 414 | Provided gender is invalid. | | 420 | The password character set is invalid. | | 422 | `newPassword` and `confirmPassword` values are not identic. | | 802 | Request is unauthorized. | | 901 | Indicates one of the following reasons:

Terms of service were not accepted. Note that if you don't have the [REST Request Format](/docs/integrations/spryker-glue-api/storefront-api/developing-apis/validate-rest-request-format.html) validation enabled, then you will recieve the `422` status code instead of the `901` error code.
`newPassword` and `confirmPassword` are not specified.
Password length is invalid (it should be from 8 to 64 characters).

| | 4606 | Request is unauthorized.| To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/integrations/spryker-glue-api/storefront-api/api-references/reference-information-storefront-application-errors.html). ## Next steps - [Authenticate as a customer](/docs/pbc/all/identity-access-management/latest/manage-using-glue-api/glue-api-manage-customer-passwords.html) - [Manage customer passwords](/docs/pbc/all/identity-access-management/latest/manage-using-glue-api/glue-api-manage-customer-passwords.html)

Glue API: Manage customer passwords

Thu, 14 May 2026 07:42:41 +0000

The endpoints in this document allows you to manage customer passwords. You can change or reset a password. ## Installation For details on the modules that provide the API functionality and how to install them, see [Glue API: Customer Access Feature Integration](/docs/pbc/all/identity-access-management/latest/install-and-upgrade/install-the-customer-account-management-glue-api.html). ## Change a customer's password To change a customer's password, send the request: --- `PATCH` **/customer-password/*{% raw %}{{{% endraw %}customerReference{% raw %}}}{% endraw %}*** --- | PATH PARAMETER | DESCRIPTION | | --- | --- | | ***{% raw %}{{{% endraw %}customerReference{% raw %}}}{% endraw %}*** | Customer reference that identifies the customer you want to update the password for. Should be the reference of customer the current access token is generated for. | --- ### Request | HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | | --- | --- | --- | --- | | Authorization | string | ✓ | Alphanumeric string that authenticates the customer you want to change the password of. Get it by [authenticating as a customer](/docs/pbc/all/identity-access-management/latest/manage-using-glue-api/glue-api-authenticate-as-a-customer.html). | Request sample: change a customer's password `PATCH http://glue.mysprykershop.com/customer-password/DE--21` ```json { "data": { "type": "customer-password", "id": "DE--21", "attributes": { "password": "change123", "newPassword": "321egnahc", "confirmPassword": "321egnahc" } } } ``` | ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | | --- | --- | --- | --- | | password | String | ✓ | Specifies old password of a customer. | | newPassword | String | ✓ | Specifies the new password. | | confirmPassword | String | ✓ | Specifies password confirmation for password change. | ### Response If password is changed successfully, the endpoint returns the `204 No Content` status code. ## Reset a customer's password To reset a customer's password, you need to send several requests to different endpoints. To do that, follow the procedure below. ### 1. Request a password reset key To request a password reset key, send the request: --- `POST` **/customer-forgotten-password** --- #### Request Request sample: request a password reset key `POST https://glue.mysprykershop.com/customer-forgotten-password` ```json { "data": { "type": "customer-forgotten-password", "attributes": { "email":"sonia@acme.com" } } } ``` #### Response If the request is successful, the endpoint returns the `204 No Content` status code and the key is sent to the customer's email address. ### 2. Set a new password To set a new password, send the request: --- `PATCH` **/customer-restore-password/*{% raw %}{{{% endraw %}restorePasswordKey{% raw %}}}{% endraw %}*** --- | PATH PARAMETER | DESCRIPTION | | --- | --- | | ***{% raw %}{{{% endraw %}restorePasswordKey{% raw %}}}{% endraw %}*** | This key can be any value, and does not have to be equal to `data.attributes.restorePasswordKey`. `data.attributes.restorePasswordKey` will be used for any operations with the customer's password. | --- #### Request Request sample: set a new password `PATCH https://glue.mysprykershop.com/customer-restore-password/98ffa3ecccac2b7f0815e0417784cd54` ```json { "data": { "type": "customer-restore-password", "id": "98ffa3ecccac2b7f0815e0417784cd54", "attributes": { "restorePasswordKey": "98ffa3ecccac2b7f0815e0417784cd54", "password": "wwfh234fr943434cf", "confirmPassword": "wwfh234fr943434cf" } } } ``` | ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | | --- | --- | --- | --- | | restorePasswordKey | String | ✓ | Unique the Password Reset Key provided in the email sent to the customer. | | password | String | ✓ | Specifies the password to set. | | passwordConfirmation | String | ✓ | Specifies a password confirmation for password change. | #### Response If the password reset is successful, the endpoint returns the `204 No Content` status code. ## Possible errors | CODE | REASON | | --- | --- | | 002 | Access token is missing. | | 404 | Customer with the specified ID is not found. | | 406 | New password and password confirmation do not match. | | 407 | Password change failed. | | 408 | Old password is invalid.| | 411 | Unauthorized request. | | 415 | Password Reset Key is invalid. | | 420 | The password character set is invalid. | | 422 | `newPassword` and `confirmPassword` values are not identical. | | 901 | `newPassword` and `confirmPassword` are not specified; or the password length is invalid (it should be from 8 to 64 characters). | To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/integrations/spryker-glue-api/storefront-api/api-references/reference-information-storefront-application-errors.html). ## Next steps [Authenticate as a customer](/docs/pbc/all/identity-access-management/latest/manage-using-glue-api/glue-api-manage-customer-passwords.html)

Glue API: Manage customer authentication tokens via OAuth 2.0

Thu, 14 May 2026 07:42:41 +0000

This endpoint allows authenticating as a customer and refreshing customer authentication tokens via OAuth 2.0. ## Installation For detailed information on the modules that provide the API functionality and related installation instructions, see [GLUE: Customer Account Management feature integration](/docs/pbc/all/identity-access-management/latest/install-and-upgrade/install-the-customer-account-management-glue-api.html). ## Authenticate as a customer To authenticate as a customer, send the request: --- `POST` **/token** --- ### Request | HEADER KEY | HEADER VALUE | REQUIRED | DESCRIPTION | |-|-|-|-| | Content-Type | application/x-www-form-urlencoded | ✓ | `x-www-form-urlencoded` is a URL encoded form. This is the default value if the encrypted attribute is not set to anything. The keys and values are encoded in key-value tuples separated by `&`, with a `=` between the key and the value. Non-alphanumeric characters in both keys and values are percent encoded. |

Request sample: authenticate as a customer

Response sample: authenticate as a customer

```json { "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiJmcm9udGVuZCIsImp0aSI6IjE5YWZmNDI4NzA0M2UxMGNjODc3MGM4ZjBkYTkwOTEwOWExYWQzMjdhNWM3MTY2ZjJjYzhhOGZkNDFjYzliM2ZmZGJjOWRmNjE0ZjRhZTUzIiwiaWF0IjoxNjE1MzcyOTI2LCJuYmYiOjE2MTUzNzI5MjYsImV4cCI6MTYxNTQwMTcyNiwic3ViIjoie1wiaWRfY29tcGFueV91c2VyXCI6XCJlYmY0YjU1YS1jYWIwLTVlZDAtOGZiNy01MjVhM2VlZWRlYWNcIixcImlkX2FnZW50XCI6bnVsbCxcImN1c3RvbWVyX3JlZmVyZW5jZVwiOlwiREUtLTIxXCIsXCJpZF9jdXN0b21lclwiOjIxLFwicGVybWlzc2lvbnNcIjp7XCJwZXJtaXNzaW9uc1wiOlt7XCJpZF9wZXJtaXNzaW9uXCI6MSxcImtleVwiOlwiUmVhZFNoYXJlZENhcnRQZXJtaXNzaW9uUGx1Z2luXCIsXCJjb25maWd1cmF0aW9uXCI6e1wiaWRfcXVvdGVfY29sbGVjdGlvblwiOlsyOCwyNywyNSwyNCwyMywyMiwyMV19LFwiY29uZmlndXJhdGlvbl9zaWduYXR1cmVcIjpcIltdXCIsXCJpZF9jb21wYW55X3JvbGVcIjpudWxsLFwiaXNfaW5mcmFzdHJ1Y3R1cmFsXCI6bnVsbH0se1wiaWRfcGVybWlzc2lvblwiOjIsXCJrZXlcIjpcIldyaXRlU2hhcmVkQ2FydFBlcm1pc3Npb25QbHVnaW5cIixcImNvbmZpZ3VyYXRpb25cIjp7XCJpZF9xdW90ZV9jb2xsZWN0aW9uXCI6WzI4LDI3LDI1LDI0LDIzLDIyLDIxXX0sXCJjb25maWd1cmF0aW9uX3NpZ25hdHVyZVwiOlwiW11cIixcImlkX2NvbXBhbnlfcm9sZVwiOm51bGwsXCJpc19pbmZyYXN0cnVjdHVyYWxcIjpudWxsfSx7XCJpZF9wZXJtaXNzaW9uXCI6bnVsbCxcImtleVwiOlwiUmVhZFNob3BwaW5nTGlzdFBlcm1pc3Npb25QbHVnaW5cIixcImNvbmZpZ3VyYXRpb25cIjp7XCJpZF9zaG9wcGluZ19saXN0X2NvbGxlY3Rpb25cIjp7XCIwXCI6MSxcIjJcIjoyLFwiM1wiOjN9fSxcImNvbmZpZ3VyYXRpb25fc2lnbmF0dXJlXCI6W10sXCJpZF9jb21wYW55X3JvbGVcIjpudWxsLFwiaXNfaW5mcmFzdHJ1Y3R1cmFsXCI6bnVsbH0se1wiaWRfcGVybWlzc2lvblwiOm51bGwsXCJrZXlcIjpcIldyaXRlU2hvcHBpbmdMaXN0UGVybWlzc2lvblBsdWdpblwiLFwiY29uZmlndXJhdGlvblwiOntcImlkX3Nob3BwaW5nX2xpc3RfY29sbGVjdGlvblwiOntcIjBcIjoxLFwiMlwiOjIsXCIzXCI6M319LFwiY29uZmlndXJhdGlvbl9zaWduYXR1cmVcIjpbXSxcImlkX2NvbXBhbnlfcm9sZVwiOm51bGwsXCJpc19pbmZyYXN0cnVjdHVyYWxcIjpudWxsfV19fSIsInNjb3BlcyI6WyJjdXN0b21lciJdfQ.MORe796POXfe4_VyQQoW-Aa9b9VpWrhQK3tBK-0Y463pg9yhoDRVG1izyqFkN6BHcucAVhV-xRvV-qPohJUhy92pLptFZMz3vxLtiE0EDRq2DrDFKh-O7f7rJgp7axIVXju5V0IxudEaj0Tz9XrKigWSPJ1kmIuSI8eQfmttSm5lw2YM8u22Y4p4pdN3Zhn4vz9r5w0CuwhcXKl8G1x_aK_PCTRa8OgX6VpPACZEidxr6suc5novyovaATV0lUqnIia0_DbsA0h1Pafu-WZnTpP_OhheqOI5k1Oq11Q8-ZvrG8vlLGg4JzGzMyXNe80uD1RNttqGn1HqsgOZfxTZGg", "token_type": "Bearer", "expires_in": 28800, "refresh_token": "def502009ca20f366fa7340f40e3c4c7246557d03b9d098301f8aa4289d7467690ff11db19a8151f3b475c4026fcecf94149b5acb51b964416f17e7f9c5dc6dfbc1c75a89d3b99234de175d3d78fa2650f1f07a7281856762189ac72f721a278cc020ffcf1335beccca4d36841ee32666c80b8ce21578a987867ad4e4cff268c9d70640a9c6fc6fd689a9b487bc131984f75ccbd473a451755e0bef6ad99fbf131c851f5b18e3a64f22cf8ded63acca1f60e31a048c30f5e18c1eca28bcad3c50ca07a2dc9afb66a4fb65c3e8f13e802578d3d29462da73c9bfc0aea153032ed2d49a9ee99231fbad475a3d76e387ebe430679bee32f0175905ffc18c4cfbe52375dfde14766eb19be76a3f2f193e48c55221f942b273d9b7a76df66291157c2f72a2cd8cc10c7d01b7b5e5084f478f32ee73e81dc2111907ef37b03dc4b1aa217552d9bfc31b2f3bf80769cc78e58aa29ac8cf5edf77e8ec913f85bbbb8714e9f93527043150cc1ed425ddae5bb191d6aa44a7335c03f1050feb70ed8577cbfb649f84db9cd5ca8651c20122da9a4989fe60cf7443af6eee87d7deb5f9a5655c5b6505ff5f63c599fc77e3586902074a35b8a814fbaacaa4417d4864c60fb1b97297ddccdd35570bcf97dd74434563bb6eedf1beacb93006292a491781d688c4a0c6edb4c9e15f997b774c68d487424e66f8b718c216b8a3d982e1418fb68a87a5f8fae5901b181521c1b7c7f14842b80bb7e3d135b71adb8d7cf2ebbd01412a2c9a4812e3928bfbde2e78909f5c1f943f05a64d52357d9e42692992d3ce4fdec049078b859e58980723bb5c338b10712073d5531a29ba593c173f9840abfc0ecb1380b115e8e18c2cbd28087e445ee2a7cabf680c6e1b7bef83612f29adfcd21eec4bbd83cb49fbfb2bdb887c4afd155d927798d248e53cab6ae258b3a5c9b904a57c822b8007b0583bff7fc57b040300934aaeac959d6551607d2d1f6980a9eea933d6033c639968040cb2e09f1ff0d160f55df15811d085d2635f434bef2987c94d70b4fe39894ab725042c2d4e7a1e315665af62ac76ff079a37b44fcca688467323d954e56c34539db9f67dbc91e90fbb91892721d4caa296bf35eb49de5e298e9708807f734655484d8aec56b5b25c96b8792f6250c5c14c901b94f6056693462d11bca8d3855ed62704325cc1c44d2875f3af5075212135d6343f40ef59d62ba39705b14f9fb51a9725c7f865b8474702d9a0d4671030de6c17aaf27e2c4552e7f23a0db25f7ad23300159273b0dd8e2887b2eb7f8e3fd6e969e2356c03a54c43677c492173f049b186b40f8af48b857be723b738e068fe683feae78913a70d1e8ec04601794eac71b388d9ee8fc41ad9f91001ddfc6efcd2f2203fe9618ea992865b13358dee95d1893bb748fe0d64c7ccd3aae1cb5ca86bc8f8ee13a8f7a02988f1e2d14dd6b060654b80b46335b6d26a84af1aeace63a6f904cfefabc5132b6c053d00af3398bcbe3ca050145715f0a12686d532fa6294bcc39d6d78456df2272347437d016839dbb3807ecd46d89c395e7ac075ba6675bcd8be444cb398d7e642f7bc4b413ba55596dd7f65d8005e89013f4df36f699eae1e03cad7201b077b3d5e95a3cf1a28edb69aafc371ac5dae57da53d43b3b5afe0dbcd1820662f05d225ab4449700c0b800fb52fcb853e74bed4f9c8c65ea2765722cede3a57a1749e74d62b90265a0445f850433c01ab805080c727c6ce620a00a161228c5d5cc8011dc775d50aae4015d5255aa7bec4abd53a68508c3961f2e03b6d461ad442a09329b57a3d501c2ddf6482ca631973727c01e8c23e08916af1f7153c43df907f8dc9bdcaecb9a93d79bcff05645fdacbb6df911112d916e99e2025f0d3f89cfbcb2cd327dbc6643c0dd078dda6a3473ba21a0ccfb8aa515fd812f7416cf6244b2034607f8ad8d77000f29c1b20a3040bbb5e6712c7a53b8b19868ea999422250a38b4cfe96217c800703797c05ea063d08c204c6d4b58d4708241a41b5cfde5554" } ```

Request sample: refresh an authentication token

| REQUEST BODY KEY | VALUE | |-|-| | grant_type | refresh_token | | refresh_token | `def50200ef59d199dfbae496fcb5bfc942377da65539e02fd0543e57b5084ac578b3146868bdaf2e5170bdb974e9cf7a431c17e000f0db564beefa89497b1cb1514dc516264eb79c0ebca240815791b075d4a950fa34e3b0fbabac7324663ce37999c206aca5faab7cd673a7f17fceb2ef10a7e11ddc1af7e22f21741cf16f789cb604da205332f813c2dd4cd3d57f6a8839bd5cd955dd068b71fab3cd2a1b591c57367217f9dcf48bbad79a28c424aa746b57940cb5f248d5d99244046921dc9c8be8aa6213d8bda2b7f9346c0ff318920c5a767d50a80e633506bf9328cda2506ba6339a300d8310d9cbbd2e4f86aa1b166023e6a84fa6360dcbb898cfbb8f65fc02710fef69ec5f3c2d133d97986488d6bde8321c166d6963a39bde3a9cdbf748995a9a3e79657bcf6fd76e90372ea3486fc023e53ab21f8034049073044be591f57dd3a980c3d69777a2f564a6418540d52f38777d9d17aa24fc83a11880e9f2510950b7b589737b421f077c69c4c40d5e5644e01a7da016df8fed447e62e3db3710ae229391b92aafa7c123204854e1e2f2c49411084eab25deab14615da3d118fe32e72c76b746a845cf7fbc156f64363e4d0c4e8d1a9941f7be5fb80ddd62c2eb6f29564792c0f6ee8db97be653c91687ce2a5bc74edee0472c8416bb446fc3ee7a1a37f7b13ca161a6c61bdb1b42df8b8bd0f3d7d788573ff37fe7de360c123eb4c737d65d5a4f8d02584d1fb6f74e27f05a40f8d18f745ffad1c3fc9e0879abd8e7ef0365b4efa85c6cb2603acf5a04e0630d82895e990180b5957780e93c48aaaf13341f7c485a479f50d5c505478ed3e50967fa0e25e3c3eb5e6199bd180d1d04fa98a318870dc492d190d546ea39648f11ba2a35f4d61d2eea8a4f3f28fc3cde19056194d2d722cb78ef9d8180917a7f887b50083c5b04f93de87c53c6912681f46153bfe90050eaad1ce2f169f03eee2fcdc48e736c63cff74c066def47acf41c4d90a142fa9282e17584abe5ad60abf2aee235b77d4fad2707be75653fc43013a5d0b8b812aa75cd1ffbc1b06b9cfe4d38c896f26049b3607a62f15da685a93d25fcc94ce693de793f9103ccd644f3a9b138d994951cc44fcbc17a2c7a8ec611441d3a8327213e03d2101a0602276b864ada2ef6e9620507ed82a7c9bcdf98abc821b9c4146a6ff20f0ea35771caa17fd515d4220975408138312a9ebff7d895476537f0b0c3329da6af3669767feddbdfe9b989a38be8e3b74507a8951236b2fd465886e7d23503d953d0f476ab269107c14f0306791ae6b0dc048d5c3d0e6433da70519298b66d265175e940e99da76d3410fa1d4db426e613b99e023cc0bd14130bdd77025250690fec407f94e823722443679a98a54c5082a705e61f317ac9199efaa26726e08245e40d80b22053ae74c2b84c8dbd0e707badb1f188e506839628bc02d96bf6526841f126c1c27d1a264fdb10d8fef957f95c71ecea09f0f5bea92f19543e8216703a72897ee123244cf4cedd74ee0694d4758ea86f7d42ea372dbe622af9939b57509662db0ca558aa7c6b586dd8047891c434eac7b9c77c298b20c569dd3b3baca84f0f98ca9dd040ff2285bdb954c8679f2c912558b5e51888d333ed9880281112e39c5acf7181598c68dbbe051b27ef61e5edd897748f7d42d0157070adb9ebb9237c416261be9e94ffe65e679e110dd71c5fc284e4f964d2b8d8e8e3624324c453dc94879f39502edf829e42520171fc4c76a311f43ad2a303ab8e093f11ff36a3f555f41cf61183e30d53ec2a29b9b885e068bb9bd7f14624338dd9f8290e07ae803640a4a828e03d5a1a3387982d12d5234506a2961d75a7f6692986b45f0e810130bbf16599894242980e9900a47e8312983295bf0b04e390dde861ca28c6371cf7b828abe084fb2d0df74df1dd87270cd92ce4bedf841bd6907c61fc281920e6cbce543ce796728565ff15ba8e41854ed0b04fdb612a016a568554760d3e732e24874325bd0ac1fa195cda0f12f6d07e8385` |

Response sample: refresh an authentication token

```json { "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiJmcm9udGVuZCIsImp0aSI6ImQ4NGJlZWFlNmJjOWRlNWQwMTY2Y2VkYTdiMWM4YjdhYjE1MmJjM2YwMzA2MTdkOGE3NzRiMTgyMzllM2UxZWZiMWQ0MGY2OGMxOTI0NTc5IiwiaWF0IjoxNjE1Mzg1OTIwLCJuYmYiOjE2MTUzODU5MjAsImV4cCI6MTYxNTQxNDcyMCwic3ViIjoie1wiaWRfY29tcGFueV91c2VyXCI6XCJlYmY0YjU1YS1jYWIwLTVlZDAtOGZiNy01MjVhM2VlZWRlYWNcIixcImlkX2FnZW50XCI6bnVsbCxcImN1c3RvbWVyX3JlZmVyZW5jZVwiOlwiREUtLTIxXCIsXCJpZF9jdXN0b21lclwiOjIxLFwicGVybWlzc2lvbnNcIjp7XCJwZXJtaXNzaW9uc1wiOlt7XCJpZF9wZXJtaXNzaW9uXCI6MSxcImtleVwiOlwiUmVhZFNoYXJlZENhcnRQZXJtaXNzaW9uUGx1Z2luXCIsXCJjb25maWd1cmF0aW9uXCI6e1wiaWRfcXVvdGVfY29sbGVjdGlvblwiOlsyOCwyNywyNSwyNCwyMywyMiwyMV19LFwiY29uZmlndXJhdGlvbl9zaWduYXR1cmVcIjpcIltdXCIsXCJpZF9jb21wYW55X3JvbGVcIjpudWxsLFwiaXNfaW5mcmFzdHJ1Y3R1cmFsXCI6bnVsbH0se1wiaWRfcGVybWlzc2lvblwiOjIsXCJrZXlcIjpcIldyaXRlU2hhcmVkQ2FydFBlcm1pc3Npb25QbHVnaW5cIixcImNvbmZpZ3VyYXRpb25cIjp7XCJpZF9xdW90ZV9jb2xsZWN0aW9uXCI6WzI4LDI3LDI1LDI0LDIzLDIyLDIxXX0sXCJjb25maWd1cmF0aW9uX3NpZ25hdHVyZVwiOlwiW11cIixcImlkX2NvbXBhbnlfcm9sZVwiOm51bGwsXCJpc19pbmZyYXN0cnVjdHVyYWxcIjpudWxsfSx7XCJpZF9wZXJtaXNzaW9uXCI6bnVsbCxcImtleVwiOlwiUmVhZFNob3BwaW5nTGlzdFBlcm1pc3Npb25QbHVnaW5cIixcImNvbmZpZ3VyYXRpb25cIjp7XCJpZF9zaG9wcGluZ19saXN0X2NvbGxlY3Rpb25cIjp7XCIwXCI6MSxcIjJcIjoyLFwiM1wiOjN9fSxcImNvbmZpZ3VyYXRpb25fc2lnbmF0dXJlXCI6W10sXCJpZF9jb21wYW55X3JvbGVcIjpudWxsLFwiaXNfaW5mcmFzdHJ1Y3R1cmFsXCI6bnVsbH0se1wiaWRfcGVybWlzc2lvblwiOm51bGwsXCJrZXlcIjpcIldyaXRlU2hvcHBpbmdMaXN0UGVybWlzc2lvblBsdWdpblwiLFwiY29uZmlndXJhdGlvblwiOntcImlkX3Nob3BwaW5nX2xpc3RfY29sbGVjdGlvblwiOntcIjBcIjoxLFwiMlwiOjIsXCIzXCI6M319LFwiY29uZmlndXJhdGlvbl9zaWduYXR1cmVcIjpbXSxcImlkX2NvbXBhbnlfcm9sZVwiOm51bGwsXCJpc19pbmZyYXN0cnVjdHVyYWxcIjpudWxsfV19fSIsInNjb3BlcyI6WyJjdXN0b21lciJdfQ.0fL6IifEM2I2cIYA7ZodwCUaghooTgKUoxQaREPDgQzry1ZB-B5nH6HoEMfZqcIpH0rwsA1oUf-9aZn-e1Gl6CEioG9Ql8Z_Wu7rFNX1H5YCIHMcw9F9ctWuWhZKKo3tHuMdLkOLGeHcZX0lx9yk7pY9hhu740TCjPmsCC4jUvuvLrHCQUBeGlMrEFg205a3EY7kuGcV8p1gJpH6Qjk-nAUPSXIz9DWGtZVi4pMO4A4CcVBbzV280XDDSyLIRXuF7QkUcznxZ-0uDhF28e-NMFG9C6l38tscVlCgRnUzvX7D-LG-SGF0W_kOvyz-xT1geZdyytnlOIM8ffEVtQD0WQ", "token_type": "Bearer", "expires_in": 28800, "refresh_token": "def50200ef59d199dfbae496fcb5bfc942377da65539e02fd0543e57b5084ac578b3146868bdaf2e5170bdb974e9cf7a431c17e000f0db564beefa89497b1cb1514dc516264eb79c0ebca240815791b075d4a950fa34e3b0fbabac7324663ce37999c206aca5faab7cd673a7f17fceb2ef10a7e11ddc1af7e22f21741cf16f789cb604da205332f813c2dd4cd3d57f6a8839bd5cd955dd068b71fab3cd2a1b591c57367217f9dcf48bbad79a28c424aa746b57940cb5f248d5d99244046921dc9c8be8aa6213d8bda2b7f9346c0ff318920c5a767d50a80e633506bf9328cda2506ba6339a300d8310d9cbbd2e4f86aa1b166023e6a84fa6360dcbb898cfbb8f65fc02710fef69ec5f3c2d133d97986488d6bde8321c166d6963a39bde3a9cdbf748995a9a3e79657bcf6fd76e90372ea3486fc023e53ab21f8034049073044be591f57dd3a980c3d69777a2f564a6418540d52f38777d9d17aa24fc83a11880e9f2510950b7b589737b421f077c69c4c40d5e5644e01a7da016df8fed447e62e3db3710ae229391b92aafa7c123204854e1e2f2c49411084eab25deab14615da3d118fe32e72c76b746a845cf7fbc156f64363e4d0c4e8d1a9941f7be5fb80ddd62c2eb6f29564792c0f6ee8db97be653c91687ce2a5bc74edee0472c8416bb446fc3ee7a1a37f7b13ca161a6c61bdb1b42df8b8bd0f3d7d788573ff37fe7de360c123eb4c737d65d5a4f8d02584d1fb6f74e27f05a40f8d18f745ffad1c3fc9e0879abd8e7ef0365b4efa85c6cb2603acf5a04e0630d82895e990180b5957780e93c48aaaf13341f7c485a479f50d5c505478ed3e50967fa0e25e3c3eb5e6199bd180d1d04fa98a318870dc492d190d546ea39648f11ba2a35f4d61d2eea8a4f3f28fc3cde19056194d2d722cb78ef9d8180917a7f887b50083c5b04f93de87c53c6912681f46153bfe90050eaad1ce2f169f03eee2fcdc48e736c63cff74c066def47acf41c4d90a142fa9282e17584abe5ad60abf2aee235b77d4fad2707be75653fc43013a5d0b8b812aa75cd1ffbc1b06b9cfe4d38c896f26049b3607a62f15da685a93d25fcc94ce693de793f9103ccd644f3a9b138d994951cc44fcbc17a2c7a8ec611441d3a8327213e03d2101a0602276b864ada2ef6e9620507ed82a7c9bcdf98abc821b9c4146a6ff20f0ea35771caa17fd515d4220975408138312a9ebff7d895476537f0b0c3329da6af3669767feddbdfe9b989a38be8e3b74507a8951236b2fd465886e7d23503d953d0f476ab269107c14f0306791ae6b0dc048d5c3d0e6433da70519298b66d265175e940e99da76d3410fa1d4db426e613b99e023cc0bd14130bdd77025250690fec407f94e823722443679a98a54c5082a705e61f317ac9199efaa26726e08245e40d80b22053ae74c2b84c8dbd0e707badb1f188e506839628bc02d96bf6526841f126c1c27d1a264fdb10d8fef957f95c71ecea09f0f5bea92f19543e8216703a72897ee123244cf4cedd74ee0694d4758ea86f7d42ea372dbe622af9939b57509662db0ca558aa7c6b586dd8047891c434eac7b9c77c298b20c569dd3b3baca84f0f98ca9dd040ff2285bdb954c8679f2c912558b5e51888d333ed9880281112e39c5acf7181598c68dbbe051b27ef61e5edd897748f7d42d0157070adb9ebb9237c416261be9e94ffe65e679e110dd71c5fc284e4f964d2b8d8e8e3624324c453dc94879f39502edf829e42520171fc4c76a311f43ad2a303ab8e093f11ff36a3f555f41cf61183e30d53ec2a29b9b885e068bb9bd7f14624338dd9f8290e07ae803640a4a828e03d5a1a3387982d12d5234506a2961d75a7f6692986b45f0e810130bbf16599894242980e9900a47e8312983295bf0b04e390dde861ca28c6371cf7b828abe084fb2d0df74df1dd87270cd92ce4bedf841bd6907c61fc281920e6cbce543ce796728565ff15ba8e41854ed0b04fdb612a016a568554760d3e732e24874325bd0ac1fa195cda0f12f6d07e8385" } ```

Manage availability notifications

Thu, 14 May 2026 07:42:41 +0000

*Availability Notification* allows registered and guest customers to subscribe to availability notifications for an unavailable product so that when the product is back in stock, they could receive a notification. This endpoint allows managing availability notifications of registered and guest customers. ## Installation For detailed information on the modules that provide the API functionality and related installation instructions, see [Install the Availability Notification Glue API](/docs/pbc/all/warehouse-management-system/latest/base-shop/install-and-upgrade/install-features/install-the-availability-notification-glue-api.html). ## Subscribe to availability notifications To subscribe to availability notifications for an out-of-stock product, send the request: --- `POST` **/availability-notifications** --- ### Request

Request sample: subscribe to availability notifications

`POST https://glue.mysprykershop.com/availability-notifications` ```json { "data": { "type": "availability-notifications", "attributes": { "sku": "130_24725761", "email": "sonia@acme.com" } } } ```

| ATTRIBUTE | TYPE | REQUIRED | DESCRIPTION | |-|-|-|-| | sku | string | ✓ | SKU of a product to subscribe the customer to. | | email | string | ✓ | Customer email where product availability notifications will be sent to. | ### Response

Response sample: subscribe to availability notifications

```json { "data": { "type": "availability-notifications", "id": "70b47ccf1e1a2262f83fddabd19d4828", "attributes": { "localeName": "en_US", "email": "sonia@acme.com", "sku": "130_24725761" }, "links": { "self": "https://glue.mysprykershop.com/availability-notifications/70b47ccf1e1a2262f83fddabd19d4828" } } } ```

| ATTRIBUTE | TYPE | DESCRIPTION | |-|-|-| | localeName | string | Locale of the subscribed customer. | | email | string | Customer email where the product availability notifications are sent to. | | sku | string | SKU of the product the customer receives notifications about. | ## Unsubscribe from availability notifications To unsubscribe from availability notifications for a product, send the request: --- `DELETE` **/availability-notifications/*{% raw %}{{{% endraw %}subscriptionKey{% raw %}}}{% endraw %}*** --- | PATH PARAMETER | DESCRIPTION | |-|-| | ***{% raw %}{{{% endraw %}subscriptionKey{% raw %}}}{% endraw %}*** | Subscription id that is assigned when the subscription is created. To get it as an `id` attribute, subscribe to product availability email notifications or retrieve existing subscriptions. Exampe: `"id": "d634981b8d1930f7db6e2780b7d5600a"`.
Note that anyone who has a subscription id can delete the subscription the id is assigned to. | ### Request Request sample: unsubscribe from availability notifications `DELETE https://glue.mysprykershop.com/availability-notifications/05f2004950e01a056537384a405ec9a0` ### Response If a customer's subscription is deleted successfully, the endpoint returns the `204 No Content` status code. | CODE | REASON | |-|-| | 001 | Access token is invalid. | | 002 | Access token is missing. | | 901 | SKU or email is not provided; email is invalid. | | 4601 | Product is not found. | | 4602 | Subscription already exists. | | 4603 | Subscription doesn't exist. | | 4606 | Request is not authorized. | To view generic errors that originate from the Glue Application, see [Reference information: GlueApplication errors](/docs/integrations/spryker-glue-api/storefront-api/api-references/reference-information-storefront-application-errors.html).