openapi: 3.0.1
info:
  title: Cart Actions Endpoints Prices 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: Prices
paths:
  /prices:
    post:
      tags:
      - Prices
      summary: Create Price
      description: Create or update price of an item based on given `itemId` and `itemSku`
      operationId: createPrices
      security:
      - AuthorizationToken: []
      parameters:
      - $ref: '#/components/parameters/xFabricTenantId'
      - $ref: '#/components/parameters/xFabricChannelId'
      - $ref: '#/components/parameters/xClientId'
      - $ref: '#/components/parameters/xFabricRequestId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createPriceRequest'
            examples:
              createPrice:
                $ref: '#/components/examples/createPrice'
      responses:
        '201':
          description: Created
          headers:
            x-fabric-request-id:
              $ref: '#/components/headers/xFabricRequestIdResponse'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/createPriceResponse'
              examples:
                createPrice:
                  $ref: '#/components/examples/getPrice'
        '400':
          description: Bad request
          headers:
            x-fabric-request-id:
              $ref: '#/components/headers/xFabricRequestIdResponse'
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/missingTenantHeader'
                - $ref: '#/components/schemas/error400'
        '401':
          description: Unauthorized
          headers:
            x-fabric-request-id:
              $ref: '#/components/headers/xFabricRequestIdResponse'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error401'
        '404':
          description: Not Found
          headers:
            x-fabric-request-id:
              $ref: '#/components/headers/xFabricRequestIdResponse'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/priceListNotFound'
        '500':
          description: Internal server error
          headers:
            x-fabric-request-id:
              $ref: '#/components/headers/xFabricRequestIdResponse'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error500'
    get:
      tags:
      - Prices
      summary: Get All Active Prices
      description: Get a paginated list of active and scheduled prices. Active prices have start date greater than the current date and end date is in the future.
      operationId: getPrices
      security:
      - AuthorizationToken: []
      parameters:
      - $ref: '#/components/parameters/xFabricTenantId'
      - $ref: '#/components/parameters/xFabricChannelId'
      - $ref: '#/components/parameters/xClientId'
      - $ref: '#/components/parameters/xFabricRequestId'
      - $ref: '#/components/parameters/queryParameterSize'
      - $ref: '#/components/parameters/queryParameterOffset'
      - $ref: '#/components/parameters/queryParameterPriceListId'
      responses:
        '200':
          description: OK
          headers:
            x-fabric-request-id:
              $ref: '#/components/headers/xFabricRequestIdResponse'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getPricesResponse'
              examples:
                listPrice:
                  $ref: '#/components/examples/listPrice'
                listPriceWithRange:
                  $ref: '#/components/examples/listPriceRange'
        '400':
          description: Bad request
          headers:
            x-fabric-request-id:
              $ref: '#/components/headers/xFabricRequestIdResponse'
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/missingTenantHeader'
                - $ref: '#/components/schemas/error400'
        '401':
          description: Unauthorized
          headers:
            x-fabric-request-id:
              $ref: '#/components/headers/xFabricRequestIdResponse'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error401'
        '404':
          description: Not Found
          headers:
            x-fabric-request-id:
              $ref: '#/components/headers/xFabricRequestIdResponse'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/priceListNotFound'
        '500':
          description: Internal server error
          headers:
            x-fabric-request-id:
              $ref: '#/components/headers/xFabricRequestIdResponse'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error500'
  /prices/{itemId}:
    get:
      tags:
      - Prices
      summary: Get Price by Itemid
      description: Get a paginated list of price details for the given `itemId` and `priceListId`. If `priceListId` isn't specified, prices are retrieved for the `itemId` that belongs to the default price list.
      operationId: getPricesByItemId
      security:
      - AuthorizationToken: []
      parameters:
      - $ref: '#/components/parameters/xFabricTenantId'
      - $ref: '#/components/parameters/xFabricChannelId'
      - $ref: '#/components/parameters/xClientId'
      - $ref: '#/components/parameters/xFabricRequestId'
      - $ref: '#/components/parameters/queryParameterSize'
      - $ref: '#/components/parameters/queryParameterOffset'
      - $ref: '#/components/parameters/queryParameterPriceListId'
      - name: itemId
        in: path
        required: true
        description: The item ID from which prices are retrieved.
        schema:
          type: number
      - name: status
        in: query
        description: 'The status used to filter prices. The following statuses are available:

          - `ACTIVE`: Displays current prices or regular prices. These are the prices that are actively displayed and applied to products on an ongoing basis.

          - `SCHEDULED`: Displays prices that will be applied to products in the future. Retailers often use scheduled prices for marketing campaigns to attract customers, generate sales, clear inventory, or create a sense of urgency.

          - `ALL`: Displays both `ACTIVE` and `SCHEDULED` prices.

          '
        required: false
        schema:
          type: string
          default: ALL
          enum:
          - ACTIVE
          - SCHEDULED
          - ALL
      responses:
        '200':
          description: OK
          headers:
            x-fabric-request-id:
              $ref: '#/components/headers/xFabricRequestIdResponse'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getPriceResponse'
              examples:
                getPrice:
                  $ref: '#/components/examples/getPriceById'
                getPriceRangeWithQuantity:
                  $ref: '#/components/examples/getPriceRangeById'
                getPriceRangeWithArea:
                  $ref: '#/components/examples/getPriceRangeWithAreaById'
                getPriceRangeWithWidth:
                  $ref: '#/components/examples/getPriceRangeWithWidthById'
        '400':
          description: Bad request
          headers:
            x-fabric-request-id:
              $ref: '#/components/headers/xFabricRequestIdResponse'
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/missingTenantHeader'
                - $ref: '#/components/schemas/error400'
        '401':
          description: Unauthorized
          headers:
            x-fabric-request-id:
              $ref: '#/components/headers/xFabricRequestIdResponse'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error401'
        '404':
          description: Not Found
          headers:
            x-fabric-request-id:
              $ref: '#/components/headers/xFabricRequestIdResponse'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/itemIdNotFound'
        '500':
          description: Internal server error
          headers:
            x-fabric-request-id:
              $ref: '#/components/headers/xFabricRequestIdResponse'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error500'
    delete:
      tags:
      - Prices
      summary: Delete Price by Itemid
      description: Delete price details by `itemId`. If `priceListId` isn't specified, price is deleted for the `itemId` that belongs to the default price list.
      operationId: deletePricesByItemId
      security:
      - AuthorizationToken: []
      parameters:
      - $ref: '#/components/parameters/xFabricTenantId'
      - $ref: '#/components/parameters/xFabricChannelId'
      - $ref: '#/components/parameters/xClientId'
      - $ref: '#/components/parameters/xFabricRequestId'
      - $ref: '#/components/parameters/queryParameterPriceListId'
      - name: itemId
        in: path
        required: true
        description: The item ID of the price record that's being deleted.
        schema:
          type: number
      responses:
        '200':
          description: OK
          headers:
            x-fabric-request-id:
              $ref: '#/components/headers/xFabricRequestIdResponse'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/deletePriceResponse'
              example:
                priceListId: 100000
                itemId: 10000001
                itemSku: SKU0123456
                isDeleted: true
                channelId: '12'
                currency: USD
                offers:
                  startAt: '2019-08-24T14:15:22Z'
                  endAt: '2019-08-25T14:15:22Z'
                  price:
                    base: 299.99
                    sale: 199.99
                    cost: 148.99
                createdAt: '2019-08-20T14:15:22Z'
                updatedAt: '2019-08-20T14:15:22Z'
        '400':
          description: Bad request
          headers:
            x-fabric-request-id:
              $ref: '#/components/headers/xFabricRequestIdResponse'
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/missingTenantHeader'
                - $ref: '#/components/schemas/error400'
        '401':
          description: Unauthorized
          headers:
            x-fabric-request-id:
              $ref: '#/components/headers/xFabricRequestIdResponse'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error401'
        '404':
          description: Not Found
          headers:
            x-fabric-request-id:
              $ref: '#/components/headers/xFabricRequestIdResponse'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/itemIdNotFound'
        '500':
          description: Internal server error
          headers:
            x-fabric-request-id:
              $ref: '#/components/headers/xFabricRequestIdResponse'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error500'
  /prices/sku/{sku}:
    get:
      tags:
      - Prices
      summary: Get Price by SKU
      description: Get price details for the `sku` and `priceListId`. If `priceListId` isn't specified, price is retrieved for the `sku` that belongs to the default price list.
      operationId: getPricesBySku
      security:
      - AuthorizationToken: []
      parameters:
      - $ref: '#/components/parameters/xFabricTenantId'
      - $ref: '#/components/parameters/xFabricChannelId'
      - $ref: '#/components/parameters/xClientId'
      - $ref: '#/components/parameters/xFabricRequestId'
      - $ref: '#/components/parameters/queryParameterSize'
      - $ref: '#/components/parameters/queryParameterOffset'
      - $ref: '#/components/parameters/queryParameterPriceListId'
      - name: sku
        in: path
        required: true
        description: Product SKU to get the price record for
        schema:
          type: string
          example: SKU0123456
      - name: status
        in: query
        description: 'The status used to filter prices. The following statuses are available:

          - `ACTIVE`: Displays current prices or regular prices. These are the prices that are actively displayed and applied to products on an ongoing basis.

          - `SCHEDULED`: Displays prices that will be applied to products in the future. Retailers often use scheduled prices for marketing campaigns to attract customers, generate sales, clear inventory, or create a sense of urgency.

          - `ALL`: Displays both `ACTIVE` and `SCHEDULED` prices.

          '
        required: false
        schema:
          type: string
          default: ALL
          enum:
          - ACTIVE
          - SCHEDULED
          - ALL
      responses:
        '200':
          description: OK
          headers:
            x-fabric-request-id:
              $ref: '#/components/headers/xFabricRequestIdResponse'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getPriceResponse'
              examples:
                getPrice:
                  $ref: '#/components/examples/getPriceById'
                getPriceRangeWithQuantity:
                  $ref: '#/components/examples/getPriceRangeById'
                getPriceRangeWithArea:
                  $ref: '#/components/examples/getPriceRangeWithAreaById'
                getPriceRangeWithWidth:
                  $ref: '#/components/examples/getPriceRangeWithWidth'
        '400':
          description: Bad request
          headers:
            x-fabric-request-id:
              $ref: '#/components/headers/xFabricRequestIdResponse'
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/missingTenantHeader'
                - $ref: '#/components/schemas/error400'
        '401':
          description: Unauthorized
          headers:
            x-fabric-request-id:
              $ref: '#/components/headers/xFabricRequestIdResponse'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error401'
        '404':
          description: Not Found
          headers:
            x-fabric-request-id:
              $ref: '#/components/headers/xFabricRequestIdResponse'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/itemSkuNotFound'
        '500':
          description: Internal server error
          headers:
            x-fabric-request-id:
              $ref: '#/components/headers/xFabricRequestIdResponse'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error500'
    delete:
      tags:
      - Prices
      summary: Delete Price by SKU
      description: Delete price record for the given `sku` and `priceListId`.
      operationId: deletePricesBySku
      security:
      - AuthorizationToken: []
      parameters:
      - $ref: '#/components/parameters/xFabricTenantId'
      - $ref: '#/components/parameters/xFabricChannelId'
      - $ref: '#/components/parameters/xClientId'
      - $ref: '#/components/parameters/xFabricRequestId'
      - $ref: '#/components/parameters/queryParameterPriceListId'
      - name: sku
        in: path
        required: true
        description: The product SKU of the price details that are being deleted.
        schema:
          type: string
          example: SKU0123456
      responses:
        '200':
          description: OK
          headers:
            x-fabric-request-id:
              $ref: '#/components/headers/xFabricRequestIdResponse'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/deletePriceBySkuResponse'
              example:
                priceListId: 100000
                itemId: 10000001
                itemSku: SKU0123456
                isDeleted: true
                channelId: '12'
                currency: USD
                offers:
                  startAt: '2019-08-24T14:15:22Z'
                  endAt: '2019-08-25T14:15:22Z'
                  price:
                    base: 299.99
                    sale: 199.99
                    cost: 148.99
                createdAt: '2019-08-20T14:15:22Z'
                updatedAt: '2019-08-20T14:15:22Z'
        '400':
          description: Bad request
          headers:
            x-fabric-request-id:
              $ref: '#/components/headers/xFabricRequestIdResponse'
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/missingTenantHeader'
                - $ref: '#/components/schemas/error400'
        '401':
          description: Unauthorized
          headers:
            x-fabric-request-id:
              $ref: '#/components/headers/xFabricRequestIdResponse'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error401'
        '404':
          description: Not Found
          headers:
            x-fabric-request-id:
              $ref: '#/components/headers/xFabricRequestIdResponse'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/itemSkuNotFound'
        '500':
          description: Internal server error
          headers:
            x-fabric-request-id:
              $ref: '#/components/headers/xFabricRequestIdResponse'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error500'
  /prices/batch:
    post:
      tags:
      - Prices
      summary: Create Batch Prices
      description: Create one or more prices for items based on `itemId` and `itemSku`.
      operationId: createBatchPrices
      security:
      - AuthorizationToken: []
      parameters:
      - $ref: '#/components/parameters/xFabricTenantId'
      - $ref: '#/components/parameters/xFabricChannelId'
      - $ref: '#/components/parameters/xClientId'
      - $ref: '#/components/parameters/xFabricRequestId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createBatchPriceRequest'
            examples:
              createPrice:
                $ref: '#/components/examples/createBulkPrice'
              createPriceWithQuantity:
                $ref: '#/components/examples/createBulkPriceRangeWithQuantity'
              createPriceWithArea:
                $ref: '#/components/examples/createBulkPriceRangeWithArea'
              createPriceWithDimensions:
                $ref: '#/components/examples/createBulkPriceRangeWithWidths'
      responses:
        '201':
          description: OK
          headers:
            x-fabric-request-id:
              $ref: '#/components/headers/xFabricRequestIdResponse'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/createBatchPriceResponse'
              examples:
                createPrice:
                  $ref: '#/components/examples/getBulkPrice'
                createPriceRangeWithQuantity:
                  $ref: '#/components/examples/getBulkPriceRange'
                createPriceRangeWithArea:
                  $ref: '#/components/examples/getBulkPriceRangeArea'
                createBulkPriceRangeWithDimensions:
                  $ref: '#/components/examples/getBulkPriceRangeDimensions'
        '400':
          description: Bad request
          headers:
            x-fabric-request-id:
              $ref: '#/components/headers/xFabricRequestIdResponse'
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/batchPriceErrors'
                - $ref: '#/components/schemas/missingTenantHeader'
                - $ref: '#/components/schemas/error400'
        '401':
          description: Unauthorized
          headers:
            x-fabric-request-id:
              $ref: '#/components/headers/xFabricRequestIdResponse'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error401'
        '500':
          description: Internal server error
          headers:
            x-fabric-request-id:
              $ref: '#/components/headers/xFabricRequestIdResponse'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error500'
