GraphQL API Documentation

query AccountPerformance($input: AccountPerformanceInput!) {
  accountPerformance(input: $input) {
    rows { accountId accountName reportDate countryCode currencyCode adImpressions adClicks }
    totals { adSpend adRevenue orderedRevenue derived { acos roas } }
    pageInfo { hasNextPage endCursor }
    queryInfo { requestId returnedRows effectiveAccountIds }
  }
}

{ "input": { "accountIds": ["{{accountId}}"], "dateRange": { "from": "{{dateFrom}}", "to": "{{dateTo}}" }, "pagination": { "first": {{pageSize}} } } }

query ProductPerformance($input: ProductPerformanceInput!) {
  productPerformance(input: $input) {
    rows { accountId reportDate product sku productTitle countryCode currencyCode }
    totals { adSpend adRevenue derived { acos roas } }
    pageInfo { hasNextPage endCursor }
    queryInfo { requestId returnedRows effectiveAccountIds }
  }
}

{ "input": { "accountIds": ["{{accountId}}"], "dateRange": { "from": "{{dateFrom}}", "to": "{{dateTo}}" }, "pagination": { "first": {{pageSize}} } } }

query CampaignPerformance($input: CampaignPerformanceInput!) {
  campaignPerformance(input: $input) {
    rows { accountId reportDate campaignId campaignName campaignType status portfolioId }
    totals { adSpend adRevenue derived { acos roas } }
    pageInfo { hasNextPage endCursor }
    queryInfo { requestId returnedRows effectiveAccountIds }
  }
}

{ "input": { "accountIds": ["{{accountId}}"], "dateRange": { "from": "{{dateFrom}}", "to": "{{dateTo}}" }, "pagination": { "first": {{pageSize}} } } }

query KeywordPerformance($input: KeywordPerformanceInput!) {
  keywordPerformance(input: $input) {
    rows { accountId reportDate keywordId keywordText matchType keywordStatus campaignId }
    totals { adSpend adRevenue derived { acos roas } }
    pageInfo { hasNextPage endCursor }
    queryInfo { requestId returnedRows effectiveAccountIds }
  }
}

{ "input": { "accountIds": ["{{accountId}}"], "dateRange": { "from": "{{dateFrom}}", "to": "{{dateTo}}" }, "pagination": { "first": {{pageSize}} } } }

query SearchTermPerformance($input: SearchTermPerformanceInput!) {
  searchTermPerformance(input: $input) {
    rows { accountId reportDate searchTerm matchType isAsin isBrandTerm target }
    totals { adSpend adRevenue derived { acos roas } }
    pageInfo { hasNextPage endCursor }
    queryInfo { requestId returnedRows effectiveAccountIds }
  }
}

{ "input": { "accountIds": ["{{accountId}}"], "dateRange": { "from": "{{dateFrom}}", "to": "{{dateTo}}" }, "pagination": { "first": {{pageSize}} } } }

query ProductTargetPerformance($input: ProductTargetPerformanceInput!) {
  productTargetPerformance(input: $input) {
    rows { accountId reportDate targetId target targetStatus isBrandTarget campaignId }
    totals { adSpend adRevenue derived { acos roas } }
    pageInfo { hasNextPage endCursor }
    queryInfo { requestId returnedRows effectiveAccountIds }
  }
}

{ "input": { "accountIds": ["{{accountId}}"], "dateRange": { "from": "{{dateFrom}}", "to": "{{dateTo}}" }, "pagination": { "first": {{pageSize}} } } }

query AdvertisedProductPerformance($input: AdvertisedProductPerformanceInput!) {
  advertisedProductPerformance(input: $input) {
    rows { accountId reportDate productAdId product sku productTitle adProductStatus }
    totals { adSpend adRevenue derived { acos roas } }
    pageInfo { hasNextPage endCursor }
    queryInfo { requestId returnedRows effectiveAccountIds }
  }
}

{ "input": { "accountIds": ["{{accountId}}"], "dateRange": { "from": "{{dateFrom}}", "to": "{{dateTo}}" }, "pagination": { "first": {{pageSize}} } } }

query CurrentCampaignState($input: CurrentStateInput!) {
  currentState(input: $input) {
    accountId
    asset
    items {
      __typename
      ... on CampaignCurrentState {
        campaignId name state targetingType portfolioId startDate endDate
        budget { budgetType budget }
        dynamicBidding { strategy placementBidding { placement percentage } }
      }
    }
  }
}

{
  "input": {
    "accountId": "{{accountId}}",
    "adProduct": "SP",
    "asset": "CAMPAIGN",
    "ids": ["campaign-id"]
  }
}

query CurrentKeywordState($input: CurrentStateInput!) {
  currentState(input: $input) {
    accountId
    asset
    items {
      __typename
      ... on KeywordCurrentState {
        keywordId campaignId adGroupId keywordText matchType state bid
      }
    }
  }
}

