API Update for v2.16.0

CHANGELOG.md

@@ -10,6 +10,35 @@ only use JavaScript, or if you use TypeScript but only import the client classes
 then your usage **will not change**. You will likely only need to make changes if
 you import the type definitions directly.
 
+## v2.16.0
+
+#### API Changes
+
+*Shopper Customers*
+
+- Removal of deprecated endpoints:
+  - `invalidateCustomerAuth`
+  - `authorizeCustomer`
+  - `authorizeTrustedSystem`
+
+*Shopper Orders*
+
+  | **Endpoint Name** | **Description** |
+  | ------------- |-------------|
+  | guestOrderLookup | Lookup a guest order |
+
+*Customers*
+
+  | **Endpoint Name** | **Description** |
+  | ------------- |-------------|
+  | searchCustomerGroup | Search for customer groups in a given Site Id |
+
+*Coupons*
+
+  | **Endpoint Name** | **Description** |
+  | ------------- |-------------|
+  | redeemCoupon | Redeems a coupon code for an existing coupon within the selected site. The coupon code must be redeemable. |
+
 ## v2.15.0
 
 #### API Changes

apis/cdn/cdn-api-process-apis/.metadata.json

@@ -1,10 +1,10 @@
 {
-  "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/cdn-api-process-apis/1.0.29",
+  "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/cdn-api-process-apis/1.0.30",
   "name": "CDN Zones",
   "description": "Extend your eCDN beyond Business Manager configuration.",
   "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8",
   "assetId": "cdn-api-process-apis",
-  "version": "1.0.29",
+  "version": "1.0.30",
   "categories": {
     "API layer": [
       "Process"

apis/cdn/cdn-api-process-apis/cdnapi-process-api.raml

@@ -332,7 +332,7 @@ traits:
     get:
       is: [hasUnauthorizedResponse, hasForbiddenAccessResponse, hasInternalServerErrorResponse, hasResourceNotFoundResponse]
       displayName: getFirewallRules
-      description: Retrieves existing firewall rules. This endpoint will be deprecated at a later date and additional documentation will be provided. Use eCDN custom rules moving forward. Any existing firewall rules are accessible and can be updated using the custom rule endpoints.
+      description: (DEPRECATED) Retrieves existing firewall rules. This endpoint is deprecated. Requests return a 400 Bad Request response. Use [eCDN custom rules](https://developer.salesforce.com/docs/commerce/commerce-api/guide/cdn-zones-custom-rules.html) moving forward. Any existing firewall rules are accessible and can be updated using the custom rule endpoints.
       responses:
         '200':
           description: Successfully returned back the list of firewall rules requested by the caller.
@@ -347,7 +347,7 @@ traits:
     post:
       is: [hasBadRequestResponse]
       displayName: createFirewallRule
-      description: (DEPRECATED) Creates a firewall rule. This endpoint is deprecated as of February 6, 2024. Requests return a 400 Bad Request response. Use eCDN custom rules moving forward. Any existing firewall rules are accessible and can be updated using the custom rule endpoints.
+      description: (DEPRECATED) Creates a firewall rule. This endpoint is deprecated. Requests return a 400 Bad Request response. Use [eCDN custom rules](https://developer.salesforce.com/docs/commerce/commerce-api/guide/cdn-zones-custom-rules.html) moving forward. Any existing firewall rules are accessible and can be updated using the custom rule endpoints.
       body:
         application/json:
           type: FirewallRule
@@ -367,7 +367,7 @@ traits:
       get:
         is: [hasUnauthorizedResponse, hasForbiddenAccessResponse, hasInternalServerErrorResponse, hasResourceNotFoundResponse]
         displayName: getFirewallRule
-        description: Retrieve a specific firewall rule. This endpoint will be deprecated at a later date and additional documentation will be provided. Use eCDN custom rules moving forward. Any existing firewall rules are accessible and can be updated using the custom rule endpoints.
+        description: (DEPRECATED) Retrieve a specific firewall rule. This endpoint is deprecated. Requests return a 400 Bad Request response. Use [eCDN custom rules](https://developer.salesforce.com/docs/commerce/commerce-api/guide/cdn-zones-custom-rules.html) moving forward. Any existing firewall rules are accessible and can be updated using the custom rule endpoints.
         responses:
           '200':
             description: Successfully returned back the firewall rule requested by the caller.
@@ -381,7 +381,7 @@ traits:
       put:
         is: [hasBadRequestResponse]
         displayName: updateFirewallRule
-        description: (DEPRECATED) Update a specific firewall rule. This endpoint is deprecated as of February 6, 2024. Requests return a 400 Bad Request response. Use eCDN custom rules moving forward. Any existing firewall rules are accessible and can be updated using the custom rule endpoints.
+        description: (DEPRECATED) Update a specific firewall rule. This endpoint is deprecated. Requests return a 400 Bad Request response. Use [eCDN custom rules](https://developer.salesforce.com/docs/commerce/commerce-api/guide/cdn-zones-custom-rules.html) moving forward. Any existing firewall rules are accessible and can be updated using the custom rule endpoints.
         body:
           application/json:
             type: FirewallRule
@@ -399,7 +399,7 @@ traits:
       delete:
         is: [hasUnauthorizedResponse, hasForbiddenAccessResponse, hasInternalServerErrorResponse, hasResourceNotFoundResponse]
         displayName: deleteFirewallRule
-        description: Delete a specific firewall rule. This endpoint will be deprecated at a later date and additional documentation will be provided. Use eCDN custom rules moving forward. Any existing firewall rules are accessible and can be updated using the custom rule endpoints.
+        description: (DEPRECATED) Delete a specific firewall rule. This endpoint is deprecated. Requests return a 400 Bad Request response. Use [eCDN custom rules](https://developer.salesforce.com/docs/commerce/commerce-api/guide/cdn-zones-custom-rules.html) moving forward. Any existing firewall rules are accessible and can be updated using the custom rule endpoints.
         responses:
           '204':
             description: Successfully deleted the firewall rule specified by the caller.

apis/cdn/cdn-api-process-apis/exchange.json

@@ -18,7 +18,7 @@
   "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8",
   "organizationId": "893f605e-10e2-423a-bdb4-f952f56eb6d8",
   "assetId": "cdn-api-process-apis",
-  "version": "1.0.29",
+  "version": "1.0.30",
   "apiVersion": "v1",
   "originalFormatVersion": "1.0"
 }

apis/checkout/orders/.metadata.json

@@ -1,10 +1,10 @@
 {
-  "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/orders/1.3.9",
+  "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/orders/1.4.2",
   "name": "Orders",
   "description": "Manage order and order payment status.",
   "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8",
   "assetId": "orders",
-  "version": "1.3.9",
+  "version": "1.4.2",
   "categories": {
     "API layer": [
       "Process"

apis/checkout/orders/create-order-description.md

@@ -12,6 +12,8 @@ Other than the Basket API, this endpoint decouples any relation to other system
 
 The order isn't treated differently than any other orders in the Commerce Cloud platform, and any status updates or order exports behave the same.
 
+**Note**: For the custom attribute to be available for orders, configure it in Business Manager for both Basket and Order objects.
+
 **Important**: This endpoint uses the `ShopperTokenTsob` security scheme. Always check the Security section of the endpoint documentation, which is hidden by default.
 
 ## Preconditions

apis/checkout/orders/data-types.raml

@@ -3,7 +3,7 @@
 usage: This library provides all order relevant data types
 
 uses:
-  CommerceCloudStandards: exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/1.0.26/commerce-cloud-standards.raml 
+  CommerceCloudStandards: exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/1.0.27/commerce-cloud-standards.raml 
 
 types:
   OrderUpdateRequest:
@@ -132,7 +132,14 @@ types:
       status:
         description:  |-
           The new status.
-        type: OrderStatus
+        type: string
+        enum:
+          - created
+          - new
+          - completed
+          - cancelled
+          - failed
+          - failed_with_reopen
         example:
           new
   ShippingAddressUpdateRequest:
@@ -161,7 +168,7 @@ types:
     properties:
       adjustedMerchandizeTotalTax?:
         description: |-
-          The total tax on products in the order, including price adjustments, but not including service charges such as shipping.
+         The total tax on products in the order, including price adjustments, but not including service charges such as shipping.
         type: number
         format: double
         example:

apis/checkout/orders/exchange.json

@@ -1 +1,26 @@
-{"main":"orders.raml","name":"Orders","classifier":"raml","tags":[],"dependencies":[{"groupId":"893f605e-10e2-423a-bdb4-f952f56eb6d8","assetId":"api-standards","version":"1.1.15"},{"groupId":"893f605e-10e2-423a-bdb4-f952f56eb6d8","assetId":"commerce-cloud-standards","version":"1.0.26"}],"groupId":"893f605e-10e2-423a-bdb4-f952f56eb6d8","backwardsCompatible":false,"assetId":"orders","version":"1.3.9","apiVersion":"v1","originalFormatVersion":"1.0"}
+{
+  "dependencies": [
+    {
+      "version": "1.1.15",
+      "assetId": "api-standards",
+      "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8"
+    },
+    {
+      "version": "1.0.27",
+      "assetId": "commerce-cloud-standards",
+      "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8"
+    }
+  ],
+  "version": "1.4.2",
+  "originalFormatVersion": "1.0",
+  "apiVersion": "v1",
+  "descriptorVersion": "0.1.0",
+  "classifier": "raml",
+  "main": "orders.raml",
+  "backwardsCompatible": false,
+  "assetId": "orders",
+  "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8",
+  "organizationId": "893f605e-10e2-423a-bdb4-f952f56eb6d8",
+  "name": "Orders",
+  "tags": []
+}

apis/checkout/orders/orders-description.md

@@ -19,6 +19,7 @@ Order Status can have one of these values:
 -   `created` - Default value; denotes that the order was created in the system but is not yet placed.
 -   `new` - Set this value to place the order. When you set this value, the system generates shipment and invoice numbers. After the order is placed, you can’t change its Order Status to `created` or `failed`.
 -   `failed` - Set this value to fail the order, for example, when you reject the order or when its payment fails. When you set this value, the system releases the order’s inventory reservations and removes any coupon redemptions. You can only set this value if the current Order Status is `created`. If you change the Order Status from `failed` to `created`, the system tries to revert the actions taken when it was set to `failed`. If inventory isn’t available, the reversion can fail.
+-   `failed_with_reopen` - Set this value to fail the order and reopen the basket, if applicable. The order status is set to `failed`.
 -   `completed` - Set this value to mark the order as complete, based on your business process. For example, when the order is fully paid, exported, and shipped.
 -   `cancelled` - Set this value to cancel the order, for example, when the shopper requests it. When you set this value, the system releases the order’s inventory reservations, restores any wishlist items, and removes any coupon redemptions. If you change the Order Status from `cancelled` to `completed` or `new`, the system tries to revert the actions taken when it was set to `cancelled`. If inventory isn’t available, the reversion can fail.
 
@@ -103,4 +104,8 @@ You can sort the results in ascending or descending order by these attributes (d
 
 ## Create Orders
 
-Use the Create Order endpoint to create orders from a third-party system, such as a social media platform. Before using the endpoint, you must complete the checkout process first: apply all sanity checks, reserve inventory, authorize payment, apply promotions, and calculate the full cost of the order. Orders made by third-party systems are treated the same way as order made directly through the B2C Commerce platform, including how status updates and exports are handled.
+Use the Create Order endpoint to create orders from a third-party system, such as a social media platform. Before using the endpoint, you must complete the checkout process first: apply all sanity checks, reserve inventory, authorize payment, apply promotions, and calculate the full cost of the order. Orders made by third-party systems are treated the same way as order made directly through the B2C Commerce platform, including how status updates and exports are handled.
+
+## Update Orders
+
+Use the Update Order endpoint to make changes to custom order attributes.