> ## Documentation Index
> Fetch the complete documentation index at: https://docs.merchantspring.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Create an Amazon Buy Box Performance Report report

> Create an Amazon Buy Box Performance report. The generated report CSV contains the columns defined in the `AmazonBuyBoxPerformanceReportColumns` schema including your price, competitive price, and detailed offer attributes. An additional 'offerPoints' column is included for Japanese marketplaces. Use the /reports/status/{reportId} endpoint to check report status and obtain the download URL.



## OpenAPI

````yaml /api-reference/openapi.json post /reports/create/amazonBuyBoxPerformance
openapi: 3.0.1
info:
  title: MerchantSpring Public API
  version: 1.0.0
servers:
  - url: https://mm-api.merchantspring.io
    description: Production
  - url: https://mm-api-staging.merchantspring.io
    description: Staging
security: []
tags:
  - name: channel
    x-group: Channel
  - name: content-change
    x-group: Content Change
  - name: custom-group
    x-group: Custom Group
  - name: order
    x-group: Order
  - name: report
    x-group: Report
  - name: tag
    x-group: Tag
  - name: profitability
    x-group: Profitability
paths:
  /reports/create/amazonBuyBoxPerformance:
    post:
      tags:
        - report
      summary: Create an Amazon Buy Box Performance Report report
      description: >-
        Create an Amazon Buy Box Performance report. The generated report CSV
        contains the columns defined in the
        `AmazonBuyBoxPerformanceReportColumns` schema including your price,
        competitive price, and detailed offer attributes. An additional
        'offerPoints' column is included for Japanese marketplaces. Use the
        /reports/status/{reportId} endpoint to check report status and obtain
        the download URL.
      operationId: createAmazonBuyBoxPerformanceReport
      requestBody:
        description: Report criteria
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAmazonBuyBoxPerformanceReportRequest'
        required: true
      responses:
        '200':
          description: Successful operation
          headers:
            Access-Control-Allow-Origin:
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateReportResponse'
            text/csv:
              schema:
                $ref: '#/components/schemas/AmazonBuyBoxPerformanceReportColumns'
        '400':
          description: Invalid input
          content: {}
      security:
        - api_key: []
components:
  schemas:
    CreateAmazonBuyBoxPerformanceReportRequest:
      type: object
      properties:
        channelId:
          type: string
        merchantId:
          type: string
        filter:
          type: string
          enum:
            - winning
            - losing
            - notParticipating
            - noOffers
            - losingToAmazon
            - losingToOthers
            - losingToSelf
            - noWinner
          description: The type of buy box performance to report on
    CreateReportResponse:
      type: object
      properties:
        reportId:
          type: string
        reportType:
          type: string
        status:
          type: string
    AmazonBuyBoxPerformanceReportColumns:
      type: object
      description: >-
        Columns present in the downloadable Amazon Buy Box Performance report
        CSV. An additional 'offerPoints' column is included for Japanese
        marketplaces.
      properties:
        asin:
          type: string
          description: Amazon Standard Identification Number
        sellerSku:
          type: string
          description: Seller SKU
        title:
          type: string
          description: Product title
        quantity:
          type: number
          description: Current inventory quantity
        isFulfilledByAmazon:
          type: boolean
          description: Whether the product is fulfilled by Amazon (FBA)
        yourStatus:
          type: string
          description: Your listing status
        yourPriceCurrencyCode:
          type: string
          description: Currency code of your price
        yourPriceAmount:
          type: number
          description: Your listing price
        competitivePriceCurrencyCode:
          type: string
          description: Currency code of the competitive price
        competitivePriceAmount:
          type: number
          description: Competitive listing price
        offerRank:
          type: number
          description: Rank of this offer among competing offers
        offerSellerId:
          type: string
          description: Seller ID of the offer
        offerIsFulfilledByAmazon:
          type: boolean
          description: Whether the competing offer is FBA
        offerIsPrime:
          type: boolean
          description: Whether the offer is Prime eligible
        offerIsNationalPrime:
          type: boolean
          description: Whether the offer is National Prime
        offerIsBuyBoxWinner:
          type: boolean
          description: Whether this offer currently wins the Buy Box
        offerIsFeaturedMerchant:
          type: boolean
          description: Whether the seller is a Featured Merchant
        offerListingPriceCurrencyCode:
          type: string
          description: Currency code of the offer listing price
        offerListingPriceAmount:
          type: number
          description: Offer listing price
        offerShippingCurrencyCode:
          type: string
          description: Currency code of the offer shipping
        offerShippingAmount:
          type: number
          description: Offer shipping cost
        offerShippingTime:
          type: string
          description: Offer shipping time estimate
        offerShipsDomestically:
          type: boolean
          description: Whether the offer ships domestically
        offerSellerPositiveFeedbackRating:
          type: number
          description: Seller's positive feedback rating percentage
        offerFeedbackCount:
          type: number
          description: Total seller feedback count
        offerPoints:
          type: number
          description: Offer points (Japanese marketplaces only)
  securitySchemes:
    api_key:
      type: apiKey
      name: x-api-key
      in: header

````