{
  "input": {
    "accountId": "{{accountId}}",
    "adProduct": "SB",
    "asset": "KEYWORD",
    "ids": ["keyword-id"]
  }
}

query CurrentTargetState($input: CurrentStateInput!) {
  currentState(input: $input) {
    accountId
    asset
    items {
      __typename
      ... on TargetCurrentState {
        targetId campaignId adGroupId expressionType
        expression { type value }
        resolvedExpression { type value }
        state bid
      }
    }
  }
}

{
  "input": {
    "accountId": "{{accountId}}",
    "adProduct": "SP",
    "asset": "TARGET",
    "ids": ["target-id"]
  }
}

query CurrentProductTargetState($input: CurrentStateInput!) {
  currentState(input: $input) {
    accountId
    asset
    items {
      __typename
      ... on ProductTargetCurrentState {
        targetId campaignId adGroupId expressionType
        expression { type value }
        resolvedExpression { type value }
        state bid
      }
    }
  }
}

{
  "input": {
    "accountId": "{{accountId}}",
    "adProduct": "SD",
    "asset": "PRODUCT_TARGET",
    "ids": ["product-target-id"]
  }
}

query InventoryRootOnly($input: InventoryInput!) {
  inventory(input: $input) {
    rows { accountId sku quantity asin reportDate }
    pageInfo { hasNextPage endCursor }
    queryInfo {
      requestId sourceAsset layer returnedRows
      maximumBytesBilled bytesProcessed effectiveAccountIds
    }
  }
}

{
  "input": {
    "accountIds": ["{{accountId}}"],
    "pagination": { "first": {{pageSize}} }
  }
}

query InventoryRootWithTotals($input: InventoryInput!) {
  inventory(input: $input) {
    rows {
      accountId sellerId accountName countryCode currencyCode
      asin sku quantity price businessPrice reportDate downloadDate
    }
    totals { quantity }
    pageInfo { hasNextPage hasPreviousPage startCursor endCursor }
    queryInfo {
      requestId sourceAsset layer returnedRows maximumBytesBilled
      bytesProcessed effectiveAccountIds dateFrom dateTo generatedAt
    }
  }
}

{
  "input": {
    "accountIds": ["{{accountId}}"],
    "pagination": { "first": {{pageSize}} }
  }
}

query InventoryFiltered($input: InventoryInput!) {
  inventory(input: $input) {
    rows { accountId sku asin countryCode quantity price reportDate }
    totals { quantity }
    pageInfo { hasNextPage endCursor }
    queryInfo {
      layer sourceAsset effectiveAccountIds returnedRows bytesProcessed
    }
  }
}

{
  "input": {
    "accountIds": ["{{accountId}}"],
    "where": {
      "countryCode": { "eq": "US" },
      "quantity": { "gte": 1 }
    },
    "orderBy": [
      { "field": "quantity", "direction": "DESC" },
      { "field": "sku", "direction": "ASC" }
    ],
    "pagination": { "first": {{pageSize}} }
  }
}

query InventoryWithFba($input: InventoryInput!) {
  inventory(input: $input) {
    rows {
      accountId sku asin quantity
      fbaInventory {
        warehouseQuantity fulfillableQuantity reservedQuantity
        unsellableQuantity totalQuantity researchingQuantity
        reservedFutureSupply futureSupplyBuyable
      }
      fbaInboundInventory { workingQuantity shippedQuantity receivingQuantity }
      merchantFulfilledInventory { listingExists fulfillableQuantity }
      fbaDateControls { reportDate downloadDate }
    }
    totals { quantity }
    pageInfo { hasNextPage endCursor }
    queryInfo { layer sourceAsset returnedRows bytesProcessed }
  }
}

{
  "input": {
    "accountIds": ["{{accountId}}"],
    "pagination": { "first": {{pageSize}} }
  }
}

query InventoryWithRestock($input: InventoryInput!) {
  inventory(input: $input) {
    rows {
      accountId sku asin quantity
      productIdentification {
        asin productName condition fulfilledBy supplier supplierPartNo
      }
      availableAndTotalInventory {
        available totalUnits customerOrder unfulfillable
      }
      fulfillmentCenterInventory { fcProcessing fcTransfer }
      inboundShipments { inbound working shipped receiving }
      salesCoverageAndReplenishment {
        unitsSoldLast30Days salesLast30Days daysOfSupply
        daysOfSupplyAtAmazon totalDaysOfSupply
        recommendedReplenishmentQty recommendedShipDate alert
        maximumShipmentQuantity utilization unitStorageSize
      }
      inventoryThresholds {
        currentMonthVeryLow currentMonthMinimum
        currentMonthMaximum currentMonthVeryHigh
        nextMonthVeryLow nextMonthMinimum
        nextMonthMaximum nextMonthVeryHigh
      }
      restockDateControls { reportDate downloadDate }
    }
    totals { quantity }
    pageInfo { hasNextPage endCursor }
    queryInfo { layer sourceAsset returnedRows bytesProcessed }
  }
}

