Release v6.0.0 (@W-20718643@)

CHANGELOG.md

@@ -1,5 +1,41 @@
 # CHANGELOG
 
+## v6.0.0
+
+### API Versions
+
+| API Name | API Version |
+|----------|-------------|
+| assignments | 1.0.38 |
+| campaigns | 1.0.40 |
+| catalogs | 1.0.46 |
+| cdn-api-process-apis | 1.0.41 |
+| cors-preferences | 1.0.9 |
+| coupons | 1.0.43 |
+| customers | 1.1.3 |
+| gift-certificates | 1.0.42 |
+| orders | 1.4.15 |
+| preferences | 1.1.6 |
+| products | 1.1.5 |
+| promotions | 1.0.36 |
+| shopper-baskets | 1.9.4 |
+| shopper-baskets | 2.3.3 |
+| shopper-configurations | 1.0.2 |
+| shopper-consents | 1.1.4 |
+| shopper-context | 1.1.3 |
+| shopper-customers | 1.3.2 |
+| shopper-experience | 1.1.2 |
+| shopper-gift-certificates | 1.0.29 |
+| shopper-login | 1.42.2 |
+| shopper-orders | 1.10.2 |
+| shopper-products | 1.1.3 |
+| shopper-promotions | 1.0.39 |
+| shopper-search | 1.5.4 |
+| shopper-seo | 1.0.17 |
+| shopper-stores | 1.0.19 |
+| slas-admin | 1.14.1 |
+| source-code-groups | 1.0.40 |
+
 ## v5.1.0
 
 ### API Versions

api-versions.txt

@@ -1,30 +1,30 @@
 # ECOM v26.2
-assignments-oas-v1=1.0.36
-campaigns-oas-v1=1.0.38
-catalogs-oas-v1=1.0.43
-cdn-api-process-apis-oas-v1=1.0.40
-cors-preferences-oas-v1=1.0.7
-coupons-oas-v1=1.0.40
-customers-oas-v1=1.0.33
-gift-certificates-oas-v1=1.0.40
-orders-oas-v1=1.4.11
-preferences-oas-v1=1.1.4
-products-oas-v1=1.0.41
-promotions-oas-v1=1.0.34
-shopper-baskets-oas-v1=1.9.1
-shopper-baskets-oas-v2=2.1.1
-shopper-configurations-oas=1.0.0
-shopper-consents-oas-v1=1.1.2
-shopper-context-oas-v1=1.1.2
-shopper-customers-oas-v1=1.1.2
-shopper-experience-oas-v1=1.0.9
-shopper-gift-certificates-oas-v1=1.0.27
-shopper-login-oas-v1=1.40.0
-shopper-orders-oas-v1=1.5.1
-shopper-products-oas-v1=1.0.39
-shopper-promotions-oas-v1=1.0.37
-shopper-search-oas-v1=1.5.1
-shopper-seo-oas-v1=1.0.14
-shopper-stores-oas-v1=1.0.18
-slas-admin-oas-v1=1.12.31
-source-code-groups-oas-v1=1.0.38
+assignments-oas-v1=1.0.38
+campaigns-oas-v1=1.0.40
+catalogs-oas-v1=1.0.46
+cdn-api-process-apis-oas-v1=1.0.41
+cors-preferences-oas-v1=1.0.9
+coupons-oas-v1=1.0.43
+customers-oas-v1=1.1.3
+gift-certificates-oas-v1=1.0.42
+orders-oas-v1=1.4.15
+preferences-oas-v1=1.1.6
+products-oas-v1=1.1.5
+promotions-oas-v1=1.0.36
+shopper-baskets-oas-v1=1.9.4
+shopper-baskets-oas-v2=2.3.3
+shopper-configurations-oas=1.0.2
+shopper-consents-oas-v1=1.1.4
+shopper-context-oas-v1=1.1.3
+shopper-customers-oas-v1=1.3.2
+shopper-experience-oas-v1=1.1.2
+shopper-gift-certificates-oas-v1=1.0.29
+shopper-login-oas-v1=1.42.2
+shopper-orders-oas-v1=1.10.2
+shopper-products-oas-v1=1.1.3
+shopper-promotions-oas-v1=1.0.39
+shopper-search-oas-v1=1.5.4
+shopper-seo-oas-v1=1.0.17
+shopper-stores-oas-v1=1.0.19
+slas-admin-oas-v1=1.14.1
+source-code-groups-oas-v1=1.0.40

apis/assignments-oas-1.0.36/assignments-oas-v1-public.yaml → apis/assignments-oas-1.0.38/assignments-oas-v1-public.yaml

@@ -1,7 +1,9 @@
 openapi: 3.0.3
 info:
+  x-api-type: Admin
+  x-api-family: Pricing
   title: Assignments
