@salesforce/b2c-tooling-sdk 1.24.2 → 2.1.0

package/specs/product-catalogs-v1.yaml

@@ -0,0 +1,111 @@
+openapi: 3.0.3
+info:
+  title: Catalogs
+  version: 1.0.46
+  x-api-type: Admin
+  x-api-family: Product
+servers:
+  - url: https://{shortCode}.api.commercecloud.salesforce.com/product/catalogs/v1
+    variables:
+      shortCode:
+        default: shortCode
+paths:
+  /organizations/{organizationId}/catalogs:
+    get:
+      operationId: getCatalogs
+      parameters:
+        - name: organizationId
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: limit
+          in: query
+          schema:
+            type: integer
+            format: int32
+            default: 25
+            maximum: 50
+        - name: offset
+          in: query
+          schema:
+            type: integer
+            format: int32
+            default: 0
+            minimum: 0
+      responses:
+        '200':
+          description: Catalogs retrieved successfully.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Catalogs'
+        '400':
+          description: Bad Request
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '401':
+          description: Unauthorized
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+      security:
+        - AmOAuth2: [sfcc.catalogs, sfcc.catalogs.rw]
+components:
+  schemas:
+    Catalog:
+      type: object
+      additionalProperties: true
+      required: [id]
+      properties:
+        id:
+          type: string
+        name:
+          type: object
+          additionalProperties:
+            type: string
+        description:
+          type: object
+          additionalProperties:
+            type: string
+        online:
+          type: boolean
+    Catalogs:
+      type: object
+      required: [data, limit, offset, total]
+      properties:
+        data:
+          type: array
+          items:
+            $ref: '#/components/schemas/Catalog'
+        limit:
+          type: integer
+        offset:
+          type: integer
+        total:
+          type: integer
+    ErrorResponse:
+      type: object
+      additionalProperties: true
+      required: [detail, title, type]
+      properties:
+        title:
+          type: string
+        type:
+          type: string
+        detail:
+          type: string
+        instance:
+          type: string
+  securitySchemes:
+    AmOAuth2:
+      type: oauth2
+      flows:
+        clientCredentials:
+          tokenUrl: https://account.demandware.com/dwsso/oauth2/access_token
+          scopes:
+            sfcc.catalogs: catalogs scope READONLY
+            sfcc.catalogs.rw: catalogs scope