Skip to content

Commit

Permalink
Merge pull request #2401 from spryker/push-notifications-glue-api
Browse files Browse the repository at this point in the history
Push notification subscriptions Glue API
  • Loading branch information
andriitserkovnyi authored Jan 3, 2024
2 parents a6bbabd + 89b3cc4 commit 2af9012
Show file tree
Hide file tree
Showing 66 changed files with 865 additions and 438 deletions.
26 changes: 20 additions & 6 deletions _data/sidebars/pbc_all_sidebar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -1569,10 +1569,6 @@ entries:
url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-setup-module.html
- title: Transfer
url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-transfer-module.html
- title: Import and export data
nested:
- title: "Import file details: glossary.csv"
url: /docs/pbc/all/miscellaneous/import-and-export-data/import-file-details-glossary.csv.html
- title: Install Glue API
nested:
- title: Spryker Core
Expand All @@ -1585,14 +1581,32 @@ entries:
url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-quote-module.html
- title: Transfer
url: /docs/pbc/all/miscellaneous/install-and-upgrade/upgrade-modules/upgrade-the-transfer-module.html
- title: Import and export data
nested:
- title: "Import file details: glossary.csv"
url: /docs/pbc/all/miscellaneous/import-and-export-data/import-file-details-glossary.csv.html
- title: Manage in the Back Office
nested:
- title: Add translations
url: /docs/pbc/all/miscellaneous/manage-in-the-back-office/add-translations.html
- title: Edit translations
url: /docs/pbc/all/miscellaneous/manage-in-the-back-office/edit-translations.html
- title: Retrieve store configuration using Glue API
url: /docs/pbc/all/miscellaneous/glue-api-retrieve-store-configuration.html
- title: Manage using Glue API
nested:
- title: Retrieve store configuration using Glue API
url: /docs/pbc/all/miscellaneous/glue-api-retrieve-store-configuration.html
- title: Manage push notification providers
nested:
- title: Add push notification providers
url: /docs/pbc/all/miscellaneous/manage-using-glue-api/manage-push-notification-providers/glue-api-add-push-notification-providers.html
- title: Retrieve push notification providers
url: /docs/pbc/all/miscellaneous/manage-using-glue-api/manage-push-notification-providers/glue-api-retrieve-push-notification-providers.html
- title: Update push notification providers
url: /docs/pbc/all/miscellaneous/manage-using-glue-api/manage-push-notification-providers/glue-api-update-push-notification-providers.html
- title: Delete push notification providers
url: /docs/pbc/all/miscellaneous/manage-using-glue-api/manage-push-notification-providers/glue-api-delete-push-notification-providers.html
- title: Add push notification subscriptions
url: /docs/pbc/all/miscellaneous/manage-using-glue-api/glue-api-add-push-notification-subscriptions.html
- title: Third-party integrations
nested:
- title: Customer service
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
| RESOURCE | ATTRIBUTE | TYPE | DESCRIPTION |
| --- | --- | --- | --- |
| abstract-product-prices | price | Integer | Price to pay for that product in cents. |
| abstract-product-prices | priceTypeName | String | Price type. |
| abstract-product-prices | netAmount | Integer | Net price in cents. |
| abstract-product-prices | grossAmount | Integer | Gross price in cents. |
| abstract-product-prices | currency.code | String | Currency code. |
| abstract-product-prices | currency.name | String | Currency name. |
| abstract-product-prices | currency.symbol | String | Currency symbol. |
| abstract-product-prices | volumePrices | Array | An array of objects defining the [volume prices](/docs/pbc/all/price-management/{{site.version}}/base-shop/prices-feature-overview/volume-prices-overview.html) for the abstract product. |
| abstract-product-prices | netAmount | Integer | Net price in cents. |
| abstract-product-prices | grossAmount | Integer | Gross price in cents. |
| abstract-product-prices | quantity | Integer | Number of items. |
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
| RESOURCE | ATTRIBUTE | TYPE | DESCRIPTION |
|-|-|-|-|
| abstract-products | sku | String | SKU of the abstract product. |
| abstract-products | averageRating | String | Average rating of the product based on customer rating. |
| abstract-products | reviewCount | Integer | Number of reviews left by customer for this abstract product. |
| abstract-products | name | String | Name of the abstract product. |
| abstract-products | description | String | Description of the abstract product. |
| abstract-products | attributes | Object | List of attributes and their values. |
| abstract-products | superAttributeDefinition | String | Attributes flagged as super attributes that are, however, not relevant to distinguish between the product variants. |
| abstract-products | attributeMap | Object | Each super attribute / value combination and the corresponding concrete product IDs are listed here. |
| abstract-products | attributeMap.super_attributes | Object | Applicable super attribute and its values for the product variants. |
| abstract-products | attributeMap.attribute_variants | Object | List of super attributes with the list of values. |
| abstract-products | attributeMap.product_concrete_ids | String | Product IDs of the product variants. |
| abstract-products | metaTitle | String | Meta title of the product. |
| abstract-products | metaKeywords | String | Meta keywords of the product. |
| abstract-products | metaDescription | String | Meta description of the product. |
| abstract-products | attributeNames | Object | All non-super attribute / value combinations for the abstract product. |