-  version: 1.0.36
+  version: 1.0.38
   description: "[Download API specification](https://developer.salesforce.com/static/commercecloud/commerce-api/assignments/assignments-oas-v1-public.yaml)\n\n# API Overview\n\nUse the Assignments API to search for promotions associated with campaigns.\n\nFor more information, see [Campaigns and Promotions](https://documentation.b2c.commercecloud.salesforce.com/DOC1/topic/com.demandware.dochelp/Promotions/CampaignsandPromotions.html) in the Salesforce B2C Commerce Infocenter.\n\n## Authentication & Authorization\n\nThe client requesting the promotion information must have access to the Promotion resource. For resource access, you must use a client ID and client secret from Account Manager to request an access token. The access token is used as a bearer token and added to the Authorization header of your API request. The client must first authenticate against Account Manager to log in.\n\nYou must include the relevant scope(s) in the client ID used to generate the token. For details, see [Authorization Scopes Catalog.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/auth-z-scope-catalog.html)\n\nFor detailed setup instructions, see [Authorization for Admin APIs](https://developer.salesforce.com/docs/commerce/commerce-api/guide/authorization-for-admin-apis.html).\n\n## Use Cases\n\n### Find All Associated Promotions\n\nUse the Assignments API to find all associated promotions for a given campaign. "
 servers:
   - url: https://{shortCode}.api.commercecloud.salesforce.com/pricing/assignments/v1
@@ -63,13 +65,6 @@ components:
       description: The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites
       example: RefArch
       type: string
-    Limit:
-      default: 10
-      minimum: 1
-      format: int32
-      description: Maximum records to retrieve per request, not to exceed the maximum defined. A limit must be at least 1 so at least one record is returned (if any match the criteria).
-      type: integer
-      example: 10
     Query:
       minProperties: 1
       maxProperties: 1
@@ -555,10 +550,11 @@ components:
       properties:
         limit:
           description: Maximum records to retrieve per request, not to exceed 200.
+          type: integer
+          format: int32
+          minimum: 1
           example: 10
           maximum: 200
-          allOf:
-            - $ref: '#/components/schemas/Limit'
         query:
           $ref: '#/components/schemas/Query'
         sorts:
@@ -585,9 +581,10 @@ components:
         - total
       properties:
         limit:
-          maximum: 200
-          allOf:
-            - $ref: '#/components/schemas/Limit'
+          format: int32
+          description: Maximum records to retrieve per request. The limit with its constraints (minimum, maximum, default) is defined by the request parameter `limit` of the endpoint returning this schema.
+          type: integer
+          example: 10
         total:
           $ref: '#/components/schemas/Total'
     PaginatedResultBase:

apis/assignments-oas-1.0.36/exchange.json → apis/assignments-oas-1.0.38/exchange.json

@@ -3,7 +3,7 @@
   "name": "Assignments OAS",
   "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8",
   "assetId": "assignments-oas",
-  "version": "1.0.36",
+  "version": "1.0.38",
   "classifier": "oas",
   "tags": [],
   "descriptorVersion": "1.0.0",

apis/campaigns-oas-1.0.38/campaigns-oas-v1-public.yaml → apis/campaigns-oas-1.0.40/campaigns-oas-v1-public.yaml

@@ -1,7 +1,9 @@
 openapi: 3.0.3
 info:
+  x-api-type: Admin
+  x-api-family: Pricing
   title: Campaigns
