openapi: 3.0.1
info:
  title: Cart Actions Endpoints Catalog Connector Operations by Item ID API
  description: fabric's **Cart API** lets you add, update, and remove items from your Storefront cart, either as a guest user or as a logged-in user. It also provides functionality to merge carts when you switch from guest user to logged-in user, and apply coupons and other attributes (for example, gift wrapping) to the line items. Additionally, the API supports more advanced tasks such as using multiple carts within a B2B organization, sharing carts, and supporting a unified cart experience for multi-region and multi-brand businesses.<p>The Cart API provides high performance, scalability, multi-tenancy, and configurability to the end-to-end order processing actions that start from the item being added to the cart; through the pre-checkout stage that includes billing, shipping, and payment details; to the checkout stage where the order is processed and confirmed by fabric's Order Management System (OMS)
  contact:
    name: Cart Support
    email: support.cnc@fabric.inc
  license:
    name: fabric API License
    url: https://fabric.inc/api-license
  version: 3.0.0
servers:
- url: https://api.fabric.inc/v3
security:
- bearerAuth: []
tags:
- name: Catalog Connector Operations by Item ID
  description: Supports product operations based on Item ID.
paths:
  /catalog-connector/products/itemIds/{itemId}:
    get:
      tags:
      - Catalog Connector Operations by Item ID
      summary: Retrieve a Product or a Variant by Item ID
      description: "Use this endpoint to retrieve a single product by its `itemId`. You must specify the query parameters `itemId` and `locale`. Optionally, you can set the following query parameters to `true` to refine the search results:\nYou must specify the query parameters `itemId` and `locale`. \nOptionally, you can set the following query parameters to `true` to refine the search results:\n  - `excludeBundleProducts`: Exclude bundled products from the response.\n  - `excludeCollections`: Exclude collections from the response.\n  - `excludeCategories`: Exclude categories from the response.\n  - `excludeAttributes`: Exclude attributes from the response. \n  - `excludeVariants`: Exclude variants from the response. \n\nIf you don't have the `itemId`, use one of the endpoints to retrieve the product: \n    - [Update a product by SKU](/v3/api-reference/catalog-connector/operations/sku-operations/update-with-sku). \n    - [Update a product by product ID](/v3/api-reference/catalog-connector/operations/product-operations/update-by-product).\n"
      operationId: getCatalogByItemId
      parameters:
      - in: path
        name: itemId
        schema:
          type: integer
          format: int32
        required: true
        example: 123431
        description: A sequential system-generated item ID.
      - $ref: '#/components/parameters/localeParameter'
      - $ref: '#/components/parameters/xFabricTenantId'
      - $ref: '#/components/parameters/xFabricRequestId'
      - $ref: '#/components/parameters/excludeBundleProductsParameter'
      - $ref: '#/components/parameters/excludeCollectionsParameter'
      - $ref: '#/components/parameters/excludeCategoriesParameter'
      - $ref: '#/components/parameters/excludeAttributesParameter'
      - $ref: '#/components/parameters/excludeVariantsParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/product'
              examples:
                Product:
                  $ref: '#/components/examples/ItemExample'
                Variant:
                  $ref: '#/components/examples/variantExample'
                Bundle:
                  $ref: '#/components/examples/bundleExample'
          headers:
            x-fabric-request-id:
              $ref: '#/components/headers/xFabricRequestId'
        '400':
          $ref: '#/components/responses/badRequest'
        '401':
          $ref: '#/components/responses/notAuthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/notFoundError'
        '413':
          $ref: '#/components/responses/payloadLimitExceededError'
        '500':
          $ref: '#/components/responses/internalServerError'
    put:
      tags:
      - Catalog Connector Operations by Item ID
      summary: Update a Product by the Item ID.
      description: "Use this endpoint to update a single product by using its `itemId`. You can update the product's details, such as its name, category details, product images, attributes, and collections. However, you can't update the `itemId`. The new data completely replaces the existing data. \nYou can update the product's details, such as its name, category details, product images, attributes, and collections. However, you can't update the itemId. The new data completely replaces the existing data. \n\nIf you don't have the `itemId`, use the one of the endpoints to delete the product:\n  - [Update a product by SKU](/v3/api-reference/catalog-connector/operations/sku-operations/update-with-sku).\n  - [Update a product by product ID](/v3/api-reference/catalog-connector/operations/product-operations/update-by-product).\n"
      operationId: updateCategoryByItemId
      parameters:
      - in: path
        name: itemId
        schema:
          type: integer
          format: int32
        required: true
        example: 123431
        description: A sequential system-generated item ID.
      - $ref: '#/components/parameters/localeParameter'
      - $ref: '#/components/parameters/xFabricTenantId'
      - $ref: '#/components/parameters/xFabricRequestId'
      requestBody:
        $ref: '#/components/requestBodies/putCatalogRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/product'
              examples:
                Product:
                  $ref: '#/components/examples/ItemExample'
                Variant:
                  $ref: '#/components/examples/variantExample'
                Bundle:
                  $ref: '#/components/examples/bundleExample'
          headers:
            x-fabric-request-id:
              $ref: '#/components/headers/xFabricRequestId'
        '400':
          $ref: '#/components/responses/badRequest'
        '401':
          $ref: '#/components/responses/notAuthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/notFoundError'
        '413':
          $ref: '#/components/responses/payloadLimitExceededError'
        '500':
          $ref: '#/components/responses/internalServerError'
    delete:
      tags:
      - Catalog Connector Operations by Item ID
      summary: Delete a Product by Item ID
      description: "Use this endpoint to delete a single product by its `itemId`. \n\nIf you don't have the `itemId`, use one of the endpoints to delete the product: \n  - [Delete a product by SKU](/v3/api-reference/catalog-connector/operations/sku-operations/delete-with-sku). \n  - [Delete a product by product ID](/v3/api-reference/catalog-connector/operations/product-operations/delete-by-product).\n"
      operationId: deleteCatalogsByItem ID
      parameters:
      - in: path
        name: itemId
        schema:
          type: integer
          format: int32
        required: true
        example: 123431
        description: A sequential system-generated item ID.
      - $ref: '#/components/parameters/localeParameter'
      - $ref: '#/components/parameters/xFabricTenantId'
      - $ref: '#/components/parameters/xFabricRequestId'
      responses:
        '204':
          headers:
            x-fabric-request-id:
              $ref: '#/components/headers/xFabricRequestId'
          description: No Content
        '400':
          $ref: '#/components/responses/badRequest'
        '401':
          $ref: '#/components/responses/notAuthorized'
        '500':
          $ref: '#/components/responses/internalServerError'
