Merge pull request #2377 from spryker/CnC-api-guides

CnC api guides
spryker · Dec 14, 2023 · 3211c6e · 3211c6e
2 parents 1dd60d4 + 0d7c87a
commit 3211c6e
Show file tree

Hide file tree

Showing 60 changed files with 2,904 additions and 156 deletions.
diff --git a/_data/sidebars/pbc_all_sidebar.yml b/_data/sidebars/pbc_all_sidebar.yml
@@ -102,6 +102,14 @@ entries:
                     url: /docs/pbc/all/carrier-management/base-shop/manage-using-glue-api/glue-api-retrieve-shipments-when-checking-out-purchases.html
                   - title: Retrieve shipments in orders
                     url: /docs/pbc/all/carrier-management/base-shop/manage-using-glue-api/glue-api-retrieve-shipments-in-orders.html
+                  - title: Manage shipment types
+                    nested:
+                      - title: Add shipment types
+                        url: /docs/pbc/all/carrier-management/base-shop/manage-using-glue-api/manage-shipment-types/glue-api-add-shipment-types.html
+                      - title: Retrieve shipment types
+                        url: /docs/pbc/all/carrier-management/base-shop/manage-using-glue-api/manage-shipment-types/glue-api-retrieve-shipment-types.html
+                      - title: Update shipment types
+                        url: /docs/pbc/all/carrier-management/base-shop/manage-using-glue-api/manage-shipment-types/glue-api-update-shipment-types.html
               - title: Import data
                 url: /docs/pbc/all/carrier-management/base-shop/import-and-export-data/import-carrier-management-data.html
                 nested:
@@ -1837,6 +1845,8 @@ entries:
                 url: /docs/pbc/all/offer-management/unified-commerce/import-file-details-product-offer-service.csv.html
               - title: Create and edit product offers
                 url: /docs/pbc/all/offer-management/unified-commerce/unified-commerce-create-and-edit-product-offers.html
+              - title: Retrieve product offer service point availability using Glue API
+                url: /docs/pbc/all/offer-management/unified-commerce/glue-api-retrieve-product-offer-service-point-availability.html
 
       - title: Order Management System
         url: /docs/pbc/all/order-management-system/order-management-system.html
@@ -3517,80 +3527,78 @@ entries:
             nested:
               - title: Service Points feature overview
                 url: /docs/pbc/all/service-point-management/unified-commerce/service-points-feature-overview.html
-                include_versions:
-                - "202311.0"
               - title: Service Points Cart + Checkout feature overview
                 url: /docs/pbc/all/service-point-management/unified-commerce/service-points-cart-checkout-feature-overview.html
-                include_versions:
-                - "202311.0"
               - title: Service Points Cart feature overview
                 url: /docs/pbc/all/service-point-management/unified-commerce/service-points-cart-feature-overview.html
-                include_versions:
-                - "202311.0"
               - title: Service Points + Customer Account Management feature overview
                 url: /docs/pbc/all/service-point-management/unified-commerce/service-points-customer-account-management-feature-overview.html
-                include_versions:
-                - "202311.0"
               - title: Service Points + Order Management feature overview
                 url: /docs/pbc/all/service-point-management/unified-commerce/service-points-order-management-feature.html
-                include_versions:
-                - "202311.0"
               - title: Enable Click & Collect
                 url: /docs/pbc/all/service-point-management/unified-commerce/enable-click-collect.html
-                include_versions:
-                - "202311.0"
               - title: Install features
                 nested:
                   - title: Service Points Cart + Checkout
                     url: /docs/pbc/all/service-point-management/unified-commerce/install-features/install-the-service-points-cart-checkout-feature.html
-                    include_versions:
-                    - "202311.0"
                   - title: Service Points Cart
                     url: /docs/pbc/all/service-point-management/unified-commerce/install-features/install-the-service-points-cart-feature.html
-                    include_versions:
-                    - "202311.0"
                   - title: Service Points + Customer Account Management
                     url: /docs/pbc/all/service-point-management/unified-commerce/install-features/install-the-service-points-customer-account-management-feature.html
-                    include_versions:
-                    - "202311.0"
                   - title: Service Points
                     url: /docs/pbc/all/service-point-management/unified-commerce/install-features/install-the-service-points-feature.html
-                    include_versions:
-                    - "202311.0"
                   - title: Service Points + Order Management
                     url: /docs/pbc/all/service-point-management/unified-commerce/install-features/install-the-service-points-order-management-feature.html
-                    include_versions:
-                    - "202311.0"
                   - title: Service Points + Product Offer
                     url: /docs/pbc/all/service-point-management/unified-commerce/install-features/install-the-service-points-product-offer-feature.html