This file was deleted.

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
| RESOURCE | ATTRIBUTE | TYPE | DESCRIPTION |
| --- | --- | --- | --- |
| bundle-items, bundled-items | sku | String | SKU of the product. |
| bundle-items, bundled-items | quantity | Integer | Quantity of the given product in the cart. |
| bundle-items, bundled-items | groupKey | String | Unique item identifier. The value is generated based on product parameters. |
| bundle-items, bundled-items | abstractSku | String | Unique identifier of the abstract product that owns the concrete product. |
| bundle-items, bundled-items | amount | Integer | Amount of the products in the cart. |
| bundle-items, bundled-items | unitPrice | Integer | Single item price without assuming is it net or gross. This value should be used everywhere a price is disabled. It allows switching the tax mode without side effects. |
| bundle-items, bundled-items | sumPrice | Integer | Sum of all items prices calculated. |
| bundle-items, bundled-items | taxRate | Integer | Current tax rate in per cent. |
| bundle-items, bundled-items | unitNetPrice | Integer | Single item net price. |
| bundle-items, bundled-items | sumNetPrice | Integer | Sum of all items' net price. |
| bundle-items, bundled-items | unitGrossPrice | Integer | Single item gross price. |
| bundle-items, bundled-items | sumGrossPrice | Integer | Sum of items gross price. |
| bundle-items, bundled-items | unitTaxAmountFullAggregation | Integer | Total tax amount for a given item with additions. |
| bundle-items, bundled-items | sumTaxAmountFullAggregation | Integer | Total tax amount for a given amount of items with additions. |
| bundle-items, bundled-items | sumSubtotalAggregation | Integer | Sum of subtotals of the items. |
| bundle-items, bundled-items | unitSubtotalAggregation | Integer | Subtotal for the given item. |
| bundle-items, bundled-items | unitProductOptionPriceAggregation | Integer | Item total product option price. |
| bundle-items, bundled-items | sumProductOptionPriceAggregation | Integer | Item total of product options for the given sum of items. |
| bundle-items, bundled-items | unitDiscountAmountAggregation | Integer | Item total discount amount. |
| bundle-items, bundled-items | sumDiscountAmountAggregation | Integer | Sum Item total discount amount. |
| bundle-items, bundled-items | unitDiscountAmountFullAggregation | Integer | Sum total discount amount with additions. |
| bundle-items, bundled-items | sumDiscountAmountFullAggregation | Integer | Item total discount amount with additions. |
| bundle-items, bundled-items | unitPriceToPayAggregation | Integer | Item total price to pay after discounts with additions. |
| bundle-items, bundled-items | sumPriceToPayAggregation | Integer | Sum of the prices to pay (after discounts). |
| bundle-items, bundled-items | salesUnit | Object | List of attributes defining the sales unit to be used for item amount calculation. |
| bundle-items, bundled-items | salesUnit.id | Integer | Numeric value that defines the sales units to calculate the item amount in. |
| bundle-items, bundled-items | salesUnit.amount | Integer | Amount of product in the defined sales units. |
| bundle-items, bundled-items | selectedProductOptions | array | List of attributes describing the product options that were added to the cart with the product. |
| bundle-items, bundled-items | selectedProductOptions.optionGroupName | String | Name of the group to which the option belongs. |
| bundle-items, bundled-items | selectedProductOptions.sku | String | SKU of the product option. |
| bundle-items, bundled-items | selectedProductOptions.optionName | String | Product option name. |
| bundle-items, bundled-items | selectedProductOptions.price | Integer | Product option price in cents. |
| bundle-items, bundled-items | selectedProductOptions.currencyIsoCode | String | ISO 4217 code of the currency in which the product option price is specified. |
Original file line number Diff line number Diff line change
Expand Up @@ -2,28 +2,39 @@