components:
  requestBodies:
    putCatalogRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/putCatalogRequestSchema'
          examples:
            Item:
              $ref: '#/components/examples/ItemUpdateExample'
            Variant:
              $ref: '#/components/examples/variantUpdateExample'
            Bundle:
              $ref: '#/components/examples/bundleUpdateExample'
  parameters:
    localeParameter:
      name: locale
      in: query
      example: en-US
      description: "The language code, which is a combination of language (ISO 639 format) and country (ISO 3166 format). \n\nThe default value is en-US.\n"
      schema:
        type: string
      required: true
    xFabricTenantId:
      in: header
      name: x-fabric-tenant-id
      schema:
        type: string
      required: true
      example: 5f328bf0b5f328bf0b5f328b
      description: A header retrieved from your [Copilot Account Details](/v3/platform/settings/account-details/getting-the-account-id) that's used by the API to identify the tenant making the request. Tenant ID must be included in the authentication header for API requests to access any of fabric’s endpoints.
    excludeBundleProductsParameter:
      name: excludeBundleProducts
      in: query
      example: false
      description: A flag indicating whether the products associated with a bundle should be excluded from the response. Set it to `true` to exclude products of a bundle and `false` to include them in the response.
      schema:
        type: boolean
      required: false
    excludeCategoriesParameter:
      name: excludeCategories
      in: query
      example: false
      description: A flag indicating whether the categories should be excluded from the response. Set it to `true` to exclude categories and `false` to include them in the response.
      schema:
        type: boolean
      required: false
    excludeVariantsParameter:
      name: excludeVariants
      in: query
      example: false
      description: A flag indicating whether item variants should be excluded from the response. Set it to `true` to exclude variants and `false` to include them in the response.
      schema:
        type: boolean
      required: false
    excludeCollectionsParameter:
      name: excludeCollections
      in: query
      example: false
      description: A flag indicating whether the collections should be excluded from the response. Set it to `true` to exclude collections and `false` to include them in the response.
      schema:
        type: boolean
      required: false
    excludeAttributesParameter:
      name: excludeAttributes
      in: query
      example: false
      description: A flag indicating whether attributes should be excluded from the response. Set it to `true` to exclude attributes and `false` to include them in the response.
      schema:
        type: boolean
      required: false
    xFabricRequestId:
      in: header
      name: x-fabric-request-id
      description: Unique request ID
      schema:
        type: string
      example: 263e731c-45c8-11ed-b878-0242ac120002
      required: false
  responses:
    internalServerError:
      description: Internal server error
      headers:
        x-fabric-request-id:
          $ref: '#/components/headers/xFabricRequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/genericError'
          example:
            type: SERVER_ERROR
            message: Internal Server Error
    forbidden:
      description: The user isn't allowed to perform this action.
      headers:
        x-fabric-request-id:
          $ref: '#/components/headers/xFabricRequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/genericError'
          example:
            type: REQUEST_DENIED
            message: User does not have the required permission
    payloadLimitExceededError:
      description: The payload limit is exceeded. It should be less than 10MB.
      headers:
        x-fabric-request-id:
          $ref: '#/components/headers/xFabricRequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/genericError'
          example:
            type: PAYLOAD_LIMIT_EXCEEDED_ERROR
            message: Payload exceeds maximum configured size
    badRequest:
      description: Request is invalid or malformed
      headers:
        x-fabric-request-id:
          $ref: '#/components/headers/xFabricRequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/genericError'
    notFoundError:
      description: The requested entity isn't found
      headers:
        x-fabric-request-id:
          $ref: '#/components/headers/xFabricRequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/genericError'
          example:
            type: NOT_FOUND
            message: Resource not found
    notAuthorized:
      description: The requester is unauthorized.
      headers:
        x-fabric-request-id:
          $ref: '#/components/headers/xFabricRequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/genericError'
          example:
            type: UNAUTHORIZED_ERROR
            message: Requester is unauthorized
  schemas:
    bundleProductSchema:
      description: The details of the bundle.
      type: object
      properties:
        quantity:
          type: integer
          format: int32
          description: The quantity of the bundle.
          example: 2
        type:
          $ref: '#/components/schemas/productType'
      allOf:
      - $ref: '#/components/schemas/commonProductSchemaWithIdentifiers'
    booleanSchema:
      type: boolean
      nullable: true
      description: Represents a boolean schema.
      example: true
    commonProductSchemaWithIdentifiers:
      allOf:
      - $ref: '#/components/schemas/commonProductSchema'
      type: object
      description: A common schema for product, variants, and bundles along with their identifiers.
      properties:
        sku:
          $ref: '#/components/schemas/sku'
        id:
          $ref: '#/components/schemas/id'
        itemId:
          type: integer
          format: int32
          example: 1682313863
          description: A unique identifier of an item, a variant or a bundle.
    bundleCatalog:
      description: The details of a bundle.
      allOf:
      - $ref: '#/components/schemas/extendedCommonProductSchema'
      type: object
      properties:
        type:
          $ref: '#/components/schemas/bundleProductType'
        bundleProducts:
          type: array
          description: The details of a bundle.
          items:
            $ref: '#/components/schemas/bundleProductSchema'
    putCatalogRequestSchema:
      description: A sample request to update a product.
      anyOf:
      - $ref: '#/components/schemas/putItemCatalogRequestSchema'
      - $ref: '#/components/schemas/putVariantCatalogRequestSchema'
      - $ref: '#/components/schemas/putBundleCatalogRequestSchema'
    integerSchema:
      type: integer
      nullable: true
      format: int32
      description: Represents an integer schema.
      example: 1
    extendedCommonProductSchema:
      description: Additional details of a product.
      allOf:
      - $ref: '#/components/schemas/commonProductSchemaWithIdentifiers'
      type: object
      properties:
        categoryName:
          type: string
          description: The name of the category.
          example: Shoes
        categoryId:
          type: string
          description: A 24-character system-generated category ID.
          example: 648055dff4aa98d6c43e02da
        categories:
          type: array
          description: The list of categories, including their paths from the leaf category to the root category.
          items:
            $ref: '#/components/schemas/category'
        collections:
          type: array
          description: The details of the collection used to display products on the storefront.
          items:
            type: object
            additionalProperties: false
            description: The collection details.
            properties:
              id:
                type: string
                description: A 24-character system-generated collection ID.
                example: 648014741adc8a9de14e1a68
              name:
                type: string
                description: The name of the collection.
                example: Flash Sale
              hierarchy:
                type: array
                description: The list of collections, including their paths from the leaf collection to the root collection.
                items:
                  $ref: '#/components/schemas/category'
    id:
      type: string
      example: 5f7329dfd5288b0011332366
      description: A 24-character system-generated ID.
    productType:
      type: string
      description: The type of product.
      enum:
      - BUNDLE
      - VARIANT
      - ITEM
      example: ITEM
    stringSchema:
      type: string
      nullable: true
      description: Represents a string schema.
      example: blue
    putVariantCatalogRequestSchema:
      allOf:
      - $ref: '#/components/schemas/putCommonCatalogRequestSchema'
      type: object
      additionalProperties: false
      description: A sample request to update a variant.
      properties:
        type:
          $ref: '#/components/schemas/variantProductType'
        parentSku:
          $ref: '#/components/schemas/sku'
    variantProductType:
      type: string
      description: Represents the `variant` product type.
      enum:
      - VARIANT
      example: VARIANT
    attributeId:
      type: string
      description: A 24-character system-generated attribute ID.
      example: 6480216349256438cb7d53b5
    variantCatalog:
      description: The details of an item variant.
      allOf:
      - $ref: '#/components/schemas/extendedCommonProductSchema'
      type: object
      properties:
        type:
          $ref: '#/components/schemas/variantProductType'
        parentSku:
          $ref: '#/components/schemas/sku'
        parentId:
          type: string
          description: A 24-character system-generated ID of the parent item.
          example: 648014741adc8a9de14e1a68
    attribute:
      type: object
      additionalProperties: false
      description: The details of the attribute.
      properties:
        name:
          $ref: '#/components/schemas/attributeName'
        value:
          $ref: '#/components/schemas/attributeValue'
        id:
          $ref: '#/components/schemas/attributeId'
        type:
          $ref: '#/components/schemas/attributeType'
    doubleSchema:
      type: number
      nullable: true
      format: double
      description: Represents a double schema.
      example: 1
    attributeValue:
      anyOf:
      - $ref: '#/components/schemas/booleanSchema'
      - $ref: '#/components/schemas/stringSchema'
      - $ref: '#/components/schemas/integerSchema'
      - $ref: '#/components/schemas/doubleSchema'
      - $ref: '#/components/schemas/arrayOfStringsSchema'
      example: false
      description: The attribute value.
    itemProductType:
      type: string
      description: Represents the `item` product type.
      enum:
      - ITEM
      example: ITEM
    product:
      description: The details of a product based on the product type.
      anyOf:
      - $ref: '#/components/schemas/itemCatalog'
      - $ref: '#/components/schemas/variantCatalog'
      - $ref: '#/components/schemas/bundleCatalog'
    attributeName:
      type: string
      description: The name of the attribute.
      example: isOnSale
    itemCatalog:
      description: The details of an item.
      allOf:
      - $ref: '#/components/schemas/extendedCommonProductSchema'
      type: object
      properties:
        type:
          $ref: '#/components/schemas/itemProductType'
        variants:
          type: array
          description: The details of item variants.
          items:
            $ref: '#/components/schemas/commonProductSchemaWithIdentifiers'
    attributeType:
      type: string
      description: The type of attribute.
      enum:
      - NUMBER
      - BOOLEAN
      - TEXT
      - LOV
      example: TEXT
    arrayOfStringsSchema:
      type: array
      description: Represents an array of string schema.
      items:
        type: string
        nullable: true
        description: Represents a string schema.
    bundleProductType:
      type: string
      description: Represents the `bundle` product type.
      enum:
      - BUNDLE
      example: BUNDLE
    putBundleCatalogRequestSchema:
      allOf:
      - $ref: '#/components/schemas/putCommonCatalogRequestSchema'
      type: object
      additionalProperties: false
      description: A sample request to update a bundle.
      properties:
        type:
          $ref: '#/components/schemas/bundleProductType'
        bundleProducts:
          type: array
          description: The details of a bundle.
          items:
            $ref: '#/components/schemas/bundleProductSchema'
    commonProductSchema:
      type: object
      description: A common schema for product, variants, and bundles.
      properties:
        productName:
          type: string
          description: The name of the product.
          example: Nike Men's Training Shoe
        images:
          type: array
          description: The list of product images.
          items:
            type: string
          example:
          - https://myawsomestore.com/is/image/nike/8801290_s7
        attributes:
          type: array
          description: The name of the attribute and its value.
          items:
            $ref: '#/components/schemas/attribute'
        createdAt:
          type: string
          description: The time of product creation, in UTC format.
          format: date-time
          example: 2021-12-13 13:56:09.006000+00:00
        updatedAt:
          type: string
          description: The time of last update to product, in UTC format.
          format: date-time
          example: 2021-12-13 13:56:09.006000+00:00
    putCommonCatalogRequestSchema:
      allOf:
      - $ref: '#/components/schemas/commonProductSchema'
      type: object
      additionalProperties: false
      description: A sample request to update a product with common properties.
      properties:
        categoryName:
          type: string
          description: The name of the category. This value is overridden if the categories are populated.
          example: Sport Shoes
        categoryId:
          type: string
          description: A 24-character system-generated ID of the category.
          example: 648014741adc8a9de14e1a68
        categories:
          type: array
          description: The category details, including their paths from the leaf category to the root category.
          items:
            $ref: '#/components/schemas/category'
          example:
          - name: Sport Shoes
            id: 648014741adc8a9de14e1a68
            isRoot: false
            attributes:
            - name: Fit
              value: Relaxed Fit
              id: 648014741adc8a9de14e1a00
              type: TEXT
          - name: Shoes
            id: 648aa9258fdef29675dbce42
            isRoot: true
            attributes:
            - name: Material
              value: Mesh
        collections:
          type: array
          description: The details of the collection.
          items:
            type: object
            additionalProperties: false
            required:
            - name
            properties:
              name:
                type: string
                description: The name of the collection.
                example: Flash Sale
              id:
                type: string
                description: A 24-character system-generated collection ID.
                example: 648055dff4aa98d6c43e02da
              hierarchy:
                type: array
                description: The collections path from the leaf collection to the root collection.
                items:
                  $ref: '#/components/schemas/category'
          example:
          - name: Flash sale
            id: 648055dff4aa98d6c43e02da
            hierarchy:
            - name: Flash sale
              id: 648055dff4aa98d6c43e02da
              isRoot: false
              attributes:
              - name: Duration
                value: 600
                type: NUMBER
            - name: Sales
              id: 648055e0f4aa98d6c43e02f7
              isRoot: true
    putItemCatalogRequestSchema:
      allOf:
      - $ref: '#/components/schemas/putCommonCatalogRequestSchema'
      type: object
      additionalProperties: false
      description: A sample request to update an item.
      properties:
        type:
          $ref: '#/components/schemas/itemProductType'
        variants:
          type: array
          description: The details of the item variants.
          items:
            $ref: '#/components/schemas/commonProductSchemaWithIdentifiers'
    category:
      type: object
      additionalProperties: false
      description: The details of a category.
      properties:
        id:
          type: string
          description: A 24-character system-generated category ID.
          example: 648055dff4aa98d6c43e02da
        name:
          type: string
          description: The name of the category.
          example: Shoes
        isRoot:
          type: boolean
          description: A flag indicating whether the given category is a root category. Set it to `true` if it's a root category and `false` if it isn't a root category.
          example: true
        attributes:
          type: array
          description: The details of an attribute.
          items:
            $ref: '#/components/schemas/attribute'
    genericError:
      type: object
      description: The details of the error.
      properties:
        message:
          type: string
          description: A placeholder error message for all the 4xx, 5xx errors
          example: Request is invalid
        type:
          type: string
          description: A placeholder error type for all the 4xx, 5xx errors
          example: Bad request
        errors:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
                description: The error type.
                example: CLIENT_ERROR
              message:
                type: string
                description: The error message corresponding to the `type`.
                example: Invalid request. Unable to find/create product
    sku:
      type: string
      description: Product SKU
      example: 24ggs67-e89b-12e3-a456-026614174119
  examples:
    bundleExample:
      value:
        sku: BUNDLE237765
        productName: Nike runner shoes bundle
        id: 60ad7e9d858eb50007abbb19#2700540
        itemId: 2700540
        categoryName: Sport Shoes
        categoryId: 648014741adc8a9de14e1a68
        images:
        - https://myawsomestore.com/is/image/nike/8801290_s7
        - https://myawsomestore.com/is/image/nike/8801291_s7
        attributes:
        - name: Shoes Combo
          value: true
          type: BOOLEAN
        type: BUNDLE
        bundleProducts:
        - sku: NIKE237766
          quantity: 1
          productName: Nike runner white shoes
          id: 648aa9280d7b561b4663038c
          itemId: 2700538
          type: VARIANT
          images:
          - https://myawsomestore.com/is/image/nike/8801291_s7
          attributes:
          - name: Color
            value: White
            id: 6480216349256438cb7d53b5
            type: TEXT
          - name: Wide Fit
            value: true
            id: 640db94f9fc28b255d155a42
            type: BOOLEAN
          createdAt: 2021-12-13 13:56:09.006000+00:00
          updatedAt: 2021-12-13 13:56:09.006000+00:00
        - sku: NIKE237765
          quantity: 1
          productName: Nike runner shoes
          id: 6482b9524ffa4978fd9cbf5c
          itemId: 2700537
          type: ITEM
          images:
          - https://myawsomestore.com/is/image/nike/8801290_s7
          attributes:
          - name: Color
            value: black
            id: 6480216349256438cb7d53b5
            type: TEXT
          - name: Wide Fit
            value: false
            id: 640db94f9fc28b255d155a42
            type: BOOLEAN
          createdAt: 2021-12-13 13:56:09.006000+00:00
          updatedAt: 2021-12-13 13:56:09.006000+00:00
        categories:
        - name: Sport Shoes
          id: 648014741adc8a9de14e1a68
          isRoot: false
          attributes:
          - name: Fit
            value: Relaxed Fit
            id: 648014741adc8a9de14e1a00
            type: TEXT
        - name: Shoes
          id: 648aa9258fdef29675dbce42
          isRoot: true
          attributes:
          - name: Material
            value: Mesh
        collections:
        - name: Flash sale
          id: 648055dff4aa98d6c43e02da
          hierarchy:
          - name: Flash Sale
            id: 648055dff4aa98d6c43e02da
            isRoot: false
            attributes:
            - name: Duration
              value: 600
              type: NUMBER
          - name: Sales
            id: 648055e0f4aa98d6c43e02f7
            isRoot: true
        createdAt: 2021-12-13 13:56:09.006000+00:00
        updatedAt: 2021-12-13 13:56:09.006000+00:00
    bundleUpdateExample:
      value:
        productName: Nike runner shoes bundle
        categoryName: Sport Shoes
        categoryId: 648014741adc8a9de14e1a68
        images:
        - https://myawsomestore.com/is/image/nike/8801290_s7
        - https://myawsomestore.com/is/image/nike/8801291_s7
        attributes:
        - name: Shoes Combo
          value: true
          type: BOOLEAN
        type: BUNDLE
        bundleProducts:
        - sku: NIKE237766
          quantity: 1
          productName: Nike runner white shoes
          id: 648aa9280d7b561b4663038c
          itemId: 2700538
          type: VARIANT
          images:
          - https://myawsomestore.com/is/image/nike/8801291_s7
          attributes:
          - name: Color
            value: White
            id: 6480216349256438cb7d53b5
            type: TEXT
          - name: Wide Fit
            value: true
            id: 640db94f9fc28b255d155a42
            type: BOOLEAN
          createdAt: 2021-12-13 13:56:09.006000+00:00
          updatedAt: 2021-12-13 13:56:09.006000+00:00
        - sku: NIKE237765
          quantity: 1
          productName: Nike runner shoes
          id: 6482b9524ffa4978fd9cbf5c
          itemId: 2700537
          type: ITEM
          images:
          - https://myawsomestore.com/is/image/nike/8801290_s7
          attributes:
          - name: Color
            value: black
            id: 6480216349256438cb7d53b5
            type: TEXT
          - name: Wide Fit
            value: false
            id: 640db94f9fc28b255d155a42
            type: BOOLEAN
          createdAt: 2021-12-13 13:56:09.006000+00:00
          updatedAt: 2021-12-13 13:56:09.006000+00:00
        categories:
        - name: Sport Shoes
          id: 648014741adc8a9de14e1a68
          isRoot: false
          attributes:
          - name: Fit
            value: Relaxed Fit
            id: 648014741adc8a9de14e1a00
            type: TEXT
        - name: Shoes
          id: 648aa9258fdef29675dbce42
          isRoot: true
          attributes:
          - name: Material
            value: Mesh
        collections:
        - name: Flash sale
          id: 648055dff4aa98d6c43e02da
          hierarchy:
          - name: Flash Sale
            id: 648055dff4aa98d6c43e02da
            isRoot: false
            attributes:
            - name: Duration
              value: 600
              type: NUMBER
          - name: Sales
            id: 648055e0f4aa98d6c43e02f7
            isRoot: true
    ItemExample:
      value:
        sku: NIKE237765
        productName: Nike runner shoes
        id: 6482b9524ffa4978fd9cbf5c
        itemId: 2700537
        categoryName: Sport Shoes
        categoryId: 648014741adc8a9de14e1a68
        images:
        - https://myawsomestore.com/is/image/nike/8801290_s7
        attributes:
        - name: Color
          value: black
          id: 6480216349256438cb7d53b5
          type: TEXT
        - name: Wide Fit
          value: false
          id: 640db94f9fc28b255d155a42
          type: BOOLEAN
        type: ITEM
        variants:
        - sku: NIKE237766
          productName: Nike runner white shoes
          id: 648aa9280d7b561b4663038c
          itemId: 2700538
          images:
          - https://myawsomestore.com/is/image/nike/8801291_s7
          attributes:
          - name: Color
            value: White
            id: 6480216349256438cb7d53b5
            type: TEXT
          - name: Wide Fit
            value: true
            id: 640db94f9fc28b255d155a42
            type: BOOLEAN
          createdAt: 2021-12-13 13:56:09.006000+00:00
          updatedAt: 2021-12-13 13:56:09.006000+00:00
        categories:
        - name: Sport Shoes
          id: 648014741adc8a9de14e1a68
          isRoot: false
          attributes:
          - name: Fit
            value: Relaxed Fit
            id: 648014741adc8a9de14e1a00
            type: TEXT
        - name: Shoes
          id: 648aa9258fdef29675dbce42
          isRoot: true
          attributes:
          - name: Material
            value: Mesh
        collections:
        - name: Flash sale
          id: 648055dff4aa98d6c43e02da
          hierarchy:
          - name: Flash Sale
            id: 648055dff4aa98d6c43e02da
            isRoot: false
            attributes:
            - name: Duration
              value: 600
              type: NUMBER
          - name: Sales
            id: 648055e0f4aa98d6c43e02f7
            isRoot: true
        createdAt: 2021-12-13 13:56:09.006000+00:00
        updatedAt: 2021-12-13 13:56:09.006000+00:00
    ItemUpdateExample:
      value:
        productName: Nike runner shoes
        categoryName: Sport Shoes
        categoryId: 648014741adc8a9de14e1a68
        images:
        - https://myawsomestore.com/is/image/nike/8801290_s7
        attributes:
        - name: Color
          value: black
          id: 6480216349256438cb7d53b5
          type: TEXT
        - name: Wide Fit
          value: false
          id: 640db94f9fc28b255d155a42
          type: BOOLEAN
        type: ITEM
        variants:
        - sku: NIKE237766
          productName: Nike runner white shoes
          id: 648aa9280d7b561b4663038c
          itemId: 2700538
          images:
          - https://myawsomestore.com/is/image/nike/8801291_s7
          attributes:
          - name: Color
            value: White
            id: 6480216349256438cb7d53b5
            type: TEXT
          - name: Wide Fit
            value: true
            id: 640db94f9fc28b255d155a42
            type: BOOLEAN
          createdAt: 2021-12-13 13:56:09.006000+00:00
          updatedAt: 2021-12-13 13:56:09.006000+00:00
        categories:
        - name: Sport Shoes
          id: 648014741adc8a9de14e1a68
          isRoot: false
          attributes:
          - name: Fit
            value: Relaxed Fit
            id: 648014741adc8a9de14e1a00
            type: TEXT
        - name: Shoes
          id: 648aa9258fdef29675dbce42
          isRoot: true
          attributes:
          - name: Material
            value: Mesh
        collections:
        - name: Flash sale
          id: 648055dff4aa98d6c43e02da
          hierarchy:
          - name: Flash Sale
            id: 648055dff4aa98d6c43e02da
            isRoot: false
            attributes:
            - name: Duration
              value: 600
              type: NUMBER
          - name: Sales
            id: 648055e0f4aa98d6c43e02f7
            isRoot: true
    variantUpdateExample:
      value:
        productName: Nike runner white shoes
        categoryName: Sport Shoes
        categoryId: 648014741adc8a9de14e1a68
        images:
        - https://myawsomestore.com/is/image/nike/8801291_s7
        attributes:
        - name: Color
          value: White
          id: 6480216349256438cb7d53b5
          type: TEXT
        - name: Wide Fit
          value: true
          id: 640db94f9fc28b255d155a42
          type: BOOLEAN
        type: VARIANT
        parentSku: NIKE237765
        categories:
        - name: Sport Shoes
          id: 648014741adc8a9de14e1a68
          isRoot: false
          attributes:
          - name: Fit
            value: Relaxed Fit
            id: 648014741adc8a9de14e1a00
            type: TEXT
        - name: Shoes
          id: 648aa9258fdef29675dbce42
          isRoot: true
          attributes:
          - name: Material
            value: Mesh
        collections:
        - name: Flash sale
          id: 648055dff4aa98d6c43e02da
          hierarchy:
          - name: Flash Sale
            id: 648055dff4aa98d6c43e02da
            isRoot: false
            attributes:
            - name: Duration
              value: 600
              type: NUMBER
          - name: Sales
            id: 648055e0f4aa98d6c43e02f7
            isRoot: true
    variantExample:
      value:
        sku: NIKE237766
        productName: Nike runner white shoes
        id: 648aa9280d7b561b4663038c
        itemId: 2700538
        categoryName: Sport Shoes
        categoryId: 648014741adc8a9de14e1a68
        images:
        - https://myawsomestore.com/is/image/nike/8801291_s7
        attributes:
        - name: Color
          value: White
          id: 6480216349256438cb7d53b5
          type: TEXT
        - name: Wide Fit
          value: true
          id: 640db94f9fc28b255d155a42
          type: BOOLEAN
        type: VARIANT
        parentSku: NIKE237765
        parentId: 6482b9524ffa4978fd9cbf5c
        categories:
        - name: Sport Shoes
          id: 648014741adc8a9de14e1a68
          isRoot: false
          attributes:
          - name: Fit
            value: Relaxed Fit
            id: 648014741adc8a9de14e1a00
            type: TEXT
        - name: Shoes
          id: 648aa9258fdef29675dbce42
          isRoot: true
          attributes:
          - name: Material
            value: Mesh
        collections:
        - name: Flash sale
          id: 648055dff4aa98d6c43e02da
          hierarchy:
          - name: Flash Sale
            id: 648055dff4aa98d6c43e02da
            isRoot: false
            attributes:
            - name: Duration
              value: 600
              type: NUMBER
          - name: Sales
            id: 648055e0f4aa98d6c43e02f7
            isRoot: true
        createdAt: 2021-12-13 13:56:09.006000+00:00
        updatedAt: 2021-12-13 13:56:09.006000+00:00
  headers:
    xFabricRequestId:
      schema:
        type: string
      required: false
      example: 263e731c-45c8-11ed-b878-0242ac120002
      description: Unique request ID
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'This is the authorization token used to authenticate the request. You must pass the access token generated from the system app. For more information, see the [Making your first API request](/v3/api-reference/getting-started/getting-started-with-fabric-apis#procedure) section.

        '