components:
  schemas:
    createPriceRequest:
      $ref: '#/components/schemas/priceRequest'
    priceRequest:
      type: object
      description: Details to create prices for an item
      required:
      - offers
      properties:
        priceListId:
          type: integer
          format: int32
          description: ID of the price list for which prices will be created or updated. If you don't mention `priceListId`, price will be created or updated for the default price list.
          example: 100000
        itemId:
          type: integer
          format: int32
          example: 10000001
          description: The product item ID assigned when a price is created or updated. It is a required property.
        itemSku:
          type: string
          example: SKU0123456
          description: The product SKU assigned when a price is created or updated.
        offers:
          type: array
          minItems: 1
          maxItems: 10
          items:
            required:
            - startAt
            - endAt
            - price
            allOf:
            - $ref: '#/components/schemas/priceWithOffersMetaData'
            - type: object
    deletePriceResponse:
      allOf:
      - $ref: '#/components/schemas/price'
      - type: object
        required:
        - itemId
    getPricesResponse:
      type: object
      properties:
        query:
          $ref: '#/components/schemas/offsetQuery'
        data:
          type: array
          description: An array containing price details.
          items:
            allOf:
            - $ref: '#/components/schemas/priceMetadata'
            - type: object
              required:
              - offers
              properties:
                offers:
                  type: array
                  items:
                    allOf:
                    - $ref: '#/components/schemas/priceWithOffersMetaData'
                    - type: object
    priceWithOffersMetaData:
      type: object
      description: Price details including offer price
      required:
      - startAt
      - endAt
      - price
      properties:
        startAt:
          type: string
          description: The timestamp of when the adjusted price starts.
          format: date-time
          example: 2020-02-02 17:22:48.570000+00:00
        endAt:
          type: string
          description: The timestamp of when the adjusted price ends.
          format: date-time
          example: 2020-02-02 17:22:48.570000+00:00
        price:
          type: object
          description: Price details
          required:
          - base
          properties:
            base:
              description: Item base price. It's the minimum fixed price of the item before any taxes or other charges added.
              type: number
              nullable: true
              format: double
              example: 2.99
            sale:
              description: Item sale price. It's the discounted price at which the item is sold to clear inventory.
              type: number
              nullable: true
              format: double
              example: 99.99
            cost:
              description: Cost of the item set by the manufacturer. It's the amount that costs the manufacturer to produce or acquire the product.
              type: number
              nullable: true
              format: double
              example: 149
    missingTenantHeader:
      type: object
      description: Tenant header is missing
      properties:
        type:
          description: The error code.
          type: string
          example: TENANT_HEADER_REQUIRED
        message:
          description: An error message corresponding to the `type`.
          type: string
          example: x-fabric-tenant-id header is required
    batchPriceErrors:
      type: object
      properties:
        type:
          description: The error code.
          type: string
          example: DATA_ERROR
        details:
          description: An error message corresponding to the `type`.
          type: string
          example: Request validation check
        errors:
          type: array
          description: The error details related to batch prices.
          items:
            type: object
            properties:
              type:
                type: string
                description: The error code.
                example: PRICE_TIME_RANGE_ERROR
              instance:
                type: string
                description: The endpoint.
                example: /prices/batch
              name:
                type: string
                description: The name of the error.
                example: Please verify `startAt`, `endAt` time
              detail:
                type: string
                description: The error message.
                example: '`startAt` should be at least 15 mins before `EndAt`, and neither should be a past date.'
              status:
                type: integer
                format: int32
                description: The HTTP status code.
                example: 400
    price:
      type: object
      required:
      - priceListId
      - channelId
      - currency
      - offers
      properties:
        itemId:
          type: integer
          format: int32
          example: 1000000051
          description: The product item ID assigned when a price is created, updated, or deleted.
        itemSku:
          type: string
          example: SKU123456
          description: The product item SKU assigned when a price is created, updated, or deleted.
        priceListId:
          type: integer
          format: int32
          description: The price list ID assigned when price details are created or updated.
          example: 100000
        isDeleted:
          $ref: '#/components/schemas/isDeleted'
        channelId:
          description: Channel ID
          type: string
          example: '12'
        currency:
          description: The currency type set for the price list.
          type: string
          example: USD
        offers:
          type: array
          description: Item prices
          items:
            allOf:
            - $ref: '#/components/schemas/priceWithOffersMetaData'
            - type: object
        createdAt:
          $ref: '#/components/schemas/createdAt'
        updatedAt:
          $ref: '#/components/schemas/updatedAt'
    createBatchPriceResponse:
      type: object
      properties:
        data:
          type: array
          description: The sample response of price creation.
          items:
            $ref: '#/components/schemas/price'
    getPriceResponse:
      type: object
      properties:
        query:
          $ref: '#/components/schemas/offsetQuery'
        priceMetadata:
          $ref: '#/components/schemas/priceMetadata'
        data:
          type: array
          items:
            $ref: '#/components/schemas/priceWithOffersMetaData'
    priceMetadata:
      type: object
      required:
      - priceListId
      - createdAt
      - updatedAt
      properties:
        isDeleted:
          $ref: '#/components/schemas/isDeleted'
        itemId:
          type: integer
          format: int32
          description: The assigned product item ID the price is retrieved for.
          example: 1000000051
        itemSku:
          type: string
          description: The assigned product SKU the price is retrieved for.
          example: SKU123456
        priceListId:
          type: integer
          format: int32
          description: The price list ID for retrieving prices for the specified `itemId` and `itemSku`.
          example: 100000
        channelId:
          description: Channel ID
          type: string
          example: '12'
        currency:
          description: The currency type set for the price list.
          type: string
          example: USD
        createdAt:
          $ref: '#/components/schemas/createdAt'
        updatedAt:
          $ref: '#/components/schemas/updatedAt'
    deletePriceBySkuResponse:
      allOf:
      - $ref: '#/components/schemas/price'
      - type: object
        required:
        - itemSku
    priceListNotFound:
      type: object
      description: Price list not found error
      properties:
        type:
          description: The error code.
          type: string
          example: PRICE_LIST_NOT_FOUND
        message:
          description: An error message corresponding to the `type`.
          type: string
          example: No price list found with this ID
    createPriceResponse:
      $ref: '#/components/schemas/price'
    updatedAt:
      type: string
      format: date-time
      description: The timestamp when the price was last updated.
      example: 2019-08-20 14:15:22+00:00
    error401:
      type: object
      description: Unauthorized error
      properties:
        type:
          description: The error code.
          type: string
          example: UNAUTHORIZED
        message:
          description: An error message corresponding to the `type`.
          type: string
          example: Invalid credentials
    offsetQuery:
      type: object
      description: Provides pagination data.
      properties:
        size:
          type: integer
          format: int32
          example: 10
          minimum: 1
          maximum: 100
          default: 10
          description: The maximum number of records per page.
        offset:
          type: integer
          format: int32
          example: 10
          minimum: 0
          default: 0
          description: The number of records to skip before returning records. For example, with an offset of 20 and limit of 10, you will get records from 21 to 30.
        count:
          type: integer
          format: int32
          example: 50
          description: The total number of available records.
    createdAt:
      type: string
      format: date-time
      description: The timestamp when the price was created.
      example: 2019-08-20 14:15:22+00:00
    error400:
      type: object
      description: Bad request error
      properties:
        type:
          description: The error code.
          type: string
          example: BAD_REQUEST
        message:
          description: An error message corresponding to the `type`.
          type: string
          example: Bad request
    error500:
      type: object
      description: Internal server error
      properties:
        type:
          description: The error code.
          type: string
          example: INTERNAL_SERVER_ERROR
        message:
          description: An error message corresponding to the `type`.
          type: string
          example: Internal server error
    itemSkuNotFound:
      type: object
      description: Item not found error
      properties:
        type:
          description: The error code.
          type: string
          example: ITEMSKU_NOT_FOUND
        message:
          description: An error message corresponding to the `type`.
          type: string
          example: The itemSku you entered doesn't exist
    itemIdNotFound:
      type: object
      description: Item not found error
      properties:
        type:
          description: The error code.
          type: string
          example: ITEMID_NOT_FOUND
        message:
          description: An error message corresponding to the `type`.
          type: string
          example: The itemId you entered doesn't exist
    isDeleted:
      type: boolean
      description: '`true`: The price is deleted


        `false`: The price isn''t deleted

        '
      example: false
    createBatchPriceRequest:
      type: object
      properties:
        data:
          type: array
          description: The sample request to create batch prices.
          items:
            $ref: '#/components/schemas/priceRequest'
  examples:
    getPriceRangeWithWidth:
      value:
        priceListId: 100000
        itemId: 10000001
        itemSku: SKU0123456
        isDeleted: false
        channelId: '12'
        currency: USD
        offers:
          startAt: 2019-08-24 14:15:22+00:00
          endAt: 2019-08-25 14:15:22+00:00
          price:
            base: 299.99
            sale: 199.99
            cost: 148.99
          priceRange:
            priceMethodType: TABLE_PRICING_LENGTH_WIDTH
            ranges:
            - minLength: 1
              maxLength: 100
              widths:
              - minWidth: 1
                maxWidth: 200
                price: 20.75
            priceAddons:
            - id: 1000000051
        createdAt: 2019-08-20 14:15:22+00:00
        updatedAt: 2019-08-20 14:15:22+00:00
    createBulkPriceRangeWithQuantity:
      value:
        data:
        - priceListId: 100000
          itemId: 10000001
          itemSku: SKU0123456
          offers:
            startAt: 2019-08-24 14:15:22+00:00
            endAt: 2019-08-25 14:15:22+00:00
            price:
              base: 299
              sale: 199
              cost: 148
            priceRange:
              priceMethodType: QUANTITY_PRICING
              ranges:
              - minQuantity: 1
                maxQuantity: 20
                price: 20.75
              priceAddons:
              - id: 1000000051
    getBulkPrice:
      value:
        data:
        - priceListId: 100000
          itemId: 10000001
          itemSku: SKU0123456
          isDeleted: false
          channelId: '12'
          currency: USD
          offers:
            startAt: 2019-08-24 14:15:22+00:00
            endAt: 2019-08-25 14:15:22+00:00
            price:
              base: 299.99
              sale: 199.99
              cost: 148.99
          createdAt: 2019-08-20 14:15:22+00:00
          updatedAt: 2019-08-20 14:15:22+00:00
    listPriceRange:
      value:
        query:
          size: 10
          offset: 0
          count: 34
        data:
        - priceListId: 100000
          itemId: 10000001
          itemSku: SKU0123456
          isDeleted: false
          channelId: '12'
          currency: USD
          offers:
            startAt: 2019-08-24 14:15:22+00:00
            endAt: 2019-08-25 14:15:22+00:00
            price:
              base: 299.99
              sale: 199.99
              cost: 148.99
            priceRange:
              priceMethodType: QUANTITY_PRICING
              ranges:
              - minQuantity: 1
                price: 20.75
              priceAddons:
              - id: 61118
                name: BuildMotor
                price: 458.97
          createdAt: 2019-08-20 14:15:22+00:00
          updatedAt: 2019-08-20 14:15:22+00:00
    getPriceById:
      value:
        query:
          size: 10
          offset: 0
        priceMetadata:
          priceListId: 100000
          itemId: 10000001
          itemSku: SKU0123456
          isDeleted: false
          channelId: '12'
          currency: USD
          createdAt: 2019-08-20 14:15:22+00:00
          updatedAt: 2019-08-20 14:15:22+00:00
        data:
          startAt: 2019-08-24 14:15:22+00:00
          endAt: 2019-08-25 14:15:22+00:00
          price:
            base: 299.99
            sale: 199.99
            cost: 148.99
    getPriceRangeWithAreaById:
      value:
        query:
          size: 10
          offset: 0
        priceMetadata:
          priceListId: 100000
          itemId: 10000001
          itemSku: SKU0123456
          isDeleted: false
          channelId: '12'
          currency: USD
          createdAt: 2019-08-20 14:15:22+00:00
          updatedAt: 2019-08-20 14:15:22+00:00
        data:
          startAt: 2019-08-24 14:15:22+00:00
          endAt: 2019-08-25 14:15:22+00:00
          price:
            base: 299.99
            sale: 199.99
            cost: 148.99
          priceRange:
            priceMethodType: SQUARE_AREA_PRICING
            ranges:
            - minArea: 1
              price: 20.75
            priceAddons:
            - id: 61118
              name: BuildMotor
              price: 458.97
    createBulkPrice:
      value:
        data:
        - priceListId: 100000
          itemId: 10000001
          itemSku: SKU0123456
          offers:
            startAt: 2019-08-24 14:15:22+00:00
            endAt: 2019-08-25 14:15:22+00:00
            price:
              base: 299.99
              sale: 199.99
              cost: 148.99
    listPrice:
      value:
        query:
          size: 10
          offset: 0
          count: 34
        data:
        - priceListId: 100000
          itemId: 10000001
          itemSku: SKU0123456
          isDeleted: false
          channelId: '12'
          currency: USD
          offers:
            startAt: 2019-08-24 14:15:22+00:00
            endAt: 2019-08-25 14:15:22+00:00
            price:
              base: 299.99
              sale: 199.99
              cost: 148.99
          createdAt: 2019-08-20 14:15:22+00:00
          updatedAt: 2019-08-20 14:15:22+00:00
    getBulkPriceRangeArea:
      value:
        data:
        - priceListId: 100000
          itemId: 10000001
          itemSku: SKU0123456
          isDeleted: false
          channelId: '12'
          currency: USD
          offers:
            startAt: 2019-08-24 14:15:22+00:00
            endAt: 2019-08-25 14:15:22+00:00
            price:
              base: 299.99
              sale: 199.99
              cost: 148.99
            priceRange:
              priceMethodType: SQUARE_AREA_PRICING
              ranges:
              - minArea: 1
                maxArea: 20
                price: 20.75
              priceAddons:
              - id: 1000000051
          createdAt: 2019-08-20 14:15:22+00:00
          updatedAt: 2019-08-20 14:15:22+00:00
    getPriceRangeById:
      value:
        query:
          size: 10
          offset: 0
        priceMetadata:
          priceListId: 100000
          itemId: 10000001
          itemSku: SKU0123456
          isDeleted: false
          channelId: '12'
          currency: USD
          createdAt: 2019-08-20 14:15:22+00:00
          updatedAt: 2019-08-20 14:15:22+00:00
        data:
          startAt: 2019-08-24 14:15:22+00:00
          endAt: 2019-08-25 14:15:22+00:00
          price:
            base: 299.99
            sale: 199.99
            cost: 148.99
          priceRange:
            priceMethodType: QUANTITY_PRICING
            ranges:
            - minQuantity: 1
              maxQuantity: 20
              price: 20.75
            priceAddons:
            - id: 61118
              name: BuildMotor
              price: 458.97
    createBulkPriceRangeWithWidths:
      value:
        data:
        - priceListId: 100000
          itemId: 10000001
          itemSku: SKU0123456
          offers:
            startAt: 2019-08-24 14:15:22+00:00
            endAt: 2019-08-25 14:15:22+00:00
            price:
              base: 299.99
              sale: 199.99
              cost: 148.99
            priceRange:
              priceMethodType: TABLE_PRICING_LENGTH_WIDTH
              ranges:
              - minLength: 1
                maxLength: 100
                widths:
                - minWidth: 1
                  maxWidth: 200
                  price: 20.75
              priceAddons:
              - id: 1000000051
    getPrice:
      value:
        priceListId: 100000
        itemId: 10000001
        itemSku: SKU0123456
        isDeleted: false
        channelId: '12'
        currency: USD
        offers:
          startAt: 2019-08-24 14:15:22+00:00
          endAt: 2019-08-25 14:15:22+00:00
          price:
            base: 299.99
            sale: 199.99
            cost: 148.99
        createdAt: 2019-08-20 14:15:22+00:00
        updatedAt: 2019-08-20 14:15:22+00:00
    getBulkPriceRange:
      value:
        data:
        - priceListId: 100000
          itemId: 10000001
          itemSku: SKU0123456
          isDeleted: false
          channelId: '12'
          currency: USD
          offers:
            startAt: 2019-08-24 14:15:22+00:00
            endAt: 2019-08-25 14:15:22+00:00
            price:
              base: 299.99
              sale: 199.99
              cost: 148.99
            priceRange:
              priceMethodType: QUANTITY_PRICING
              ranges:
              - minQuantity: 1
                maxQuantity: 20
                price: 20.75
              priceAddons:
              - id: 61118
                name: BuildMotor
                price: 458.97
          createdAt: 2019-08-20 14:15:22+00:00
          updatedAt: 2019-08-20 14:15:22+00:00
    getPriceRangeWithWidthById:
      value:
        query:
          size: 10
          offset: 0
        priceMetadata:
          priceListId: 100000
          itemId: 10000001
          itemSku: SKU0123456
          isDeleted: false
          channelId: '12'
          currency: USD
          createdAt: 2019-08-20 14:15:22+00:00
          updatedAt: 2019-08-20 14:15:22+00:00
        data:
          startAt: 2019-08-24 14:15:22+00:00
          endAt: 2019-08-25 14:15:22+00:00
          price:
            base: 299.99
            sale: 199.99
            cost: 148.99
          priceRange:
            priceMethodType: TABLE_PRICING_LENGTH_WIDTH
            ranges:
            - minLength: 1
              maxLength: 100
              widths:
              - minWidth: 1
                maxWidth: 200
                price: 20.75
            priceAddons:
            - id: 1000000051
    createPrice:
      value:
        priceListId: 100000
        itemId: 10000001
        itemSku: SKU0123456
        offers:
          startAt: 2019-08-24 14:15:22+00:00
          endAt: 2019-08-25 14:15:22+00:00
          price:
            base: 299.99
            sale: 199.99
            cost: 148.99
    createBulkPriceRangeWithArea:
      value:
        data:
        - priceListId: 100000
          itemId: 10000001
          itemSku: SKU0123456
          offers:
            startAt: 2019-08-24 14:15:22+00:00
            endAt: 2019-08-25 14:15:22+00:00
            price:
              base: 299.99
              sale: 199.99
              cost: 148.99
            priceRange:
              priceMethodType: SQUARE_AREA_PRICING
              ranges:
              - minArea: 1
                maxArea: 20
                price: 20.75
              priceAddons:
              - id: 1000000051
    getBulkPriceRangeDimensions:
      value:
        data:
        - priceListId: 100000
          itemId: 10000001
          itemSku: SKU0123456
          isDeleted: false
          channelId: '12'
          currency: USD
          offers:
            startAt: 2019-08-24 14:15:22+00:00
            endAt: 2019-08-25 14:15:22+00:00
            price:
              base: 299.99
              sale: 199.99
              cost: 148.99
            priceRange:
              priceMethodType: TABLE_PRICING_LENGTH_WIDTH
              ranges:
              - minLength: 1
                maxLength: 100
                widths:
                - minWidth: 1
                  maxWidth: 200
                  price: 20.75
              priceAddons:
              - id: 1000000051
          createdAt: 2019-08-20 14:15:22+00:00
          updatedAt: 2019-08-20 14:15:22+00:00
  parameters:
    xFabricTenantId:
      in: header
      name: x-fabric-tenant-id
      schema:
        type: string
        minLength: 24
        maxLength: 24
      required: true
      example: 5f328bf0b5f328bf0b5f328b
      description: A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from [Copilot](/v3/platform/settings/account-details/getting-the-account-id). This header is required.
    queryParameterSize:
      name: size
      in: query
      description: The maximum number of records per page.
      required: false
      schema:
        type: integer
        format: int32
        minimum: 1
        default: 10
        maximum: 100
    queryParameterOffset:
      name: offset
      in: query
      description: The number of records to skip before returning records. For example, with an offset of 20 and limit of 10, you will get records from 21 to 30.
      required: false
      schema:
        type: integer
        format: int32
        minimum: 0
        example: 0
        default: 0
    xClientId:
      in: header
      name: x-client-id
      schema:
        type: string
      required: false
      example: copilot
      description: A unique identifier obtained from [Copilot](/v3/platform/settings/api-apps/getting-system-app-credentials) for the System app in the fabric ecosystem, essential for OpenID Connect authentication flows.
    xFabricRequestId:
      in: header
      name: x-fabric-request-id
      description: A unique request ID.
      required: false
      schema:
        type: string
        example: 263e731c-45c8-11ed-b878-0242ac120002
    queryParameterPriceListId:
      name: priceListId
      in: query
      description: The price list ID to which the item belongs. If not provided, the default price list is used.
      required: false
      schema:
        type: integer
        format: int32
        example: 100000
    xFabricChannelId:
      in: header
      name: x-fabric-channel-id
      schema:
        type: string
        example: '12'
      description: x-fabric-channel-id identifies the sales channel through which the API request is being made; primarily for multichannel use cases. It is a required field.
  headers:
    xFabricRequestIdResponse:
      description: Unique request ID
      schema:
        type: string
        example: 263e731c-45c8-11ed-b878-0242ac120002
  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.

        '