{
  "input": {
    "accountIds": ["{{accountId}}"],
    "pagination": { "first": {{pageSize}} }
  }
}

query InventoryFull($input: InventoryInput!) {
  inventory(input: $input) {
    rows {
      accountId sku asin quantity price
      fbaInboundInventory { workingQuantity shippedQuantity receivingQuantity }
      productIdentification { asin productName }
      inventoryThresholds { currentMonthMinimum currentMonthMaximum }
      inboundShipments { inbound working shipped receiving }
    }
    totals { quantity }
    pageInfo { hasNextPage endCursor }
    queryInfo {
      requestId layer sourceAsset returnedRows
      effectiveAccountIds bytesProcessed maximumBytesBilled
    }
  }
}

{
  "input": {
    "accountIds": ["{{accountId}}"],
    "pagination": { "first": {{pageSize}} }
  }
}

query InventoryPage2($input: InventoryInput!) {
  inventory(input: $input) {
    rows { accountId sku quantity }
    pageInfo { hasNextPage hasPreviousPage startCursor endCursor }
    queryInfo { returnedRows bytesProcessed }
  }
}

{
  "input": {
    "accountIds": ["{{accountId}}"],
    "pagination": {
      "first": {{pageSize}},
      "after": "{{pageCursor}}"
    }
  }
}

query ListingRootOnly($input: ListingInput!) {
  listing(input: $input) {
    rows { accountId sku listingId asin itemName quantity status reportDate }
    pageInfo { hasNextPage endCursor }
    queryInfo {
      requestId sourceAsset layer returnedRows
      maximumBytesBilled bytesProcessed effectiveAccountIds
    }
  }
}

{
  "input": {
    "accountIds": ["{{accountId}}"],
    "pagination": { "first": {{pageSize}} }
  }
}

query ListingRootWithTotals($input: ListingInput!) {
  listing(input: $input) {
    rows {
      accountId accountName currencyCode listingId sku asin asin2 asin3
      itemName itemDescription price quantity pendingQuantity openDate imageUrl
      itemIsMarketplace productIdType productId itemNote itemCondition
      willShipInternationally expeditedShipping fulfillmentChannel
      merchantShippingGroup status addDelete reportDate downloadDate
    }
    totals { quantity pendingQuantity }
    pageInfo { hasNextPage hasPreviousPage startCursor endCursor }
    queryInfo {
      requestId sourceAsset layer returnedRows maximumBytesBilled
      bytesProcessed effectiveAccountIds dateFrom dateTo generatedAt
    }
  }
}

{
  "input": {
    "accountIds": ["{{accountId}}"],
    "pagination": { "first": {{pageSize}} }
  }
}

query ListingFiltered($input: ListingInput!) {
  listing(input: $input) {
    rows {
      accountId sku listingId asin itemName quantity price status
      fulfillmentChannel reportDate
    }
    totals { quantity pendingQuantity }
    pageInfo { hasNextPage endCursor }
    queryInfo {
      layer sourceAsset effectiveAccountIds returnedRows bytesProcessed
    }
  }
}

{
  "input": {
    "accountIds": ["{{accountId}}"],
    "where": {
      "status": { "eq": "Active" },
      "fulfillmentChannel": { "eq": "DEFAULT" }
    },
    "orderBy": [
      { "field": "quantity", "direction": "DESC" },
      { "field": "sku", "direction": "ASC" }
    ],
    "pagination": { "first": {{pageSize}} }
  }
}

query ListingWithItemDetail($input: ListingInput!) {
  listing(input: $input) {
    rows {
      accountId sku listingId asin itemName itemDescription price quantity
      status fulfillmentChannel
      itemDetail {
        sellerId description featureBulletCount updatedDate etlLoadedAt
      }
    }
    totals { quantity pendingQuantity }
    pageInfo { hasNextPage endCursor }
    queryInfo { layer sourceAsset returnedRows bytesProcessed }
  }
}

{
  "input": {
    "accountIds": ["{{accountId}}"],
    "pagination": { "first": {{pageSize}} }
  }
}

query ListingPage2($input: ListingInput!) {
  listing(input: $input) {
    rows { accountId sku listingId quantity }
    pageInfo { hasNextPage hasPreviousPage startCursor endCursor }
    queryInfo { returnedRows bytesProcessed }
  }
}

{
  "input": {
    "accountIds": ["{{accountId}}"],
    "pagination": {
      "first": {{pageSize}},
      "after": "{{pageCursor}}"
    }
  }
}