-                    include_versions:
-                    - "202311.0"
                   - title: Service Points Cart + Shipment
                     url: /docs/pbc/all/service-point-management/unified-commerce/install-features/install-the-service-points-shipment-feature.html
-                    include_versions:
-                    - "202311.0"
               - title: Import and export data
                 nested:
                   - title: "Import file details: service_point_address.csv"
                     url: /docs/pbc/all/service-point-management/unified-commerce/import-and-export-data/import-file-details-service-point-address.csv.html
-                    include_versions:
-                    - "202311.0"
                   - title: "Import file details: service_point_store.csv"
                     url: /docs/pbc/all/service-point-management/unified-commerce/import-and-export-data/import-file-details-service-point-store.csv.html
-                    include_versions:
-                    - "202311.0"
                   - title: "Import file details: service_point.csv"
                     url: /docs/pbc/all/service-point-management/unified-commerce/import-and-export-data/import-file-details-service-point.csv.html
-                    include_versions:
-                    - "202311.0"
                   - title: "Import file details: service_type.csv"
                     url: /docs/pbc/all/service-point-management/unified-commerce/import-and-export-data/import-file-details-service-type.csv.html
-                    include_versions:
-                    - "202311.0"
                   - title: "Import file details: service.csv"
                     url: /docs/pbc/all/service-point-management/unified-commerce/import-and-export-data/import-file-details-service.csv.html
-                    include_versions:
-                    - "202311.0"
+              - title: Manage using Glue API
+                nested:
+                  - title: Manage service points
+                    nested:
+                      - title: Add service points
+                        url: /docs/pbc/all/service-point-management/unified-commerce/manage-using-glue-api/manage-service-points/glue-api-add-service-points.html
+                      - title: Retrieve service points
+                        url: /docs/pbc/all/service-point-management/unified-commerce/manage-using-glue-api/manage-service-points/glue-api-retrieve-service-points.html
+                      - title: Update service points
+                        url: /docs/pbc/all/service-point-management/unified-commerce/manage-using-glue-api/manage-service-points/glue-api-update-service-points.html
+                  - title: Manage service types
+                    nested:
+                      - title: Add service types
+                        url: /docs/pbc/all/service-point-management/unified-commerce/manage-using-glue-api/manage-service-types/glue-api-add-service-types.html
+                      - title: Retrieve service types
+                        url: /docs/pbc/all/service-point-management/unified-commerce/manage-using-glue-api/manage-service-types/glue-api-retrieve-service-types.html
+                      - title: Update service types
+                        url: /docs/pbc/all/service-point-management/unified-commerce/manage-using-glue-api/manage-service-types/glue-api-update-service-types.html
+                  - title: Manage service point addresses
+                    nested:
+                      - title: Add service point addresses
+                        url: /docs/pbc/all/service-point-management/unified-commerce/manage-using-glue-api/manage-service-point-addresses/glue-api-add-service-point-addresses.html
+                      - title: Retrieve service point addresses
+                        url: /docs/pbc/all/service-point-management/unified-commerce/manage-using-glue-api/manage-service-point-addresses/glue-api-retrieve-service-point-addresses.html
+                      - title: Add service point addresses
+                        url: /docs/pbc/all/service-point-management/unified-commerce/manage-using-glue-api/manage-service-point-addresses/glue-api-update-service-point-addresses.html
+                  - title: Manage services
+                    nested:
+                      - title: Add services
+                        url: /docs/pbc/all/service-point-management/unified-commerce/manage-using-glue-api/manage-services/glue-api-add-services.html
+                      - title: Retrieve services
+                        url: /docs/pbc/all/service-point-management/unified-commerce/manage-using-glue-api/manage-services/glue-api-retrieve-services.html
+                      - title: Update services
+                        url: /docs/pbc/all/service-point-management/unified-commerce/manage-using-glue-api/manage-services/glue-api-update-services.html
 
       - title: Shopping List and Wishlist
         url: /docs/pbc/all/shopping-list-and-wishlist/shopping-list-and-wishlist.html
@@ -4039,7 +4047,7 @@ entries:
                       - title: Start picking
                         url: /docs/pbc/all/warehouse-management-system/unified-commerce/manage-using-glue-api/manage-picklists/glue-api-start-picking.html
                       - title: Pick picklist items