-  version: 1.0.38
+  version: 1.0.40
   description: |-
     [Download API specification](https://developer.salesforce.com/static/commercecloud/commerce-api/campaigns/campaigns-oas-v1-public.yaml)
 
@@ -271,13 +273,6 @@ components:
       description: The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites
       example: RefArch
       type: string
-    Limit:
-      default: 10
-      minimum: 1
-      format: int32
-      description: Maximum records to retrieve per request, not to exceed the maximum defined. A limit must be at least 1 so at least one record is returned (if any match the criteria).
-      type: integer
-      example: 10
     Query:
       minProperties: 1
       maxProperties: 1
@@ -763,10 +758,11 @@ components:
       properties:
         limit:
           description: Maximum records to retrieve per request, not to exceed 200.
+          type: integer
+          format: int32
+          minimum: 1
           example: 10
           maximum: 200
-          allOf:
-            - $ref: '#/components/schemas/Limit'
         query:
           $ref: '#/components/schemas/Query'
         sorts:
@@ -793,9 +789,10 @@ components:
         - total
       properties:
         limit:
-          maximum: 200
-          allOf:
-            - $ref: '#/components/schemas/Limit'
+          format: int32
+          description: Maximum records to retrieve per request. The limit with its constraints (minimum, maximum, default) is defined by the request parameter `limit` of the endpoint returning this schema.
+          type: integer
+          example: 10
         total:
           $ref: '#/components/schemas/Total'
     PaginatedResultBase:

apis/campaigns-oas-1.0.38/exchange.json → apis/campaigns-oas-1.0.40/exchange.json

@@ -3,7 +3,7 @@
   "name": "Campaigns OAS",
   "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8",
   "assetId": "campaigns-oas",
-  "version": "1.0.38",
+  "version": "1.0.40",
   "classifier": "oas",
   "tags": [],
   "descriptorVersion": "1.0.0",

apis/catalogs-oas-1.0.43/catalogs-oas-v1-public.yaml → apis/catalogs-oas-1.0.46/catalogs-oas-v1-public.yaml

@@ -3,7 +3,7 @@ info:
   x-api-type: Admin
   x-api-family: Product
   title: Catalogs
-  version: 1.0.43
+  version: 1.0.46
   description: |-
     [Download API specification](https://developer.salesforce.com/static/commercecloud/commerce-api/catalogs/catalogs-oas-v1-public.yaml)
 
@@ -22,7 +22,9 @@ info:
 
     The client managing catalog and category information must have access to the Categories and Catalogs resources. This API requires a bearer token in the header of the request. The client accessing the API must first authenticate against Account Manager to get the bearer token.
 
-    You must include the relevant scope(s) in the client ID used to generate the SLAS token. For details, see the  [Authorization Scopes Catalog.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/auth-z-scope-catalog.html)
+    You must include the relevant scope(s) in the client ID used to generate the token. For a full list of required permissions, see the [Authorization Scopes Catalog.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/auth-z-scope-catalog.html)
+
+    For detailed setup instructions, see the [Authorization for Admin APIs guide.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/authorization-for-admin-apis.html)
 
     ## Use Cases
 
@@ -88,7 +90,7 @@ paths:
           required: false
           schema:
             type: integer
-            format: int64
+            format: int32
             default: 0
             minimum: 0
           description: Used to retrieve the results based on a particular resource offset.
@@ -242,7 +244,7 @@ paths:
           required: false
           schema:
             type: integer
-            format: int64
+            format: int32
             default: 0
             minimum: 0
           description: Used to retrieve the results based on a particular resource offset.
@@ -2013,13 +2015,6 @@ components:
       type: string
       minLength: 1
       maxLength: 32
-    Limit:
-      default: 10
-      minimum: 1
-      format: int32
-      description: Maximum records to retrieve per request, not to exceed the maximum defined. A limit must be at least 1 so at least one record is returned (if any match the criteria).
-      type: integer
-      example: 10
     Total:
       default: 0
       minimum: 0
@@ -2035,9 +2030,10 @@ components:
         - total
       properties:
         limit:
-          maximum: 200
-          allOf:
-            - $ref: '#/components/schemas/Limit'
+          format: int32
+          description: Maximum records to retrieve per request. The limit with its constraints (minimum, maximum, default) is defined by the request parameter `limit` of the endpoint returning this schema.
+          type: integer
+          example: 10
         total:
           $ref: '#/components/schemas/Total'
     Offset:
@@ -2976,10 +2972,11 @@ components:
       properties:
         limit:
           description: Maximum records to retrieve per request, not to exceed 200.
+          type: integer
+          format: int32
+          minimum: 1
           example: 10
           maximum: 200
-          allOf:
-            - $ref: '#/components/schemas/Limit'
         query:
           $ref: '#/components/schemas/Query'
         sorts:
@@ -3516,24 +3513,11 @@ components:
             format: double
           description: prices
       description: Representation of a group of variant products by an attribute. This is a non-buyable entity, provides inheritable attributes for it's product variants, and is used for navigation. *Does'nt have a SKU.*
-    ISOCurrency:
-      pattern: ^[A-Z][A-Z][A-Z]$
-      description: A three letter uppercase currency code conforming to the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard.
-      example: USD
-      type: string
-    NoValue:
-      default: N/A
-      description: A specialized value indicating the lack of definition of a currency, for example, if the value of the monetary value of the currency is an undefined number.
-      example: N/A
-      enum:
-        - N/A
-      type: string
     CurrencyCode:
       description: A three letter uppercase currency code conforming to the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard, or the string `N/A` indicating that a currency is not applicable.
+      pattern: ^([A-Z][A-Z][A-Z]|N/A)$
       example: USD
-      oneOf:
-        - $ref: '#/components/schemas/ISOCurrency'
-        - $ref: '#/components/schemas/NoValue'
+      type: string
     Money:
       description: A combination of a Currency and an amount of that Currency.
       type: object
@@ -3872,6 +3856,13 @@ components:
             offset: 2
             total: 8
       additionalProperties: false
+    Limit:
+      default: 10
+      minimum: 1
+      format: int32
+      description: Maximum records to retrieve per request, not to exceed the maximum defined. A limit must be at least 1 so at least one record is returned (if any match the criteria).
+      type: integer
+      example: 10
     ExecutionJobStatusResult:
       required:
         - jobStatus

apis/catalogs-oas-1.0.43/exchange.json → apis/catalogs-oas-1.0.46/exchange.json

@@ -3,7 +3,7 @@
   "name": "Catalogs OAS",
   "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8",
   "assetId": "catalogs-oas",
-  "version": "1.0.43",
+  "version": "1.0.46",
   "classifier": "oas",
   "tags": [],
   "descriptorVersion": "1.0.0",