| RESOURCE | ATTRIBUTE | TYPE | DESCRIPTION |
|-|-|-|-|
| currency | String | Currency that was selected when the cart was created. |
| isDefault | Boolean | Specifies whether the cart is the default one for the customer. The field is available in multi-cart environments only. |
| name | String | Specifies a cart name. The field is available in multi-cart environments only. |
| priceMode | String | Price mode that was active when the cart was created. |
| store | String | Store for which the cart was created. |
| carts | currency | String | Currency that was selected when the cart was created. |
| carts | isDefault | Boolean | Specifies whether the cart is the default one for the customer. The field is available in multi-cart environments only. |
| carts | name | String | Specifies a cart name. The field is available in multi-cart environments only. |
| carts | priceMode | String | Price mode that was active when the cart was created. |
| carts | store | String | Store for which the cart was created. |

#### Discount information

| RESOURCE | ATTRIBUTE | TYPE | DESCRIPTION |
|-|-|-|-|
| displayName | String | Discount name. |
| amount | Integer | Discount amount applied to the cart. |
| code | String | Discount code applied to the cart. |
| carts | displayName | String | Discount name. |
| carts | amount | Integer | Discount amount applied to the cart. |
| carts | code | String | Discount code applied to the cart. |

#### Totals

| RESOURCE | ATTRIBUTE | TYPE | DESCRIPTION |
|-|-|-|-|
| expenseTotal | String | Total amount of expenses (including, e.g., shipping costs). |
| discountTotal | Integer | Total amount of discounts applied to the cart. |
| taxTotal | Integer | Total amount of taxes to be paid. |
| subTotal | Integer | Subtotal of the cart. |
| grandTotal | Integer | Grand total of the cart. |
| priceToPay | Integer | Total price of the cart to pay after discounts. |
| selectedProductOptions | array | List of attributes describing the product options that were added to cart with the product. |
| carts | expenseTotal | String | Total amount of expenses (including, e.g., shipping costs). |
| carts | discountTotal | Integer | Total amount of discounts applied to the cart. |
| carts | taxTotal | Integer | Total amount of taxes to be paid. |
| carts | subTotal | Integer | Subtotal of the cart. |
| carts | grandTotal | Integer | Grand total of the cart. |
| carts | priceToPay | Integer | Total price of the cart to pay after discounts. |
| carts | selectedProductOptions | array | List of attributes describing the product options that were added to cart with the product. |

#### Thresholds

| RESOURCE | ATTRIBUTE | TYPE | DESCRIPTION |
|-|-|-|-|
| carts | threshold | Array | Thresholds applied. |
| carts | type | String | Threshold type. |
| carts | threshold | Integer | Threshold monetary amount. |
| carts | fee | Integer | Fee to be paid if the threshold is not reached. |
| carts | deltaWithSubtotal | Integer | Displays the remaining amount that needs to be added to pass the threshold. |
| carts | message | String | Message shown to the customer if the threshold is not fulfilled. |
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
| RESOURCE | ATTRIBUTE | TYPE | DESCRIPTION |
|-|-|-|-|
| concrete-products | sku | String | SKU of the concrete product. |
| concrete-products | isDiscontinued | Boolean | Specifies whether a product is [discontinued](/docs/pbc/all/product-information-management/{{page.version}}/base-shop/feature-overviews/product-feature-overview/discontinued-products-overview.html):<br>**true** - the product is discontinued and requires a replacement item; <br> **false**—the product is not discontinued. |
| concrete-products | discontinuedNote | String | Optional note that was specified when marking a product as discontinued. |
| concrete-products | averageRating | String | Average [rating](/docs/scos/user/features/{{page.version}}/product-rating-and-reviews-feature-overview.html) of the product based on customer rating. |
| concrete-products | reviewCount | Integer | Number of reviews left by customer for this product. |
| concrete-products | name | String | Name of the concrete product. |
| concrete-products | description | String | Description of the concrete product. |
| concrete-products | attributes | Object | List of attribute keys and their values for the product. |
| concrete-products | superAttributeDefinition | String | List of attributes that are flagged as super attributes. |
| concrete-products | metaTitle | String | Meta title of the product. |
| concrete-products | metaKeywords | String | Meta keywords of the product. |
| concrete-products | metaDescription | String | Meta description of the product. |
| concrete-products | attributeNames | String | List of attribute keys and their translations. |
| concrete-products | productAbstractSku | String | Unique identifier of the abstract product owning this concrete product. |
Loading

0 comments on commit 2af9012

Please sign in to comment.