-                        url: /docs/pbc/all/warehouse-management-system/unified-commerce/manage-using-glue-api/manage-picklists/glue-api-pick-picklist-items.html                                                                                                                              
+                        url: /docs/pbc/all/warehouse-management-system/unified-commerce/manage-using-glue-api/manage-picklists/glue-api-pick-picklist-items.html
       - title: Usercentrics
         url: /docs/pbc/all/usercentrics/usercentrics.html
         nested:

diff --git a/...eve-customer-carts-response-attributes.md → ...des/202311.0/carts-response-attributes.md b/...eve-customer-carts-response-attributes.md → ...des/202311.0/carts-response-attributes.md
@@ -1,7 +1,7 @@
 #### General cart information
 
-| ATTRIBUTE | TYPE | DESCRIPTION |
-|-|-|-|
+| 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. |
@@ -10,16 +10,16 @@
 
 #### Discount information
 
-| ATTRIBUTE | TYPE | DESCRIPTION |
-|-|-|-|
+| RESOURCE | ATTRIBUTE | TYPE | DESCRIPTION |
+|-|-|-|-|
 | displayName | String | Discount name. |
 | amount | Integer | Discount amount applied to the cart. |
 | code | String | Discount code applied to the cart. |
 
 #### Totals
 
-| ATTRIBUTE | TYPE | DESCRIPTION |
-|-|-|-|
+| 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. |

diff --git a/...ubmit-checkout-data-request-attributes.md → ...311.0/checkout-data-request-attributes.md b/...ubmit-checkout-data-request-attributes.md → ...311.0/checkout-data-request-attributes.md
diff --git a/_includes/pbc/all/glue-api-guides/202311.0/checkout-data-response-attributes.md b/_includes/pbc/all/glue-api-guides/202311.0/checkout-data-response-attributes.md
@@ -0,0 +1,11 @@
+| RESOURCE | ATTRIBUTE | TYPE | DESCRIPTION |
+| --- | ----------- | ----- | ----- |
+| checkout-data | addresses | Array | A list of customer addresses that can be used for billing or shipping. This attribute is deprecated. To retrieve all available addresses, include the `addresses` resource in your request. |
+| checkout-data | paymentProviders | Array | Payment providers that can be used for the checkout. This attribute is deprecated. To retrieve all the available payment methods, include the `payment-methods` resource in your request. |  
+| checkout-data | shipmentMethods | Array | A list of available shipment methods. This attribute is deprecated. To retrieve all the available shipment methods, include the `shipment-methods` resource in your request. |  
+| checkout-data | selectedShipmentMethods | Array | Shipment methods selected for the order.  |
+| checkout-data | selectedPaymentMethods | Array | Payment methods selected for this order. |
+| checkout-data | selectedPaymentMethods.paymentMethodName | String | Payment method name. |
+| checkout-data | selectedPaymentMethods.paymentProviderName | String | Name of the payment provider for this payment method. |
+| checkout-data | selectedPaymentMethods.priority | String | Defines the order of returned payment methods in ascending order. |
+| checkout-data | selectedPaymentMethods.requiredRequestData | Array | A list of attributes required by the given method to effectuate a purchase. The actual list depends on the specific provider. |
diff --git a/...ponse-attributes-of-included-resources.md → ....0/order-shipments-response-attributes.md b/...ponse-attributes-of-included-resources.md → ....0/order-shipments-response-attributes.md
@@ -1,12 +1,12 @@
-| INCLUDED RESOURCE | ATTRIBUTE | TYPE |
-| :-------------------- | :------------------------- | :------- |
-| order-shipments       | itemUuids                  | String   |
-| order-shipments       | methodName                 | String   |
-| order-shipments       | carrierName                | String   |
-| order-shipments       | requestedDeliveryDate      | Date     |
-| order-shipments       | shippingAddress            | Object   |
-| order-shipments       | shippingAddress.salutation | String   |
-| order-shipments       | shippingAddress.firstName  | String   |
+| RESOURCE | ATTRIBUTE | TYPE | DESCRIPTION |
+| :-------------------- | :------------------------- | :------- | --- |
+| order-shipments       | itemUuids                  | String   |      |
+| order-shipments       | methodName                 | String   |       |
+| order-shipments       | carrierName                | String   |       |
+| order-shipments       | requestedDeliveryDate      | Date     |       |
+| order-shipments       | shippingAddress            | Object   |       |
+| order-shipments       | shippingAddress.salutation | String   |       |
+| order-shipments       | shippingAddress.firstName  | String   |       |
 | order-shipments | shippingAddress.middleName  | String | Customer's middle name.                 |
 | order-shipments | shippingAddress.lastName    | String | Customer's last name.                   |
 | order-shipments | shippingAddress.address1    | String | The 1st line of the customer's address. |